1syntax = "proto3";
2
3package envoy.extensions.access_loggers.file.v3;
4
5import "envoy/config/core/v3/substitution_format_string.proto";
6
7import "google/protobuf/struct.proto";
8
9import "udpa/annotations/status.proto";
10import "udpa/annotations/versioning.proto";
11import "validate/validate.proto";
12
13option java_package = "io.envoyproxy.envoy.extensions.access_loggers.file.v3";
14option java_outer_classname = "FileProto";
15option java_multiple_files = true;
16option (udpa.annotations.file_status).package_version_status = ACTIVE;
17
18// [#protodoc-title: File access log]
19// [#extension: envoy.access_loggers.file]
20
21// Custom configuration for an :ref:`AccessLog <envoy_api_msg_config.accesslog.v3.AccessLog>`
22// that writes log entries directly to a file. Configures the built-in *envoy.access_loggers.file*
23// AccessLog.
24// [#next-free-field: 6]
25message FileAccessLog {
26 option (udpa.annotations.versioning).previous_message_type =
27 "envoy.config.accesslog.v2.FileAccessLog";
28
29 // A path to a local file to which to write the access log entries.
30 string path = 1 [(validate.rules).string = {min_len: 1}];
31
32 oneof access_log_format {
33 // Access log :ref:`format string<config_access_log_format_strings>`.
34 // Envoy supports :ref:`custom access log formats <config_access_log_format>` as well as a
35 // :ref:`default format <config_access_log_default_format>`.
36 // This field is deprecated.
37 // Please use :ref:`log_format <envoy_v3_api_field_extensions.access_loggers.file.v3.FileAccessLog.log_format>`.
38 string format = 2 [deprecated = true];
39
40 // Access log :ref:`format dictionary<config_access_log_format_dictionaries>`. All values
41 // are rendered as strings.
42 // This field is deprecated.
43 // Please use :ref:`log_format <envoy_v3_api_field_extensions.access_loggers.file.v3.FileAccessLog.log_format>`.
44 google.protobuf.Struct json_format = 3 [deprecated = true];
45
46 // Access log :ref:`format dictionary<config_access_log_format_dictionaries>`. Values are
47 // rendered as strings, numbers, or boolean values as appropriate. Nested JSON objects may
48 // be produced by some command operators (e.g.FILTER_STATE or DYNAMIC_METADATA). See the
49 // documentation for a specific command operator for details.
50 // This field is deprecated.
51 // Please use :ref:`log_format <envoy_v3_api_field_extensions.access_loggers.file.v3.FileAccessLog.log_format>`.
52 google.protobuf.Struct typed_json_format = 4 [deprecated = true];
53
54 // Configuration to form access log data and format.
55 // If not specified, use :ref:`default format <config_access_log_default_format>`.
56 config.core.v3.SubstitutionFormatString log_format = 5
57 [(validate.rules).message = {required: true}];
58 }
59}
View as plain text