.. _envoy_api_file_envoy/config/accesslog/v2/als.proto: gRPC Access Log Service (ALS) ============================= .. _envoy_api_msg_config.accesslog.v2.HttpGrpcAccessLogConfig: config.accesslog.v2.HttpGrpcAccessLogConfig ------------------------------------------- `[config.accesslog.v2.HttpGrpcAccessLogConfig proto] `_ Configuration for the built-in *envoy.http_grpc_access_log* :ref:`AccessLog `. This configuration will populate :ref:`StreamAccessLogsMessage.http_logs `. .. _extension_envoy.access_loggers.http_grpc: This extension may be referenced by the qualified name *envoy.access_loggers.http_grpc* .. note:: This extension is intended to be robust against untrusted downstream traffic. It assumes that the upstream is trusted. .. code-block:: json { "common_config": "{...}", "additional_request_headers_to_log": [], "additional_response_headers_to_log": [], "additional_response_trailers_to_log": [] } .. _envoy_api_field_config.accesslog.v2.HttpGrpcAccessLogConfig.common_config: common_config (:ref:`config.accesslog.v2.CommonGrpcAccessLogConfig `, *REQUIRED*) .. _envoy_api_field_config.accesslog.v2.HttpGrpcAccessLogConfig.additional_request_headers_to_log: additional_request_headers_to_log (`string `_) Additional request headers to log in :ref:`HTTPRequestProperties.request_headers `. .. _envoy_api_field_config.accesslog.v2.HttpGrpcAccessLogConfig.additional_response_headers_to_log: additional_response_headers_to_log (`string `_) Additional response headers to log in :ref:`HTTPResponseProperties.response_headers `. .. _envoy_api_field_config.accesslog.v2.HttpGrpcAccessLogConfig.additional_response_trailers_to_log: additional_response_trailers_to_log (`string `_) Additional response trailers to log in :ref:`HTTPResponseProperties.response_trailers `. .. _envoy_api_msg_config.accesslog.v2.TcpGrpcAccessLogConfig: config.accesslog.v2.TcpGrpcAccessLogConfig ------------------------------------------ `[config.accesslog.v2.TcpGrpcAccessLogConfig proto] `_ Configuration for the built-in *envoy.tcp_grpc_access_log* type. This configuration will populate *StreamAccessLogsMessage.tcp_logs*. .. _extension_envoy.access_loggers.tcp_grpc: This extension may be referenced by the qualified name *envoy.access_loggers.tcp_grpc* .. note:: This extension is intended to be robust against untrusted downstream traffic. It assumes that the upstream is trusted. .. code-block:: json { "common_config": "{...}" } .. _envoy_api_field_config.accesslog.v2.TcpGrpcAccessLogConfig.common_config: common_config (:ref:`config.accesslog.v2.CommonGrpcAccessLogConfig `, *REQUIRED*) .. _envoy_api_msg_config.accesslog.v2.CommonGrpcAccessLogConfig: config.accesslog.v2.CommonGrpcAccessLogConfig --------------------------------------------- `[config.accesslog.v2.CommonGrpcAccessLogConfig proto] `_ Common configuration for gRPC access logs. .. code-block:: json { "log_name": "...", "grpc_service": "{...}", "buffer_flush_interval": "{...}", "buffer_size_bytes": "{...}", "filter_state_objects_to_log": [] } .. _envoy_api_field_config.accesslog.v2.CommonGrpcAccessLogConfig.log_name: log_name (`string `_, *REQUIRED*) The friendly name of the access log to be returned in :ref:`StreamAccessLogsMessage.Identifier `. This allows the access log server to differentiate between different access logs coming from the same Envoy. .. _envoy_api_field_config.accesslog.v2.CommonGrpcAccessLogConfig.grpc_service: grpc_service (:ref:`core.GrpcService `, *REQUIRED*) The gRPC service for the access log service. .. _envoy_api_field_config.accesslog.v2.CommonGrpcAccessLogConfig.buffer_flush_interval: buffer_flush_interval (`Duration `_) 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. .. _envoy_api_field_config.accesslog.v2.CommonGrpcAccessLogConfig.buffer_size_bytes: buffer_size_bytes (`UInt32Value `_) 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. .. _envoy_api_field_config.accesslog.v2.CommonGrpcAccessLogConfig.filter_state_objects_to_log: filter_state_objects_to_log (`string `_) Additional filter state objects to log in :ref:`filter_state_objects `. Logger will call `FilterState::Object::serializeAsProto` to serialize the filter state object.