Package io.envoyproxy.envoy.config.metrics.v3

Class StatsdSink

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, StatsdSinkOrBuilder, Serializable
    public final class StatsdSink
extends com.google.protobuf.GeneratedMessageV3
implements StatsdSinkOrBuilder
     Stats configuration proto schema for built-in ``envoy.stat_sinks.statsd`` sink. This sink does not support
 tagged metrics.
 [#extension: envoy.stat_sinks.statsd]
    Protobuf type envoy.config.metrics.v3.StatsdSink
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  StatsdSink.Builder
      Stats configuration proto schema for built-in ``envoy.stat_sinks.statsd`` sink.
      static class  StatsdSink.StatsdSpecifierCase  

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

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,​BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,​BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, 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 int ADDRESS_FIELD_NUMBER  
      static int PREFIX_FIELD_NUMBER  
      static int TCP_CLUSTER_NAME_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 Detail

      • newInstance

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

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields 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

      • hasAddress

        public boolean hasAddress()
         The UDP address of a running `statsd <https://github.com/etsy/statsd>`_
 compliant listener. If specified, statistics will be flushed to this
 address.
        .envoy.config.core.v3.Address address = 1;
        Specified by:
        hasAddress in interface StatsdSinkOrBuilder
        Returns:
        Whether the address field is set.

      • getAddress

        public Address getAddress()
         The UDP address of a running `statsd <https://github.com/etsy/statsd>`_
 compliant listener. If specified, statistics will be flushed to this
 address.
        .envoy.config.core.v3.Address address = 1;
        Specified by:
        getAddress in interface StatsdSinkOrBuilder
        Returns:
        The address.

      • getAddressOrBuilder

        public AddressOrBuilder getAddressOrBuilder()
         The UDP address of a running `statsd <https://github.com/etsy/statsd>`_
 compliant listener. If specified, statistics will be flushed to this
 address.
        .envoy.config.core.v3.Address address = 1;
        Specified by:
        getAddressOrBuilder in interface StatsdSinkOrBuilder

      • hasTcpClusterName

        public boolean hasTcpClusterName()
         The name of a cluster that is running a TCP `statsd
 <https://github.com/etsy/statsd>`_ compliant listener. If specified,
 Envoy will connect to this cluster to flush statistics.
        string tcp_cluster_name = 2;
        Specified by:
        hasTcpClusterName in interface StatsdSinkOrBuilder
        Returns:
        Whether the tcpClusterName field is set.

      • getTcpClusterName

        public String getTcpClusterName()
         The name of a cluster that is running a TCP `statsd
 <https://github.com/etsy/statsd>`_ compliant listener. If specified,
 Envoy will connect to this cluster to flush statistics.
        string tcp_cluster_name = 2;
        Specified by:
        getTcpClusterName in interface StatsdSinkOrBuilder
        Returns:
        The tcpClusterName.

      • getTcpClusterNameBytes

        public com.google.protobuf.ByteString getTcpClusterNameBytes()
         The name of a cluster that is running a TCP `statsd
 <https://github.com/etsy/statsd>`_ compliant listener. If specified,
 Envoy will connect to this cluster to flush statistics.
        string tcp_cluster_name = 2;
        Specified by:
        getTcpClusterNameBytes in interface StatsdSinkOrBuilder
        Returns:
        The bytes for tcpClusterName.

      • getPrefix

        public String getPrefix()
         Optional custom prefix for StatsdSink. If
 specified, this will override the default prefix.
 For example:
 .. code-block:: json
   {
     "prefix" : "envoy-prod"
   }
 will change emitted stats to
 .. code-block:: cpp
   envoy-prod.test_counter:1|c
   envoy-prod.test_timer:5|ms
 Note that the default prefix, "envoy", will be used if a prefix is not
 specified.
 Stats with default prefix:
 .. code-block:: cpp
   envoy.test_counter:1|c
   envoy.test_timer:5|ms
        string prefix = 3;
        Specified by:
        getPrefix in interface StatsdSinkOrBuilder
        Returns:
        The prefix.

      • getPrefixBytes

        public com.google.protobuf.ByteString getPrefixBytes()
         Optional custom prefix for StatsdSink. If
 specified, this will override the default prefix.
 For example:
 .. code-block:: json
   {
     "prefix" : "envoy-prod"
   }
 will change emitted stats to
 .. code-block:: cpp
   envoy-prod.test_counter:1|c
   envoy-prod.test_timer:5|ms
 Note that the default prefix, "envoy", will be used if a prefix is not
 specified.
 Stats with default prefix:
 .. code-block:: cpp
   envoy.test_counter:1|c
   envoy.test_timer:5|ms
        string prefix = 3;
        Specified by:
        getPrefixBytes in interface StatsdSinkOrBuilder
        Returns:
        The bytes for prefix.

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getDefaultInstance

        public static StatsdSink getDefaultInstance()

      • parser

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

      • getParserForType

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