pub struct LoggingTranslator { /* private fields */ }Expand description
Logging configuration translator for matching the Datadog Agent’s logging behavior.
In the Datadog Agent, all processes generally follow the same logging configuration, paying attention to the same settings for determining log level, log format, and so on. They differ in some ways, such as determining what file to write to when logging to file is enabled. Remote agents follow the same pattern.
LoggingTranslator takes LoggingSettings and generates a Saluki-oriented [LoggingConfiguration] from it,
applying the remote agent’s own default log file and first-party log targets. This ensures that a remote agent obeys
all the logging configuration rules set by the Datadog Agent but logs to the right location for its own process.
Implementations§
Source§impl LoggingTranslator
impl LoggingTranslator
Sourcepub fn new(default_log_file: impl Into<PathBuf>) -> Self
pub fn new(default_log_file: impl Into<PathBuf>) -> Self
Creates a new LoggingTranslator that logs to default_log_file unless a log file is configured explicitly.
A plain log level applies to FIRST_PARTY_LOG_TARGETS. Add the remote agent’s own crates with
with_first_party_targets.
Sourcepub fn with_first_party_targets(self, targets: &[&'static str]) -> Self
pub fn with_first_party_targets(self, targets: &[&'static str]) -> Self
Adds the given log targets to the ones that a plain log level applies to.
Like the entries in FIRST_PARTY_LOG_TARGETS, each target is a prefix, so my_remote_agent also covers a
my_remote_agent_config crate.
Sourcepub fn translate(
&self,
settings: LoggingSettings,
) -> Result<LoggingConfiguration, GenericError>
pub fn translate( &self, settings: LoggingSettings, ) -> Result<LoggingConfiguration, GenericError>
Builds a [LoggingConfiguration] from the given settings, applying this remote agent’s rules.
§Errors
Returns an error if the configured log level is not a level name or a valid set of filter directives.
Sourcepub fn translate_log_levels<S>(
&self,
levels: S,
) -> impl Stream<Item = LogLevel> + Send + 'static
pub fn translate_log_levels<S>( &self, levels: S, ) -> impl Stream<Item = LogLevel> + Send + 'static
Translates each log level from levels into the form that
[DynamicLogLevelWorker][saluki_app::logging::DynamicLogLevelWorker] applies.
Each level is parsed the same way as LoggingSettings::level in translate, so a plain
level applies to the same first-party log targets as at startup. A level that can’t be parsed is logged and
skipped, which leaves the current log level in place.
Trait Implementations§
Source§impl Clone for LoggingTranslator
impl Clone for LoggingTranslator
Source§fn clone(&self) -> LoggingTranslator
fn clone(&self) -> LoggingTranslator
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreAuto Trait Implementations§
impl Freeze for LoggingTranslator
impl RefUnwindSafe for LoggingTranslator
impl Send for LoggingTranslator
impl Sync for LoggingTranslator
impl Unpin for LoggingTranslator
impl UnsafeUnpin for LoggingTranslator
impl UnwindSafe for LoggingTranslator
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoRequest<T> for T
impl<T> IntoRequest<T> for T
Source§fn into_request(self) -> Request<T>
fn into_request(self) -> Request<T>
T in a tonic::RequestSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);Source§impl<T> Pointable for T
impl<T> Pointable for T
Source§impl<T> Track for T
impl<T> Track for T
Source§fn track_resources(self, token: ResourceGroupToken) -> Tracked<Self>
fn track_resources(self, token: ResourceGroupToken) -> Tracked<Self>
Tracked wrapper. Read moreSource§fn in_current_resource_group(self) -> Tracked<Self>
fn in_current_resource_group(self) -> Tracked<Self>
Tracked wrapper. Read more