Struct AuditEvent 

pub struct AuditEvent {
    pub at_ms: u64,
    pub kind: String,
    pub identity: Option<Identity>,
    pub client: Option<String>,
    pub route: Option<String>,
    pub command: Option<String>,
    pub session_id: Option<u64>,
    pub exit_code: Option<i32>,
    pub timed_out: Option<bool>,
    pub duration_ms: Option<u64>,
    pub status: Option<u16>,
    pub reason: Option<String>,
}

One recorded event.

Fields

at_ms: u64

Unix milliseconds. A number rather than a formatted string so the log stays sortable without a date parser.

kind: String

What happened: execute, denied, …

identity: Option<Identity>

Caller identity, when the request was authenticated.

client: Option<String>

Client address as the server saw it.

route: Option<String>

Request method and path, for correlating with access logs.

command: Option<String>

The command line, for execution events.

This is the substance of the trail — “someone called POST /execute” says almost nothing on its own. It also means a command that embeds a secret puts that secret in the log, which is the trade an audit trail makes.

session_id: Option<u64>

Session the command ran in, when it was not a one-shot.

exit_code: Option<i32>

Process exit code, when the command completed.

timed_out: Option<bool>

Whether the command hit its timeout.

duration_ms: Option<u64>

How long it took.

status: Option<u16>

HTTP status, for denial events.

reason: Option<String>

Why a request was refused (missing-token, invalid-token, …).

Implementations

impl AuditEvent

pub fn new(kind: impl Into<String>) -> Self

Start an event of the given kind, stamped now.

pub fn with_identity(self, identity: Option<Identity>) -> Self

Attach the caller’s identity.

pub fn with_client(self, client: impl Into<String>) -> Self

Attach the client address.

pub fn with_route(self, route: impl Into<String>) -> Self

Attach the request route.

pub fn with_command(self, command: impl Into<String>) -> Self

Attach the command line that ran.

pub fn with_session(self, session_id: u64) -> Self

Attach the session the command ran in.

pub fn with_outcome( self, exit_code: Option<i32>, timed_out: bool, duration_ms: u64, ) -> Self

Attach the outcome of an execution.

pub fn with_denial(self, status: u16, reason: impl Into<String>) -> Self

Attach a refusal.

Trait Implementations

impl Clone for AuditEvent

fn clone(&self) -> AuditEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AuditEvent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AuditEvent

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for AuditEvent

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for AuditEvent

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for AuditEvent