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

Class FluentdConfig

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.extensions.tracers.fluentd.v3.FluentdConfig
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, FluentdConfigOrBuilder, Serializable
public final class FluentdConfig extends com.google.protobuf.GeneratedMessageV3 implements FluentdConfigOrBuilder
 Configuration for the Fluentd tracer.
 This tracer extension will send the emitted traces 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.tracers.fluentd]
 [#next-free-field: 7]
Protobuf type envoy.extensions.tracers.fluentd.v3.FluentdConfig
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    FluentdConfig.Builder
    Configuration for the Fluentd tracer.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    BUFFER_FLUSH_INTERVAL_FIELD_NUMBER
     
    static final int
    BUFFER_SIZE_BYTES_FIELD_NUMBER
     
    static final int
    CLUSTER_FIELD_NUMBER
     
    static final int
    RETRY_POLICY_FIELD_NUMBER
     
    static final int
    STAT_PREFIX_FIELD_NUMBER
     
    static final int
    TAG_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    com.google.protobuf.Duration
    getBufferFlushInterval()
    Interval for flushing traces to the TCP stream.
    com.google.protobuf.DurationOrBuilder
    getBufferFlushIntervalOrBuilder()
    Interval for flushing traces to the TCP stream.
    com.google.protobuf.UInt32Value
    getBufferSizeBytes()
    Soft size limit in bytes for access log entries buffer.
    com.google.protobuf.UInt32ValueOrBuilder
    getBufferSizeBytesOrBuilder()
    Soft size limit in bytes for access log entries buffer.
    String
    getCluster()
    The upstream cluster to connect to for streaming the Fluentd messages.
    com.google.protobuf.ByteString
    getClusterBytes()
    The upstream cluster to connect to for streaming the Fluentd messages.
    static FluentdConfig
    getDefaultInstance()
     
    FluentdConfig
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Parser<FluentdConfig>
    getParserForType()
     
    RetryPolicy
    getRetryPolicy()
    Optional retry, in case upstream connection has failed.
    RetryPolicyOrBuilder
    getRetryPolicyOrBuilder()
    Optional retry, in case upstream connection has failed.
    int
    getSerializedSize()
     
    String
    getStatPrefix()
    The prefix to use when emitting tracer stats.
    com.google.protobuf.ByteString
    getStatPrefixBytes()
    The prefix to use when emitting tracer stats.
    String
    getTag()
    A tag is a string separated with ``.`` (e.g.
    com.google.protobuf.ByteString
    getTagBytes()
    A tag is a string separated with ``.`` (e.g.
    boolean
    hasBufferFlushInterval()
    Interval for flushing traces to the TCP stream.
    boolean
    hasBufferSizeBytes()
    Soft size limit in bytes for access log entries buffer.
    int
    hashCode()
     
    boolean
    hasRetryPolicy()
    Optional retry, in case upstream connection has failed.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static FluentdConfig.Builder
    newBuilder()
     
    static FluentdConfig.Builder
    newBuilder(FluentdConfig prototype)
     
    FluentdConfig.Builder
    newBuilderForType()
     
    protected FluentdConfig.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static FluentdConfig
    parseDelimitedFrom(InputStream input)
     
    static FluentdConfig
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static FluentdConfig
    parseFrom(byte[] data)
     
    static FluentdConfig
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static FluentdConfig
    parseFrom(com.google.protobuf.ByteString data)
     
    static FluentdConfig
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static FluentdConfig
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static FluentdConfig
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static FluentdConfig
    parseFrom(InputStream input)
     
    static FluentdConfig
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static FluentdConfig
    parseFrom(ByteBuffer data)
     
    static FluentdConfig
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<FluentdConfig>
    parser()
     
    FluentdConfig.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • 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:

    • RETRY_POLICY_FIELD_NUMBER

      public static final int RETRY_POLICY_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 FluentdConfigOrBuilder
      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 FluentdConfigOrBuilder
      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 FluentdConfigOrBuilder
      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 FluentdConfigOrBuilder
      Returns:
      The bytes for tag.

    • getStatPrefix

      public String getStatPrefix()
       The prefix to use when emitting tracer stats.
      string stat_prefix = 3 [(.validate.rules) = { ... }
      Specified by:
      getStatPrefix in interface FluentdConfigOrBuilder
      Returns:
      The statPrefix.

    • getStatPrefixBytes

      public com.google.protobuf.ByteString getStatPrefixBytes()
       The prefix to use when emitting tracer stats.
      string stat_prefix = 3 [(.validate.rules) = { ... }
      Specified by:
      getStatPrefixBytes in interface FluentdConfigOrBuilder
      Returns:
      The bytes for statPrefix.

    • hasBufferFlushInterval

      public boolean hasBufferFlushInterval()
       Interval for flushing traces to the TCP stream. Tracer 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 FluentdConfigOrBuilder
      Returns:
      Whether the bufferFlushInterval field is set.

    • getBufferFlushInterval

      public com.google.protobuf.Duration getBufferFlushInterval()
       Interval for flushing traces to the TCP stream. Tracer 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 FluentdConfigOrBuilder
      Returns:
      The bufferFlushInterval.

    • getBufferFlushIntervalOrBuilder

      public com.google.protobuf.DurationOrBuilder getBufferFlushIntervalOrBuilder()
       Interval for flushing traces to the TCP stream. Tracer 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 FluentdConfigOrBuilder

    • 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 FluentdConfigOrBuilder
      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 FluentdConfigOrBuilder
      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 FluentdConfigOrBuilder

    • hasRetryPolicy

      public boolean hasRetryPolicy()
       Optional retry, in case upstream connection has failed. If this field is not set, the default values will be applied.
      .envoy.config.core.v3.RetryPolicy retry_policy = 6;
      Specified by:
      hasRetryPolicy in interface FluentdConfigOrBuilder
      Returns:
      Whether the retryPolicy field is set.

    • getRetryPolicy

      public RetryPolicy getRetryPolicy()
       Optional retry, in case upstream connection has failed. If this field is not set, the default values will be applied.
      .envoy.config.core.v3.RetryPolicy retry_policy = 6;
      Specified by:
      getRetryPolicy in interface FluentdConfigOrBuilder
      Returns:
      The retryPolicy.

    • getRetryPolicyOrBuilder

      public RetryPolicyOrBuilder getRetryPolicyOrBuilder()
       Optional retry, in case upstream connection has failed. If this field is not set, the default values will be applied.
      .envoy.config.core.v3.RetryPolicy retry_policy = 6;
      Specified by:
      getRetryPolicyOrBuilder in interface FluentdConfigOrBuilder

    • 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 FluentdConfig parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static FluentdConfig.Builder newBuilder()

    • newBuilder

      public static FluentdConfig.Builder newBuilder(FluentdConfig prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static FluentdConfig getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<FluentdConfig> 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 FluentdConfig getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder