.. _envoy_v3_api_file_envoy/extensions/access_loggers/grpc/v3/als.proto: gRPC Access Log Service (ALS) ============================= This documentation is for the Envoy v3 API. As of Envoy v1.18 the v2 API has been removed and is no longer supported. If you are upgrading from v2 API config you may wish to view the v2 API documentation: :ref:`config/accesslog/v2/als.proto ` .. _envoy_v3_api_msg_extensions.access_loggers.grpc.v3.HttpGrpcAccessLogConfig: extensions.access_loggers.grpc.v3.HttpGrpcAccessLogConfig --------------------------------------------------------- :repo:`[extensions.access_loggers.grpc.v3.HttpGrpcAccessLogConfig proto] ` Configuration for the built-in *envoy.access_loggers.http_grpc* :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. .. tip:: This extension extends and can be used with the following extension category: - :ref:`envoy.access_loggers ` .. code-block:: json { "common_config": "{...}", "additional_request_headers_to_log": [], "additional_response_headers_to_log": [], "additional_response_trailers_to_log": [] } .. _envoy_v3_api_field_extensions.access_loggers.grpc.v3.HttpGrpcAccessLogConfig.common_config: common_config (:ref:`extensions.access_loggers.grpc.v3.CommonGrpcAccessLogConfig `, *REQUIRED*) .. _envoy_v3_api_field_extensions.access_loggers.grpc.v3.HttpGrpcAccessLogConfig.additional_request_headers_to_log: additional_request_headers_to_log (**repeated** `string `_) Additional request headers to log in :ref:`HTTPRequestProperties.request_headers `. .. _envoy_v3_api_field_extensions.access_loggers.grpc.v3.HttpGrpcAccessLogConfig.additional_response_headers_to_log: additional_response_headers_to_log (**repeated** `string `_) Additional response headers to log in :ref:`HTTPResponseProperties.response_headers `. .. _envoy_v3_api_field_extensions.access_loggers.grpc.v3.HttpGrpcAccessLogConfig.additional_response_trailers_to_log: additional_response_trailers_to_log (**repeated** `string `_) Additional response trailers to log in :ref:`HTTPResponseProperties.response_trailers `. .. _envoy_v3_api_msg_extensions.access_loggers.grpc.v3.TcpGrpcAccessLogConfig: extensions.access_loggers.grpc.v3.TcpGrpcAccessLogConfig -------------------------------------------------------- :repo:`[extensions.access_loggers.grpc.v3.TcpGrpcAccessLogConfig proto] ` Configuration for the built-in *envoy.access_loggers.tcp_grpc* 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. .. tip:: This extension extends and can be used with the following extension category: - :ref:`envoy.access_loggers ` .. code-block:: json { "common_config": "{...}" } .. _envoy_v3_api_field_extensions.access_loggers.grpc.v3.TcpGrpcAccessLogConfig.common_config: common_config (:ref:`extensions.access_loggers.grpc.v3.CommonGrpcAccessLogConfig `, *REQUIRED*) .. _envoy_v3_api_msg_extensions.access_loggers.grpc.v3.CommonGrpcAccessLogConfig: extensions.access_loggers.grpc.v3.CommonGrpcAccessLogConfig ----------------------------------------------------------- :repo:`[extensions.access_loggers.grpc.v3.CommonGrpcAccessLogConfig proto] ` Common configuration for gRPC access logs. .. code-block:: json { "log_name": "...", "grpc_service": "{...}", "transport_api_version": "...", "buffer_flush_interval": "{...}", "buffer_size_bytes": "{...}", "filter_state_objects_to_log": [] } .. _envoy_v3_api_field_extensions.access_loggers.grpc.v3.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_v3_api_field_extensions.access_loggers.grpc.v3.CommonGrpcAccessLogConfig.grpc_service: grpc_service (:ref:`config.core.v3.GrpcService `, *REQUIRED*) The gRPC service for the access log service. .. _envoy_v3_api_field_extensions.access_loggers.grpc.v3.CommonGrpcAccessLogConfig.transport_api_version: transport_api_version (:ref:`config.core.v3.ApiVersion `) API version for access logs service transport protocol. This describes the access logs service gRPC endpoint and version of messages used on the wire. .. _envoy_v3_api_field_extensions.access_loggers.grpc.v3.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_v3_api_field_extensions.access_loggers.grpc.v3.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_v3_api_field_extensions.access_loggers.grpc.v3.CommonGrpcAccessLogConfig.filter_state_objects_to_log: filter_state_objects_to_log (**repeated** `string `_) Additional filter state objects to log in :ref:`filter_state_objects `. Logger will call `FilterState::Object::serializeAsProto` to serialize the filter state object.