Package io.envoyproxy.envoy.extensions.access_loggers.fluentd.v3

Class FluentdAccessLogConfig

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.extensions.access_loggers.fluentd.v3.FluentdAccessLogConfig
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, FluentdAccessLogConfigOrBuilder, Serializable
public final class FluentdAccessLogConfig extends com.google.protobuf.GeneratedMessageV3 implements FluentdAccessLogConfigOrBuilder
 Configuration for the *envoy.access_loggers.fluentd* :ref:`AccessLog <envoy_v3_api_msg_config.accesslog.v3.AccessLog>`.
 This access log extension will send the emitted access logs over a TCP connection to an upstream that is accepting
 the Fluentd Forward Protocol as described in: `Fluentd Forward Protocol Specification
 <https://github.com/fluent/fluentd/wiki/Forward-Protocol-Specification-v1>`_.
 [#extension: envoy.access_loggers.fluentd]
 [#next-free-field: 9]
Protobuf type envoy.extensions.access_loggers.fluentd.v3.FluentdAccessLogConfig
See Also:

  • Field Details

    • CLUSTER_FIELD_NUMBER

      public static final int CLUSTER_FIELD_NUMBER
      See Also:

    • TAG_FIELD_NUMBER

      public static final int TAG_FIELD_NUMBER
      See Also:

    • STAT_PREFIX_FIELD_NUMBER

      public static final int STAT_PREFIX_FIELD_NUMBER
      See Also:

    • BUFFER_FLUSH_INTERVAL_FIELD_NUMBER

      public static final int BUFFER_FLUSH_INTERVAL_FIELD_NUMBER
      See Also:

    • BUFFER_SIZE_BYTES_FIELD_NUMBER

      public static final int BUFFER_SIZE_BYTES_FIELD_NUMBER
      See Also:

    • RECORD_FIELD_NUMBER

      public static final int RECORD_FIELD_NUMBER
      See Also:

    • RETRY_OPTIONS_FIELD_NUMBER

      public static final int RETRY_OPTIONS_FIELD_NUMBER
      See Also:

    • FORMATTERS_FIELD_NUMBER

      public static final int FORMATTERS_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • getCluster

      public String getCluster()
       The upstream cluster to connect to for streaming the Fluentd messages.
      string cluster = 1 [(.validate.rules) = { ... }
      Specified by:
      getCluster in interface FluentdAccessLogConfigOrBuilder
      Returns:
      The cluster.

    • getClusterBytes

      public com.google.protobuf.ByteString getClusterBytes()
       The upstream cluster to connect to for streaming the Fluentd messages.
      string cluster = 1 [(.validate.rules) = { ... }
      Specified by:
      getClusterBytes in interface FluentdAccessLogConfigOrBuilder
      Returns:
      The bytes for cluster.

    • getTag

      public String getTag()
       A tag is a string separated with '.' (e.g. log.type) to categorize events.
 See: https://github.com/fluent/fluentd/wiki/Forward-Protocol-Specification-v1#message-modes
      string tag = 2 [(.validate.rules) = { ... }
      Specified by:
      getTag in interface FluentdAccessLogConfigOrBuilder
      Returns:
      The tag.

    • getTagBytes

      public com.google.protobuf.ByteString getTagBytes()
       A tag is a string separated with '.' (e.g. log.type) to categorize events.
 See: https://github.com/fluent/fluentd/wiki/Forward-Protocol-Specification-v1#message-modes
      string tag = 2 [(.validate.rules) = { ... }
      Specified by:
      getTagBytes in interface FluentdAccessLogConfigOrBuilder
      Returns:
      The bytes for tag.

    • getStatPrefix

      public String getStatPrefix()
       The prefix to use when emitting :ref:`statistics <config_access_log_stats>`.
      string stat_prefix = 3 [(.validate.rules) = { ... }
      Specified by:
      getStatPrefix in interface FluentdAccessLogConfigOrBuilder
      Returns:
      The statPrefix.

    • getStatPrefixBytes

      public com.google.protobuf.ByteString getStatPrefixBytes()
       The prefix to use when emitting :ref:`statistics <config_access_log_stats>`.
      string stat_prefix = 3 [(.validate.rules) = { ... }
      Specified by:
      getStatPrefixBytes in interface FluentdAccessLogConfigOrBuilder
      Returns:
      The bytes for statPrefix.

    • hasBufferFlushInterval

      public boolean hasBufferFlushInterval()
       Interval for flushing access logs to the TCP 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.
      .google.protobuf.Duration buffer_flush_interval = 4 [(.validate.rules) = { ... }
      Specified by:
      hasBufferFlushInterval in interface FluentdAccessLogConfigOrBuilder
      Returns:
      Whether the bufferFlushInterval field is set.

    • getBufferFlushInterval

      public com.google.protobuf.Duration getBufferFlushInterval()
       Interval for flushing access logs to the TCP 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.
      .google.protobuf.Duration buffer_flush_interval = 4 [(.validate.rules) = { ... }
      Specified by:
      getBufferFlushInterval in interface FluentdAccessLogConfigOrBuilder
      Returns:
      The bufferFlushInterval.

    • getBufferFlushIntervalOrBuilder

      public com.google.protobuf.DurationOrBuilder getBufferFlushIntervalOrBuilder()
       Interval for flushing access logs to the TCP 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.
      .google.protobuf.Duration buffer_flush_interval = 4 [(.validate.rules) = { ... }
      Specified by:
      getBufferFlushIntervalOrBuilder in interface FluentdAccessLogConfigOrBuilder

    • hasBufferSizeBytes

      public boolean hasBufferSizeBytes()
       Soft size limit in bytes for access log entries buffer. The logger will buffer requests until
 this limit it hit, or every time flush interval is elapsed, whichever comes first. When the buffer
 limit is hit, the logger will immediately flush the buffer contents. Setting it to zero effectively
 disables the batching. Defaults to 16384.
      .google.protobuf.UInt32Value buffer_size_bytes = 5;
      Specified by:
      hasBufferSizeBytes in interface FluentdAccessLogConfigOrBuilder
      Returns:
      Whether the bufferSizeBytes field is set.

    • getBufferSizeBytes

      public com.google.protobuf.UInt32Value getBufferSizeBytes()
       Soft size limit in bytes for access log entries buffer. The logger will buffer requests until
 this limit it hit, or every time flush interval is elapsed, whichever comes first. When the buffer
 limit is hit, the logger will immediately flush the buffer contents. Setting it to zero effectively
 disables the batching. Defaults to 16384.
      .google.protobuf.UInt32Value buffer_size_bytes = 5;
      Specified by:
      getBufferSizeBytes in interface FluentdAccessLogConfigOrBuilder
      Returns:
      The bufferSizeBytes.

    • getBufferSizeBytesOrBuilder

      public com.google.protobuf.UInt32ValueOrBuilder getBufferSizeBytesOrBuilder()
       Soft size limit in bytes for access log entries buffer. The logger will buffer requests until
 this limit it hit, or every time flush interval is elapsed, whichever comes first. When the buffer
 limit is hit, the logger will immediately flush the buffer contents. Setting it to zero effectively
 disables the batching. Defaults to 16384.
      .google.protobuf.UInt32Value buffer_size_bytes = 5;
      Specified by:
      getBufferSizeBytesOrBuilder in interface FluentdAccessLogConfigOrBuilder

    • hasRecord

      public boolean hasRecord()
       A struct that represents the record that is sent for each log entry.
 https://github.com/fluent/fluentd/wiki/Forward-Protocol-Specification-v1#entry
 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 :ref:`format string<config_access_log_format_strings>` documentation for a specific command operator details.

 .. validated-code-block:: yaml
   :type-name: envoy.extensions.access_loggers.fluentd.v3.FluentdAccessLogConfig

   record:
     status: "%RESPONSE_CODE%"
     message: "%LOCAL_REPLY_BODY%"

 The following msgpack record would be created:

 .. code-block:: json

  {
    "status": 500,
    "message": "My error message"
  }
      .google.protobuf.Struct record = 6 [(.validate.rules) = { ... }
      Specified by:
      hasRecord in interface FluentdAccessLogConfigOrBuilder
      Returns:
      Whether the record field is set.

    • getRecord

      public com.google.protobuf.Struct getRecord()
       A struct that represents the record that is sent for each log entry.
 https://github.com/fluent/fluentd/wiki/Forward-Protocol-Specification-v1#entry
 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 :ref:`format string<config_access_log_format_strings>` documentation for a specific command operator details.

 .. validated-code-block:: yaml
   :type-name: envoy.extensions.access_loggers.fluentd.v3.FluentdAccessLogConfig

   record:
     status: "%RESPONSE_CODE%"
     message: "%LOCAL_REPLY_BODY%"

 The following msgpack record would be created:

 .. code-block:: json

  {
    "status": 500,
    "message": "My error message"
  }
      .google.protobuf.Struct record = 6 [(.validate.rules) = { ... }
      Specified by:
      getRecord in interface FluentdAccessLogConfigOrBuilder
      Returns:
      The record.

    • getRecordOrBuilder

      public com.google.protobuf.StructOrBuilder getRecordOrBuilder()
       A struct that represents the record that is sent for each log entry.
 https://github.com/fluent/fluentd/wiki/Forward-Protocol-Specification-v1#entry
 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 :ref:`format string<config_access_log_format_strings>` documentation for a specific command operator details.

 .. validated-code-block:: yaml
   :type-name: envoy.extensions.access_loggers.fluentd.v3.FluentdAccessLogConfig

   record:
     status: "%RESPONSE_CODE%"
     message: "%LOCAL_REPLY_BODY%"

 The following msgpack record would be created:

 .. code-block:: json

  {
    "status": 500,
    "message": "My error message"
  }
      .google.protobuf.Struct record = 6 [(.validate.rules) = { ... }
      Specified by:
      getRecordOrBuilder in interface FluentdAccessLogConfigOrBuilder

    • hasRetryOptions

      public boolean hasRetryOptions()
       Optional retry, in case upstream connection has failed. If this field is not set, the default values will be applied,
 as specified in the :ref:`RetryOptions <envoy_v3_api_msg_extensions.access_loggers.fluentd.v3.FluentdAccessLogConfig.RetryOptions>`
 configuration.
      .envoy.extensions.access_loggers.fluentd.v3.FluentdAccessLogConfig.RetryOptions retry_options = 7;
      Specified by:
      hasRetryOptions in interface FluentdAccessLogConfigOrBuilder
      Returns:
      Whether the retryOptions field is set.

    • getRetryOptions

      public FluentdAccessLogConfig.RetryOptions getRetryOptions()
       Optional retry, in case upstream connection has failed. If this field is not set, the default values will be applied,
 as specified in the :ref:`RetryOptions <envoy_v3_api_msg_extensions.access_loggers.fluentd.v3.FluentdAccessLogConfig.RetryOptions>`
 configuration.
      .envoy.extensions.access_loggers.fluentd.v3.FluentdAccessLogConfig.RetryOptions retry_options = 7;
      Specified by:
      getRetryOptions in interface FluentdAccessLogConfigOrBuilder
      Returns:
      The retryOptions.

    • getRetryOptionsOrBuilder

      public FluentdAccessLogConfig.RetryOptionsOrBuilder getRetryOptionsOrBuilder()
       Optional retry, in case upstream connection has failed. If this field is not set, the default values will be applied,
 as specified in the :ref:`RetryOptions <envoy_v3_api_msg_extensions.access_loggers.fluentd.v3.FluentdAccessLogConfig.RetryOptions>`
 configuration.
      .envoy.extensions.access_loggers.fluentd.v3.FluentdAccessLogConfig.RetryOptions retry_options = 7;
      Specified by:
      getRetryOptionsOrBuilder in interface FluentdAccessLogConfigOrBuilder

    • getFormattersList

      public List<TypedExtensionConfig> getFormattersList()
       Specifies a collection of Formatter plugins that can be called from the access log configuration.
 See the formatters extensions documentation for details.
 [#extension-category: envoy.formatter]
      repeated .envoy.config.core.v3.TypedExtensionConfig formatters = 8;
      Specified by:
      getFormattersList in interface FluentdAccessLogConfigOrBuilder

    • getFormattersOrBuilderList

      public List<? extends TypedExtensionConfigOrBuilder> getFormattersOrBuilderList()
       Specifies a collection of Formatter plugins that can be called from the access log configuration.
 See the formatters extensions documentation for details.
 [#extension-category: envoy.formatter]
      repeated .envoy.config.core.v3.TypedExtensionConfig formatters = 8;
      Specified by:
      getFormattersOrBuilderList in interface FluentdAccessLogConfigOrBuilder

    • getFormattersCount

      public int getFormattersCount()
       Specifies a collection of Formatter plugins that can be called from the access log configuration.
 See the formatters extensions documentation for details.
 [#extension-category: envoy.formatter]
      repeated .envoy.config.core.v3.TypedExtensionConfig formatters = 8;
      Specified by:
      getFormattersCount in interface FluentdAccessLogConfigOrBuilder

    • getFormatters

      public TypedExtensionConfig getFormatters(int index)
       Specifies a collection of Formatter plugins that can be called from the access log configuration.
 See the formatters extensions documentation for details.
 [#extension-category: envoy.formatter]
      repeated .envoy.config.core.v3.TypedExtensionConfig formatters = 8;
      Specified by:
      getFormatters in interface FluentdAccessLogConfigOrBuilder

    • getFormattersOrBuilder

      public TypedExtensionConfigOrBuilder getFormattersOrBuilder(int index)
       Specifies a collection of Formatter plugins that can be called from the access log configuration.
 See the formatters extensions documentation for details.
 [#extension-category: envoy.formatter]
      repeated .envoy.config.core.v3.TypedExtensionConfig formatters = 8;
      Specified by:
      getFormattersOrBuilder in interface FluentdAccessLogConfigOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static FluentdAccessLogConfig parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static FluentdAccessLogConfig parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static FluentdAccessLogConfig parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static FluentdAccessLogConfig parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static FluentdAccessLogConfig parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static FluentdAccessLogConfig parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static FluentdAccessLogConfig parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static FluentdAccessLogConfig parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static FluentdAccessLogConfig parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static FluentdAccessLogConfig parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static FluentdAccessLogConfig parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static FluentdAccessLogConfig parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public FluentdAccessLogConfig.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static FluentdAccessLogConfig.Builder newBuilder()

    • newBuilder

      public static FluentdAccessLogConfig.Builder newBuilder(FluentdAccessLogConfig prototype)

    • toBuilder

      public FluentdAccessLogConfig.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected FluentdAccessLogConfig.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static FluentdAccessLogConfig getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<FluentdAccessLogConfig> parser()

    • getParserForType

      public com.google.protobuf.Parser<FluentdAccessLogConfig> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

      public FluentdAccessLogConfig getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder