package envoy.extensions.access_loggers.grpc.v3

Get desktop application:
View/edit binary Protocol Buffers messages

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

Used in: HttpGrpcAccessLogConfig, TcpGrpcAccessLogConfig, open_telemetry.v3.OpenTelemetryAccessLogConfig

• string log_name = 1

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

• optional config.core.v3.GrpcService grpc_service = 2

  The gRPC service for the access log service.

• config.core.v3.ApiVersion transport_api_version = 6

  API version for access logs service transport protocol. This describes the access logs service gRPC endpoint and version of messages used on the wire.

• 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_v3_api_field_data.accesslog.v3.AccessLogCommon.filter_state_objects>`. Logger will call ``FilterState::Object::serializeAsProto`` to serialize the filter state object.

• optional config.core.v3.RetryPolicy grpc_stream_retry_policy = 7

  Sets the retry policy when the establishment of a gRPC stream fails. If the stream succeeds at least once in establishing itself, no retry will be performed no matter what gRPC status is received. Note that only :ref:`num_retries <envoy_v3_api_field_config.core.v3.RetryPolicy.num_retries>` will be used in this configuration. This feature is used only when you are using :ref:`Envoy gRPC client <envoy_v3_api_field_config.core.v3.GrpcService.envoy_grpc>`.

• repeated type.tracing.v3.CustomTag custom_tags = 8

  A list of custom tags with unique tag name to create tags for the logs.

Configuration for the built-in ``envoy.access_loggers.http_grpc`` :ref:`AccessLog <envoy_v3_api_msg_config.accesslog.v3.AccessLog>`. This configuration will populate :ref:`StreamAccessLogsMessage.http_logs <envoy_v3_api_field_service.accesslog.v3.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_v3_api_field_data.accesslog.v3.HTTPRequestProperties.request_headers>`.

• repeated string additional_response_headers_to_log = 3

  Additional response headers to log in :ref:`HTTPResponseProperties.response_headers <envoy_v3_api_field_data.accesslog.v3.HTTPResponseProperties.response_headers>`.

• repeated string additional_response_trailers_to_log = 4

  Additional response trailers to log in :ref:`HTTPResponseProperties.response_trailers <envoy_v3_api_field_data.accesslog.v3.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