package envoy.config.accesslog.v3

Get desktop application:
View/edit binary Protocol Buffers messages

Used in: bootstrap.v3.Admin, listener.v3.Listener, extensions.filters.http.router.v3.Router, extensions.filters.network.generic_proxy.v3.GenericProxy, extensions.filters.network.http_connection_manager.v3.HttpConnectionManager, extensions.filters.network.tcp_proxy.v3.TcpProxy, extensions.filters.network.thrift_proxy.v3.ThriftProxy, extensions.filters.udp.udp_proxy.v3.UdpProxyConfig

• string name = 1

  The name of the access log extension configuration.

• optional AccessLogFilter filter = 2

  Filter which is used to determine if the access log needs to be written.

• oneof config_type

  Custom configuration that must be set according to the access logger extension being instantiated. [#extension-category: envoy.access_loggers]

  • google.protobuf.Any typed_config = 4

[#next-free-field: 14]

Used in: AccessLog, AndFilter, OrFilter, extensions.filters.network.http_connection_manager.v3.ResponseMapper

• oneof filter_specifier

  • StatusCodeFilter status_code_filter = 1

    Status code filter.

  • DurationFilter duration_filter = 2

    Duration filter.

  • NotHealthCheckFilter not_health_check_filter = 3

    Not health check filter.

  • TraceableFilter traceable_filter = 4

    Traceable filter.

  • RuntimeFilter runtime_filter = 5

    Runtime filter.

  • AndFilter and_filter = 6

    And filter.

  • OrFilter or_filter = 7

    Or filter.

  • HeaderFilter header_filter = 8

    Header filter.

  • ResponseFlagFilter response_flag_filter = 9

    Response flag filter.

  • GrpcStatusFilter grpc_status_filter = 10

    gRPC status filter.

  • ExtensionFilter extension_filter = 11

    Extension filter. [#extension-category: envoy.access_loggers.extension_filters]

  • MetadataFilter metadata_filter = 12

    Metadata Filter

  • LogTypeFilter log_type_filter = 13

    Log Type Filter

Performs a logical “and” operation on the result of each filter in filters. Filters are evaluated sequentially and if one of them returns false, the filter returns false immediately.

Used in: AccessLogFilter

• repeated AccessLogFilter filters = 1

Filter on an integer comparison.

Used in: DurationFilter, StatusCodeFilter

• ComparisonFilter.Op op = 1

  Comparison operator.

• optional core.v3.RuntimeUInt32 value = 2

  Value to compare against.

Used in: ComparisonFilter

• EQ = 0

  =

• GE = 1

  >=

• LE = 2

  <=

Filters based on the duration of the request or stream, in milliseconds. For end of stream access logs, the total duration of the stream will be used. For :ref:`periodic access logs<arch_overview_access_log_periodic>`, the duration of the stream at the time of log recording will be used.

Used in: AccessLogFilter

• optional ComparisonFilter comparison = 1

  Comparison.

Extension filter is statically registered at runtime.

Used in: AccessLogFilter

• string name = 1

  The name of the filter implementation to instantiate. The name must match a statically registered filter.

• oneof config_type

  Custom configuration that depends on the filter being instantiated.

  • google.protobuf.Any typed_config = 3

Filters gRPC requests based on their response status. If a gRPC status is not provided, the filter will infer the status from the HTTP status code.

Used in: AccessLogFilter

• repeated GrpcStatusFilter.Status statuses = 1

  Logs only responses that have any one of the gRPC statuses in this field.

• bool exclude = 2

  If included and set to true, the filter will instead block all responses with a gRPC status or inferred gRPC status enumerated in statuses, and allow all other responses.

Used in: GrpcStatusFilter

• OK = 0

• CANCELED = 1

• UNKNOWN = 2

• INVALID_ARGUMENT = 3

• DEADLINE_EXCEEDED = 4

• NOT_FOUND = 5

• ALREADY_EXISTS = 6

• PERMISSION_DENIED = 7

• RESOURCE_EXHAUSTED = 8

• FAILED_PRECONDITION = 9

• ABORTED = 10

• OUT_OF_RANGE = 11

• UNIMPLEMENTED = 12

• INTERNAL = 13

• UNAVAILABLE = 14

• DATA_LOSS = 15

• UNAUTHENTICATED = 16

Filters requests based on the presence or value of a request header.

Used in: AccessLogFilter

• optional route.v3.HeaderMatcher header = 1

  Only requests with a header which matches the specified HeaderMatcher will pass the filter check.

Filters based on access log type.

Used in: AccessLogFilter

• repeated data.accesslog.v3.AccessLogType types = 1

  Logs only records which their type is one of the types defined in this field.

• bool exclude = 2

  If this field is set to true, the filter will instead block all records with a access log type in types field, and allow all other records.

Filters based on matching dynamic metadata. If the matcher path and key correspond to an existing key in dynamic metadata, the request is logged only if the matcher value is equal to the metadata value. If the matcher path and key *do not* correspond to an existing key in dynamic metadata, the request is logged only if match_if_key_not_found is "true" or unset.

Used in: AccessLogFilter

• optional type.matcher.v3.MetadataMatcher matcher = 1

  Matcher to check metadata for specified value. For example, to match on the access_log_hint metadata, set the filter to "envoy.common" and the path to "access_log_hint", and the value to "true".

• optional google.protobuf.BoolValue match_if_key_not_found = 2

  Default result if the key does not exist in dynamic metadata: if unset or true, then log; if false, then don't log.

Filters for requests that are not health check requests. A health check request is marked by the health check filter.

Used in: AccessLogFilter

(message has no fields)

Performs a logical “or” operation on the result of each individual filter. Filters are evaluated sequentially and if one of them returns true, the filter returns true immediately.

Used in: AccessLogFilter

• repeated AccessLogFilter filters = 2

Filters requests that received responses with an Envoy response flag set. A list of the response flags can be found in the access log formatter :ref:`documentation<config_access_log_format_response_flags>`.

Used in: AccessLogFilter

• repeated string flags = 1

  Only responses with the any of the flags listed in this field will be logged. This field is optional. If it is not specified, then any response flag will pass the filter check.

Filters requests based on runtime-configurable sampling rates.

Used in: AccessLogFilter

• string runtime_key = 1

  Specifies a key used to look up a custom sampling rate from the runtime configuration. If a value is found for this key, it will override the default sampling rate specified in ``percent_sampled``.

• optional type.v3.FractionalPercent percent_sampled = 2

  Defines the default sampling percentage when no runtime override is present. If not specified, the default is **0%** (with a denominator of 100).

• bool use_independent_randomness = 3

  Controls how sampling decisions are made. - Default behavior (``false``): * Uses the :ref:`x-request-id<config_http_conn_man_headers_x-request-id>` as a consistent sampling pivot. * When :ref:`x-request-id<config_http_conn_man_headers_x-request-id>` is present, sampling will be consistent across multiple hosts based on both the ``runtime_key`` and :ref:`x-request-id<config_http_conn_man_headers_x-request-id>`. * Useful for tracking related requests across a distributed system. - When set to ``true`` or :ref:`x-request-id<config_http_conn_man_headers_x-request-id>` is missing: * Sampling decisions are made randomly based only on the ``runtime_key``. * Useful in complex filter configurations (like nested :ref:`AndFilter<envoy_v3_api_msg_config.accesslog.v3.AndFilter>`/ :ref:`OrFilter<envoy_v3_api_msg_config.accesslog.v3.OrFilter>` blocks) where independent probability calculations are desired. * Can be used to implement logging kill switches with predictable probability distributions.

Filters on HTTP response/status code.

Used in: AccessLogFilter

• optional ComparisonFilter comparison = 1

  Comparison.

Filters for requests that are traceable. See the tracing overview for more information on how a request becomes traceable.

Used in: AccessLogFilter

(message has no fields)