envoy.extensions.access_loggers.file.v3.file.proto Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of api Show documentation

There is a newer version: 1.0.47

syntax = "proto3";

package envoy.extensions.access_loggers.file.v3;

import "google/protobuf/struct.proto";

import "udpa/annotations/versioning.proto";

import "validate/validate.proto";

option java_package = "io.envoyproxy.envoy.extensions.access_loggers.file.v3";
option java_outer_classname = "FileProto";
option java_multiple_files = true;

// [#protodoc-title: File access log]
// [#extension: envoy.access_loggers.file]

// Custom configuration for an :ref:`AccessLog `
// that writes log entries directly to a file. Configures the built-in *envoy.access_loggers.file*
// AccessLog.
message FileAccessLog {
  option (udpa.annotations.versioning).previous_message_type =
      "envoy.config.accesslog.v2.FileAccessLog";

  // A path to a local file to which to write the access log entries.
  string path = 1 [(validate.rules).string = {min_bytes: 1}];

  oneof access_log_format {
    // Access log :ref:`format string`.
    // Envoy supports :ref:`custom access log formats ` as well as a
    // :ref:`default format `.
    string format = 2;

    // Access log :ref:`format dictionary`. All values
    // are rendered as strings.
    google.protobuf.Struct json_format = 3;

    // 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.
    google.protobuf.Struct typed_json_format = 4;
  }
}