package envoy.config.accesslog.v2

Get desktop application:
View/edit binary Protocol Buffers messages

Common configuration for gRPC access logs. [#next-free-field: 6]

Used in: HttpGrpcAccessLogConfig, TcpGrpcAccessLogConfig

• string log_name = 1

  The friendly name of the access log to be returned in :ref:`StreamAccessLogsMessage.Identifier <envoy_api_msg_service.accesslog.v2.StreamAccessLogsMessage.Identifier>`. This allows the access log server to differentiate between different access logs coming from the same Envoy.

• optional api.v2.core.GrpcService grpc_service = 2

  The gRPC service for the access log service.

• optional google.protobuf.Duration buffer_flush_interval = 3

  Interval for flushing access logs to the gRPC stream. Logger will flush requests every time this interval is elapsed, or when batch size limit is hit, whichever comes first. Defaults to 1 second.

• optional google.protobuf.UInt32Value buffer_size_bytes = 4

  Soft size limit in bytes for access log entries buffer. Logger will buffer requests until this limit it hit, or every time flush interval is elapsed, whichever comes first. Setting it to zero effectively disables the batching. Defaults to 16384.

• repeated string filter_state_objects_to_log = 5

  Additional filter state objects to log in :ref:`filter_state_objects <envoy_api_field_data.accesslog.v2.AccessLogCommon.filter_state_objects>`. Logger will call `FilterState::Object::serializeAsProto` to serialize the filter state object.

Custom configuration for an :ref:`AccessLog <envoy_api_msg_config.filter.accesslog.v2.AccessLog>` that writes log entries directly to a file. Configures the built-in *envoy.access_loggers.file* AccessLog.

• string path = 1

  A path to a local file to which to write the access log entries.

• oneof access_log_format

  • string format = 2

    Access log :ref:`format string<config_access_log_format_strings>`. Envoy supports :ref:`custom access log formats <config_access_log_format>` as well as a :ref:`default format <config_access_log_default_format>`.

  • google.protobuf.Struct json_format = 3

    Access log :ref:`format dictionary<config_access_log_format_dictionaries>`. All values are rendered as strings.

  • google.protobuf.Struct typed_json_format = 4

    Access log :ref:`format dictionary<config_access_log_format_dictionaries>`. Values are rendered as strings, numbers, or boolean values as appropriate. Nested JSON objects may be produced by some command operators (e.g.FILTER_STATE or DYNAMIC_METADATA). See the documentation for a specific command operator for details.

Configuration for the built-in *envoy.access_loggers.http_grpc* :ref:`AccessLog <envoy_api_msg_config.filter.accesslog.v2.AccessLog>`. This configuration will populate :ref:`StreamAccessLogsMessage.http_logs <envoy_api_field_service.accesslog.v2.StreamAccessLogsMessage.http_logs>`. [#extension: envoy.access_loggers.http_grpc]

• optional CommonGrpcAccessLogConfig common_config = 1

• repeated string additional_request_headers_to_log = 2

  Additional request headers to log in :ref:`HTTPRequestProperties.request_headers <envoy_api_field_data.accesslog.v2.HTTPRequestProperties.request_headers>`.

• repeated string additional_response_headers_to_log = 3

  Additional response headers to log in :ref:`HTTPResponseProperties.response_headers <envoy_api_field_data.accesslog.v2.HTTPResponseProperties.response_headers>`.

• repeated string additional_response_trailers_to_log = 4

  Additional response trailers to log in :ref:`HTTPResponseProperties.response_trailers <envoy_api_field_data.accesslog.v2.HTTPResponseProperties.response_trailers>`.

Configuration for the built-in *envoy.access_loggers.tcp_grpc* type. This configuration will populate *StreamAccessLogsMessage.tcp_logs*. [#extension: envoy.access_loggers.tcp_grpc]

• optional CommonGrpcAccessLogConfig common_config = 1