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

Class MetricsServiceConfig

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.config.metrics.v3.MetricsServiceConfig
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, MetricsServiceConfigOrBuilder, Serializable
public final class MetricsServiceConfig extends com.google.protobuf.GeneratedMessageV3 implements MetricsServiceConfigOrBuilder
 Metrics Service is configured as a built-in ``envoy.stat_sinks.metrics_service`` :ref:`StatsSink
 <envoy_v3_api_msg_config.metrics.v3.StatsSink>`. This opaque configuration will be used to create
 Metrics Service.

 Example:

 .. code-block:: yaml

     stats_sinks:
       - name: envoy.stat_sinks.metrics_service
         typed_config:
           "@type": type.googleapis.com/envoy.config.metrics.v3.MetricsServiceConfig

 [#extension: envoy.stat_sinks.metrics_service]
 [#next-free-field: 7]
Protobuf type envoy.config.metrics.v3.MetricsServiceConfig
See Also:

  • Field Details

    • GRPC_SERVICE_FIELD_NUMBER

      public static final int GRPC_SERVICE_FIELD_NUMBER
      See Also:

    • TRANSPORT_API_VERSION_FIELD_NUMBER

      public static final int TRANSPORT_API_VERSION_FIELD_NUMBER
      See Also:

    • REPORT_COUNTERS_AS_DELTAS_FIELD_NUMBER

      public static final int REPORT_COUNTERS_AS_DELTAS_FIELD_NUMBER
      See Also:

    • EMIT_TAGS_AS_LABELS_FIELD_NUMBER

      public static final int EMIT_TAGS_AS_LABELS_FIELD_NUMBER
      See Also:

    • HISTOGRAM_EMIT_MODE_FIELD_NUMBER

      public static final int HISTOGRAM_EMIT_MODE_FIELD_NUMBER
      See Also:

    • BATCH_SIZE_FIELD_NUMBER

      public static final int BATCH_SIZE_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

    • hasGrpcService

      public boolean hasGrpcService()
       The upstream gRPC cluster that hosts the metrics service.
      .envoy.config.core.v3.GrpcService grpc_service = 1 [(.validate.rules) = { ... }
      Specified by:
      hasGrpcService in interface MetricsServiceConfigOrBuilder
      Returns:
      Whether the grpcService field is set.

    • getGrpcService

      public GrpcService getGrpcService()
       The upstream gRPC cluster that hosts the metrics service.
      .envoy.config.core.v3.GrpcService grpc_service = 1 [(.validate.rules) = { ... }
      Specified by:
      getGrpcService in interface MetricsServiceConfigOrBuilder
      Returns:
      The grpcService.

    • getGrpcServiceOrBuilder

      public GrpcServiceOrBuilder getGrpcServiceOrBuilder()
       The upstream gRPC cluster that hosts the metrics service.
      .envoy.config.core.v3.GrpcService grpc_service = 1 [(.validate.rules) = { ... }
      Specified by:
      getGrpcServiceOrBuilder in interface MetricsServiceConfigOrBuilder

    • getTransportApiVersionValue

      public int getTransportApiVersionValue()
       API version for metric service transport protocol. This describes the metric service gRPC
 endpoint and version of messages used on the wire.
      .envoy.config.core.v3.ApiVersion transport_api_version = 3 [(.validate.rules) = { ... }
      Specified by:
      getTransportApiVersionValue in interface MetricsServiceConfigOrBuilder
      Returns:
      The enum numeric value on the wire for transportApiVersion.

    • getTransportApiVersion

      public ApiVersion getTransportApiVersion()
       API version for metric service transport protocol. This describes the metric service gRPC
 endpoint and version of messages used on the wire.
      .envoy.config.core.v3.ApiVersion transport_api_version = 3 [(.validate.rules) = { ... }
      Specified by:
      getTransportApiVersion in interface MetricsServiceConfigOrBuilder
      Returns:
      The transportApiVersion.

    • hasReportCountersAsDeltas

      public boolean hasReportCountersAsDeltas()
       If true, counters are reported as the delta between flushing intervals. Otherwise, the current
 counter value is reported. Defaults to false.
 Eventually (https://github.com/envoyproxy/envoy/issues/10968) if this value is not set, the
 sink will take updates from the :ref:`MetricsResponse <envoy_v3_api_msg_service.metrics.v3.StreamMetricsResponse>`.
      .google.protobuf.BoolValue report_counters_as_deltas = 2;
      Specified by:
      hasReportCountersAsDeltas in interface MetricsServiceConfigOrBuilder
      Returns:
      Whether the reportCountersAsDeltas field is set.

    • getReportCountersAsDeltas

      public com.google.protobuf.BoolValue getReportCountersAsDeltas()
       If true, counters are reported as the delta between flushing intervals. Otherwise, the current
 counter value is reported. Defaults to false.
 Eventually (https://github.com/envoyproxy/envoy/issues/10968) if this value is not set, the
 sink will take updates from the :ref:`MetricsResponse <envoy_v3_api_msg_service.metrics.v3.StreamMetricsResponse>`.
      .google.protobuf.BoolValue report_counters_as_deltas = 2;
      Specified by:
      getReportCountersAsDeltas in interface MetricsServiceConfigOrBuilder
      Returns:
      The reportCountersAsDeltas.

    • getReportCountersAsDeltasOrBuilder

      public com.google.protobuf.BoolValueOrBuilder getReportCountersAsDeltasOrBuilder()
       If true, counters are reported as the delta between flushing intervals. Otherwise, the current
 counter value is reported. Defaults to false.
 Eventually (https://github.com/envoyproxy/envoy/issues/10968) if this value is not set, the
 sink will take updates from the :ref:`MetricsResponse <envoy_v3_api_msg_service.metrics.v3.StreamMetricsResponse>`.
      .google.protobuf.BoolValue report_counters_as_deltas = 2;
      Specified by:
      getReportCountersAsDeltasOrBuilder in interface MetricsServiceConfigOrBuilder

    • getEmitTagsAsLabels

      public boolean getEmitTagsAsLabels()
       If true, metrics will have their tags emitted as labels on the metrics objects sent to the MetricsService,
 and the tag extracted name will be used instead of the full name, which may contain values used by the tag
 extractor or additional tags added during stats creation.
      bool emit_tags_as_labels = 4;
      Specified by:
      getEmitTagsAsLabels in interface MetricsServiceConfigOrBuilder
      Returns:
      The emitTagsAsLabels.

    • getHistogramEmitModeValue

      public int getHistogramEmitModeValue()
       Specify which metrics types to emit for histograms. Defaults to SUMMARY_AND_HISTOGRAM.
      .envoy.config.metrics.v3.HistogramEmitMode histogram_emit_mode = 5 [(.validate.rules) = { ... }
      Specified by:
      getHistogramEmitModeValue in interface MetricsServiceConfigOrBuilder
      Returns:
      The enum numeric value on the wire for histogramEmitMode.

    • getHistogramEmitMode

      public HistogramEmitMode getHistogramEmitMode()
       Specify which metrics types to emit for histograms. Defaults to SUMMARY_AND_HISTOGRAM.
      .envoy.config.metrics.v3.HistogramEmitMode histogram_emit_mode = 5 [(.validate.rules) = { ... }
      Specified by:
      getHistogramEmitMode in interface MetricsServiceConfigOrBuilder
      Returns:
      The histogramEmitMode.

    • getBatchSize

      public int getBatchSize()
       The maximum number of metrics to send in a single gRPC message. If not set or set to 0,
 all metrics will be sent in a single message (current behavior). When set to a positive value,
 metrics will be batched into multiple messages, with each message containing at most batch_size
 metric families. This helps avoid hitting gRPC message size limits (typically 4MB) when sending
 large numbers of metrics.
      uint32 batch_size = 6 [(.validate.rules) = { ... }
      Specified by:
      getBatchSize in interface MetricsServiceConfigOrBuilder
      Returns:
      The batchSize.

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static MetricsServiceConfig.Builder newBuilder()

    • newBuilder

      public static MetricsServiceConfig.Builder newBuilder(MetricsServiceConfig prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static MetricsServiceConfig getDefaultInstance()

    • parser

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

    • getParserForType

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