.. _envoy_v3_api_file_envoy/extensions/access_loggers/file/v3/file.proto: File access log =============== .. _extension_envoy.access_loggers.file: This extension may be referenced by the qualified name *envoy.access_loggers.file* .. note:: This extension is intended to be robust against untrusted downstream traffic. It assumes that the upstream is trusted. .. _envoy_v3_api_msg_extensions.access_loggers.file.v3.FileAccessLog: extensions.access_loggers.file.v3.FileAccessLog ----------------------------------------------- `[extensions.access_loggers.file.v3.FileAccessLog proto] `_ Custom configuration for an :ref:`AccessLog ` that writes log entries directly to a file. Configures the built-in *envoy.access_loggers.file* AccessLog. .. code-block:: json { "path": "...", "format": "...", "json_format": "{...}", "typed_json_format": "{...}", "log_format": "{...}" } .. _envoy_v3_api_field_extensions.access_loggers.file.v3.FileAccessLog.path: path (`string `_, *REQUIRED*) A path to a local file to which to write the access log entries. .. _envoy_v3_api_field_extensions.access_loggers.file.v3.FileAccessLog.format: format (`string `_) Access log :ref:`format string`. Envoy supports :ref:`custom access log formats ` as well as a :ref:`default format `. This field is deprecated. Please use :ref:`log_format `. Only one of :ref:`format `, :ref:`json_format `, :ref:`typed_json_format `, :ref:`log_format ` may be set. .. _envoy_v3_api_field_extensions.access_loggers.file.v3.FileAccessLog.json_format: json_format (`Struct `_) Access log :ref:`format dictionary`. All values are rendered as strings. This field is deprecated. Please use :ref:`log_format `. Only one of :ref:`format `, :ref:`json_format `, :ref:`typed_json_format `, :ref:`log_format ` may be set. .. _envoy_v3_api_field_extensions.access_loggers.file.v3.FileAccessLog.typed_json_format: typed_json_format (`Struct `_) Access log :ref:`format dictionary`. 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. This field is deprecated. Please use :ref:`log_format `. Only one of :ref:`format `, :ref:`json_format `, :ref:`typed_json_format `, :ref:`log_format ` may be set. .. _envoy_v3_api_field_extensions.access_loggers.file.v3.FileAccessLog.log_format: log_format (:ref:`config.core.v3.SubstitutionFormatString `) Configuration to form access log data and format. If not specified, use :ref:`default format `. Only one of :ref:`format `, :ref:`json_format `, :ref:`typed_json_format `, :ref:`log_format ` may be set.