package envoy.config.filter.accesslog.v2

Get desktop application:
View/edit binary Protocol Buffers messages

Used in: api.v2.Listener, http.router.v2.Router, network.http_connection_manager.v2.HttpConnectionManager, network.tcp_proxy.v2.TcpProxy

• string name = 1

  The name of the access log implementation to instantiate. The name must match a statically registered access log. Current built-in loggers include: #. "envoy.access_loggers.file" #. "envoy.access_loggers.http_grpc" #. "envoy.access_loggers.tcp_grpc"

• optional AccessLogFilter filter = 2

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

• oneof config_type

  Custom configuration that depends on the access log being instantiated. Built-in configurations include: #. "envoy.access_loggers.file": :ref:`FileAccessLog <envoy_api_msg_config.accesslog.v2.FileAccessLog>` #. "envoy.access_loggers.http_grpc": :ref:`HttpGrpcAccessLogConfig <envoy_api_msg_config.accesslog.v2.HttpGrpcAccessLogConfig>` #. "envoy.access_loggers.tcp_grpc": :ref:`TcpGrpcAccessLogConfig <envoy_api_msg_config.accesslog.v2.TcpGrpcAccessLogConfig>`

  • google.protobuf.Struct config = 3

  • google.protobuf.Any typed_config = 4

[#next-free-field: 12]

Used in: AccessLog, AndFilter, OrFilter

• 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.

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 api.v2.core.RuntimeUInt32 value = 2

  Value to compare against.

Used in: ComparisonFilter

• EQ = 0

  =

• GE = 1

  >=

• LE = 2

  <=

Filters on total request duration in milliseconds.

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.Struct config = 2

  • 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 api.v2.route.HeaderMatcher header = 1

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

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 for random sampling of requests.

Used in: AccessLogFilter

• string runtime_key = 1

  Runtime key to get an optional overridden numerator for use in the *percent_sampled* field. If found in runtime, this value will replace the default numerator.

• optional type.FractionalPercent percent_sampled = 2

  The default sampling percentage. If not specified, defaults to 0% with denominator of 100.

• bool use_independent_randomness = 3

  By default, sampling pivots on the header :ref:`x-request-id<config_http_conn_man_headers_x-request-id>` being present. If :ref:`x-request-id<config_http_conn_man_headers_x-request-id>` is present, the filter will consistently sample across multiple hosts based on the runtime key value and the value extracted from :ref:`x-request-id<config_http_conn_man_headers_x-request-id>`. If it is missing, or *use_independent_randomness* is set to true, the filter will randomly sample based on the runtime key value alone. *use_independent_randomness* can be used for logging kill switches within complex nested :ref:`AndFilter <envoy_api_msg_config.filter.accesslog.v2.AndFilter>` and :ref:`OrFilter <envoy_api_msg_config.filter.accesslog.v2.OrFilter>` blocks that are easier to reason about from a probability perspective (i.e., setting to true will cause the filter to behave like an independent random variable when composed within logical operator filters).

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)