package envoy.data.accesslog.v2

Get desktop application:
View/edit binary Protocol Buffers messages

Defines fields that are shared by all Envoy access logs. [#next-free-field: 22]

Used in: HTTPAccessLogEntry, TCPAccessLogEntry

• double sample_rate = 1

  [#not-implemented-hide:] This field indicates the rate at which this log entry was sampled. Valid range is (0.0, 1.0].

• optional api.v2.core.Address downstream_remote_address = 2

  This field is the remote/origin address on which the request from the user was received. Note: This may not be the physical peer. E.g, if the remote address is inferred from for example the x-forwarder-for header, proxy protocol, etc.

• optional api.v2.core.Address downstream_local_address = 3

  This field is the local/destination address on which the request from the user was received.

• optional TLSProperties tls_properties = 4

  If the connection is secure,S this field will contain TLS properties.

• optional google.protobuf.Timestamp start_time = 5

  The time that Envoy started servicing this request. This is effectively the time that the first downstream byte is received.

• optional google.protobuf.Duration time_to_last_rx_byte = 6

  Interval between the first downstream byte received and the last downstream byte received (i.e. time it takes to receive a request).

• optional google.protobuf.Duration time_to_first_upstream_tx_byte = 7

  Interval between the first downstream byte received and the first upstream byte sent. There may by considerable delta between *time_to_last_rx_byte* and this value due to filters. Additionally, the same caveats apply as documented in *time_to_last_downstream_tx_byte* about not accounting for kernel socket buffer time, etc.

• optional google.protobuf.Duration time_to_last_upstream_tx_byte = 8

  Interval between the first downstream byte received and the last upstream byte sent. There may by considerable delta between *time_to_last_rx_byte* and this value due to filters. Additionally, the same caveats apply as documented in *time_to_last_downstream_tx_byte* about not accounting for kernel socket buffer time, etc.

• optional google.protobuf.Duration time_to_first_upstream_rx_byte = 9

  Interval between the first downstream byte received and the first upstream byte received (i.e. time it takes to start receiving a response).

• optional google.protobuf.Duration time_to_last_upstream_rx_byte = 10

  Interval between the first downstream byte received and the last upstream byte received (i.e. time it takes to receive a complete response).

• optional google.protobuf.Duration time_to_first_downstream_tx_byte = 11

  Interval between the first downstream byte received and the first downstream byte sent. There may be a considerable delta between the *time_to_first_upstream_rx_byte* and this field due to filters. Additionally, the same caveats apply as documented in *time_to_last_downstream_tx_byte* about not accounting for kernel socket buffer time, etc.

• optional google.protobuf.Duration time_to_last_downstream_tx_byte = 12

  Interval between the first downstream byte received and the last downstream byte sent. Depending on protocol, buffering, windowing, filters, etc. there may be a considerable delta between *time_to_last_upstream_rx_byte* and this field. Note also that this is an approximate time. In the current implementation it does not include kernel socket buffer time. In the current implementation it also does not include send window buffering inside the HTTP/2 codec. In the future it is likely that work will be done to make this duration more accurate.

• optional api.v2.core.Address upstream_remote_address = 13

  The upstream remote/destination address that handles this exchange. This does not include retries.

• optional api.v2.core.Address upstream_local_address = 14

  The upstream local/origin address that handles this exchange. This does not include retries.

• string upstream_cluster = 15

  The upstream cluster that *upstream_remote_address* belongs to.

• optional ResponseFlags response_flags = 16

  Flags indicating occurrences during request/response processing.

• optional api.v2.core.Metadata metadata = 17

  All metadata encountered during request processing, including endpoint selection. This can be used to associate IDs attached to the various configurations used to process this request with the access log entry. For example, a route created from a higher level forwarding rule with some ID can place that ID in this field and cross reference later. It can also be used to determine if a canary endpoint was used or not.

• string upstream_transport_failure_reason = 18

  If upstream connection failed due to transport socket (e.g. TLS handshake), provides the failure reason from the transport socket. The format of this field depends on the configured upstream transport socket. Common TLS failures are in :ref:`TLS trouble shooting <arch_overview_ssl_trouble_shooting>`.

• string route_name = 19

  The name of the route

• optional api.v2.core.Address downstream_direct_remote_address = 20

  This field is the downstream direct remote address on which the request from the user was received. Note: This is always the physical peer, even if the remote address is inferred from for example the x-forwarder-for header, proxy protocol, etc.

• map<string, google.protobuf.Any> filter_state_objects = 21

  Map of filter state in stream info that have been configured to be logged. If the filter state serialized to any message other than `google.protobuf.Any` it will be packed into `google.protobuf.Any`.

Defines fields for a connection

Used in: TCPAccessLogEntry

• uint64 received_bytes = 1

  Number of bytes received from downstream.

• uint64 sent_bytes = 2

  Number of bytes sent to downstream.

Used in: service.accesslog.v2.StreamAccessLogsMessage.HTTPAccessLogEntries

• optional AccessLogCommon common_properties = 1

  Common properties shared by all Envoy access logs.

• HTTPAccessLogEntry.HTTPVersion protocol_version = 2

• optional HTTPRequestProperties request = 3

  Description of the incoming HTTP request.

• optional HTTPResponseProperties response = 4

  Description of the outgoing HTTP response.

HTTP version

Used in: HTTPAccessLogEntry

• PROTOCOL_UNSPECIFIED = 0

• HTTP10 = 1

• HTTP11 = 2

• HTTP2 = 3

• HTTP3 = 4

[#next-free-field: 14]

Used in: HTTPAccessLogEntry

• api.v2.core.RequestMethod request_method = 1

  The request method (RFC 7231/2616).

• string scheme = 2

  The scheme portion of the incoming request URI.

• string authority = 3

  HTTP/2 ``:authority`` or HTTP/1.1 ``Host`` header value.

• optional google.protobuf.UInt32Value port = 4

  The port of the incoming request URI (unused currently, as port is composed onto authority).

• string path = 5

  The path portion from the incoming request URI.

• string user_agent = 6

  Value of the ``User-Agent`` request header.

• string referer = 7

  Value of the ``Referer`` request header.

• string forwarded_for = 8

  Value of the ``X-Forwarded-For`` request header.

• string request_id = 9

  Value of the ``X-Request-Id`` request header This header is used by Envoy to uniquely identify a request. It will be generated for all external requests and internal requests that do not already have a request ID.

• string original_path = 10

  Value of the ``X-Envoy-Original-Path`` request header.

• uint64 request_headers_bytes = 11

  Size of the HTTP request headers in bytes. This value is captured from the OSI layer 7 perspective, i.e. it does not include overhead from framing or encoding at other networking layers.

• uint64 request_body_bytes = 12

  Size of the HTTP request body in bytes. This value is captured from the OSI layer 7 perspective, i.e. it does not include overhead from framing or encoding at other networking layers.

• map<string, string> request_headers = 13

  Map of additional headers that have been configured to be logged.

[#next-free-field: 7]

Used in: HTTPAccessLogEntry

• optional google.protobuf.UInt32Value response_code = 1

  The HTTP response code returned by Envoy.

• uint64 response_headers_bytes = 2

  Size of the HTTP response headers in bytes. This value is captured from the OSI layer 7 perspective, i.e. it does not include overhead from framing or encoding at other networking layers.

• uint64 response_body_bytes = 3

  Size of the HTTP response body in bytes. This value is captured from the OSI layer 7 perspective, i.e. it does not include overhead from framing or encoding at other networking layers.

• map<string, string> response_headers = 4

  Map of additional headers configured to be logged.

• map<string, string> response_trailers = 5

  Map of trailers configured to be logged.

• string response_code_details = 6

  The HTTP response code details.

Flags indicating occurrences during request/response processing. [#next-free-field: 20]

Used in: AccessLogCommon

• bool failed_local_healthcheck = 1

  Indicates local server healthcheck failed.

• bool no_healthy_upstream = 2

  Indicates there was no healthy upstream.

• bool upstream_request_timeout = 3

  Indicates an there was an upstream request timeout.

• bool local_reset = 4

  Indicates local codec level reset was sent on the stream.

• bool upstream_remote_reset = 5

  Indicates remote codec level reset was received on the stream.

• bool upstream_connection_failure = 6

  Indicates there was a local reset by a connection pool due to an initial connection failure.

• bool upstream_connection_termination = 7

  Indicates the stream was reset due to an upstream connection termination.

• bool upstream_overflow = 8

  Indicates the stream was reset because of a resource overflow.

• bool no_route_found = 9

  Indicates no route was found for the request.

• bool delay_injected = 10

  Indicates that the request was delayed before proxying.

• bool fault_injected = 11

  Indicates that the request was aborted with an injected error code.

• bool rate_limited = 12

  Indicates that the request was rate-limited locally.

• optional ResponseFlags.Unauthorized unauthorized_details = 13

  Indicates if the request was deemed unauthorized and the reason for it.

• bool rate_limit_service_error = 14

  Indicates that the request was rejected because there was an error in rate limit service.

• bool downstream_connection_termination = 15

  Indicates the stream was reset due to a downstream connection termination.

• bool upstream_retry_limit_exceeded = 16

  Indicates that the upstream retry limit was exceeded, resulting in a downstream error.

• bool stream_idle_timeout = 17

  Indicates that the stream idle timeout was hit, resulting in a downstream 408.

• bool invalid_envoy_request_headers = 18

  Indicates that the request was rejected because an envoy request header failed strict validation.

• bool downstream_protocol_error = 19

  Indicates there was an HTTP protocol error on the downstream request.

Used in: ResponseFlags

• Unauthorized.Reason reason = 1

Reasons why the request was unauthorized

Used in: Unauthorized

• REASON_UNSPECIFIED = 0

• EXTERNAL_SERVICE = 1

  The request was denied by the external authorization service.

Used in: service.accesslog.v2.StreamAccessLogsMessage.TCPAccessLogEntries

• optional AccessLogCommon common_properties = 1

  Common properties shared by all Envoy access logs.

• optional ConnectionProperties connection_properties = 2

  Properties of the TCP connection.

Properties of a negotiated TLS connection. [#next-free-field: 7]

Used in: AccessLogCommon

• TLSProperties.TLSVersion tls_version = 1

  Version of TLS that was negotiated.

• optional google.protobuf.UInt32Value tls_cipher_suite = 2

  TLS cipher suite negotiated during handshake. The value is a four-digit hex code defined by the IANA TLS Cipher Suite Registry (e.g. ``009C`` for ``TLS_RSA_WITH_AES_128_GCM_SHA256``). Here it is expressed as an integer.

• string tls_sni_hostname = 3

  SNI hostname from handshake.

• optional TLSProperties.CertificateProperties local_certificate_properties = 4

  Properties of the local certificate used to negotiate TLS.

• optional TLSProperties.CertificateProperties peer_certificate_properties = 5

  Properties of the peer certificate used to negotiate TLS.

• string tls_session_id = 6

  The TLS session ID.

Used in: TLSProperties

• repeated CertificateProperties.SubjectAltName subject_alt_name = 1

  SANs present in the certificate.

• string subject = 2

  The subject field of the certificate.

Used in: CertificateProperties

• oneof san

  • string uri = 1

  • string dns = 2

    [#not-implemented-hide:]

Used in: TLSProperties

• VERSION_UNSPECIFIED = 0

• TLSv1 = 1

• TLSv1_1 = 2

• TLSv1_2 = 3

• TLSv1_3 = 4