Struct witchcraft_server::logging::api::AuditLogV3

pub struct AuditLogV3 { /* private fields */ }

Implementations

impl AuditLogV3

pub fn builder() -> BuilderStage0

Returns a new builder.

pub fn type_(&self) -> &str

“audit.3”

pub fn deployment(&self) -> &str

The deployment that produced this log. Not exposed to downstream consumers.

pub fn host(&self) -> &str

The host of the service that produced this log.

pub fn product(&self) -> &str

The name of the product that produced this log.

pub fn product_version(&self) -> &str

The version of the product that produced this log.

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

The stack that this log was generated on.

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

The service name that produced this log.

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

The environment that produced this log.

pub fn producer_type(&self) -> &AuditProducer

How this audit log was produced, eg. from a backend Server, frontend Client etc.

pub fn organizations(&self) -> &[Organization]

A list of organizations that have been attributed to this log. Attribution is typically based on the user that originated this log, and the resources that they targeted. Not exposed to downstream consumers.

pub fn event_id(&self) -> Uuid

Unique identifier for this audit log event.

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

The user agent of the user that originated this log.

pub fn categories(&self) -> &[String]

All audit categories produced by this audit event. Each audit categories produces a set of keys that will be distributed between the request and response params.

pub fn entities(&self) -> &[Any]

All contextualized entities present in the request and response params of this log. Note: Some resources cannot be contextualized, and will not be included in this list as a result.

pub fn users(&self) -> &[ContextualizedUser]

All contextualized users present in the request and response params of this log, including the top level UUID of this log.

pub fn origins(&self) -> &[String]

All addresses attached to the request. Contains information from unreliable sources such as the X-Forwarded-For header.

This value can be spoofed.

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

Origin of the network request. If a request goes through a proxy, this will contain the proxy’’s address.

This value is verified through the TCP stack.

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

The parameters known at method invocation time.

Note that all keys must be known to the audit library. Typically, entries in the request and response params will be dependent on the categories field defined above.

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

Information derived within a method, commonly parts of the return value.

Note that all keys must be known to the audit library. Typically, entries in the request and response params will be dependent on the categories field defined above.

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

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

User id (if available). This is the most downstream caller.

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 origin(&self) -> Option<&str>

Best-effort identifier of the originating machine, e.g. an IP address, a Kubernetes node identifier, or similar.

This value can be spoofed.

pub fn name(&self) -> &str

Name of the audit event, e.g. PUT_FILE

pub fn result(&self) -> &AuditResult

Indicates whether the request was successful or the type of failure, e.g. ERROR or UNAUTHORIZED

Trait Implementations

impl Clone for AuditLogV3

fn clone(&self) -> AuditLogV3

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AuditLogV3

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AuditLogV3

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

Deserialize this value from the given Serde deserializer.

impl From<AuditLogV3> for BuilderStage10

fn from(value: AuditLogV3) -> Self

Converts to this type from the input type.

impl Hash for AuditLogV3

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for AuditLogV3

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl PartialEq<AuditLogV3> for AuditLogV3

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

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

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<AuditLogV3> for AuditLogV3

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

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

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

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

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

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

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

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

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 AuditLogV3

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 AuditLogV3

impl StructuralEq for AuditLogV3

impl StructuralPartialEq for AuditLogV3