Struct sozu_command_lib::proto::command::ProtobufAccessLog

pub struct ProtobufAccessLog {

    pub message: Option<String>,
    pub request_id: Uint128,
    pub cluster_id: Option<String>,
    pub backend_id: Option<String>,
    pub session_address: Option<SocketAddress>,
    pub backend_address: Option<SocketAddress>,
    pub protocol: String,
    pub endpoint: ProtobufEndpoint,
    pub client_rtt: Option<u64>,
    pub server_rtt: Option<u64>,
    pub service_time: u64,
    pub bytes_in: u64,
    pub bytes_out: u64,
    pub user_agent: Option<String>,
    pub tags: BTreeMap<String, String>,
    pub tag: String,
    pub time: Uint128,
    pub request_time: Option<u64>,
    pub response_time: Option<u64>,
}

An access log, meant to be passed to another agent

Fields

message: Option<String>

error message if any

request_id: Uint128

LogContext = request_id + cluster_id + backend_id

cluster_id: Option<String>

id of the cluster (set of frontend, backend, routing rules)

backend_id: Option<String>

id of the backend (the server to which the traffic is redirected)

session_address: Option<SocketAddress>

ip and port of the client

backend_address: Option<SocketAddress>

socket address of the backend server

protocol: String

the protocol, with SSL/TLS version, for instance “HTTPS-TLS1.1”

endpoint: ProtobufEndpoint

TCP or HTTP endpoint (method, path, context…)

client_rtt: Option<u64>

round trip time for the client (microseconds)

server_rtt: Option<u64>

round trip time for the backend (microseconds)

service_time: u64

time spent on a session (microseconds)

bytes_in: u64

number of bytes received from the client

bytes_out: u64

number of bytes written to the client

user_agent: Option<String>

value of the User-Agent header, if any

tags: BTreeMap<String, String>

custom tags as key-values, for instance owner_id: MyOrganisation

tag: String

short description of which process sends the log, for instance: “WRK-02”

time: Uint128

POSIX timestamp, nanoseconds

request_time: Option<u64>

Entire time between first byte received and last byte of the response. If a request ends abruptly before the last byte is transmitted, the request_time produced is the time elapsed since the first byte received.

response_time: Option<u64>

time for the backend to respond (microseconds)

Implementations

impl ProtobufAccessLog

pub fn message(&self) -> &str

Returns the value of message, or the default value if message is unset.

pub fn cluster_id(&self) -> &str

Returns the value of cluster_id, or the default value if cluster_id is unset.

pub fn backend_id(&self) -> &str

Returns the value of backend_id, or the default value if backend_id is unset.

pub fn client_rtt(&self) -> u64

Returns the value of client_rtt, or the default value if client_rtt is unset.

pub fn server_rtt(&self) -> u64

Returns the value of server_rtt, or the default value if server_rtt is unset.

pub fn user_agent(&self) -> &str

Returns the value of user_agent, or the default value if user_agent is unset.

pub fn request_time(&self) -> u64

Returns the value of request_time, or the default value if request_time is unset.

pub fn response_time(&self) -> u64

Returns the value of response_time, or the default value if response_time is unset.

Trait Implementations

impl Clone for ProtobufAccessLog

fn clone(&self) -> ProtobufAccessLog

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ProtobufAccessLog

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

Formats the value using the given formatter.

impl Default for ProtobufAccessLog

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ProtobufAccessLog

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for ProtobufAccessLog

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 Message for ProtobufAccessLog

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl Ord for ProtobufAccessLog

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for ProtobufAccessLog

fn eq(&self, other: &ProtobufAccessLog) -> 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 for ProtobufAccessLog

fn partial_cmp(&self, other: &ProtobufAccessLog) -> 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 ProtobufAccessLog

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for ProtobufAccessLog

impl StructuralPartialEq for ProtobufAccessLog