Struct witchcraft_server::logging::api::ServiceLogV1

pub struct ServiceLogV1 { /* private fields */ }

Definition of the service.1 format.

Implementations

impl ServiceLogV1

pub fn builder() -> BuilderStage0

Returns a new builder.

pub fn type_(&self) -> &str

“service.1”

pub fn level(&self) -> &LogLevel

The logger output level. One of {FATAL,ERROR,WARN,INFO,DEBUG,TRACE} based on log level coding guidelines

pub fn time(&self) -> DateTime<Utc>

RFC3339Nano UTC datetime string when the log event was emitted

pub fn origin(&self) -> Option<&str>

Class or file name. May include line number.

pub fn thread(&self) -> Option<&str>

Thread name

pub fn message(&self) -> &str

Log message. Palantir Java services using slf4j should not use slf4j placeholders ({}). Logs obtained from 3rd party libraries or services that use slf4j and contain slf4j placeholders will always produce unsafeParams with numeric indexes corresponding to the zero-indexed order of placeholders. Renderers should substitute numeric parameters from unsafeParams and may leave placeholders that do not match indexes as the original placeholder text.

pub fn safe(&self) -> Option<bool>

Describes the safety of this log event based on prior knowledge within the application which produced the message. This field should not be set to true without total confidence that it is correct. * empty: Considered unsafe unless the logging pipeline has special configuration for this origin. Eventually these will all be equivalent to false. * true: All safe components can be trusted. * false: Event is unsafe and cannot be exported.

pub fn params(&self) -> &BTreeMap<String, Any>

Known-safe parameters (redaction may be used to make params knowably safe, but is not required).

pub fn uid(&self) -> Option<&UserId>

User id (if available).

pub fn sid(&self) -> Option<&SessionId>

Session id (if available)

pub fn token_id(&self) -> Option<&TokenId>

API token id (if available)

pub fn trace_id(&self) -> Option<&TraceId>

Zipkin trace id (if available)

pub fn stacktrace(&self) -> Option<&str>

Language-specific stack trace. Content is knowably safe. Renderers should substitute named placeholders ({name}, for name as a key) with keyed value from unsafeParams and leave non-matching keys as the original placeholder text.

pub fn unsafe_params(&self) -> &BTreeMap<String, Any>

Unredacted parameters

pub fn tags(&self) -> &BTreeMap<String, String>

Additional dimensions that describe the instance of the log event

Trait Implementations

impl Clone for ServiceLogV1

fn clone(&self) -> ServiceLogV1

Returns a copy of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ServiceLogV1

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ServiceLogV1

fn deserialize<D>(d: D) -> Result<ServiceLogV1, D::Error>where
    D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<ServiceLogV1> for BuilderStage4

fn from(value: ServiceLogV1) -> Self

Converts to this type from the input type.

impl Hash for ServiceLogV1

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where
    H: Hasher,

Feeds a slice of this type into the given Hasher.

impl Ord for ServiceLogV1

fn cmp(&self, other: &ServiceLogV1) -> Ordering

This method returns an Ordering between self and other.

const fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

const fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

const fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<ServiceLogV1> for ServiceLogV1

fn eq(&self, other: &ServiceLogV1) -> bool

This method tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<ServiceLogV1> for ServiceLogV1

fn partial_cmp(&self, other: &ServiceLogV1) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

const fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

const fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

const fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

const fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for ServiceLogV1

fn serialize<S>(&self, s: S) -> Result<S::Ok, S::Error>where
    S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for ServiceLogV1

impl StructuralEq for ServiceLogV1

impl StructuralPartialEq for ServiceLogV1