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

Interface MetricsServiceConfigOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
MetricsServiceConfig, MetricsServiceConfig.Builder
public interface MetricsServiceConfigOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getBatchSize()
    The maximum number of metrics to send in a single gRPC message.
    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.
    GrpcService
    getGrpcService()
    The upstream gRPC cluster that hosts the metrics service.
    GrpcServiceOrBuilder
    getGrpcServiceOrBuilder()
    The upstream gRPC cluster that hosts the metrics service.
    HistogramEmitMode
    getHistogramEmitMode()
    Specify which metrics types to emit for histograms.
    int
    getHistogramEmitModeValue()
    Specify which metrics types to emit for histograms.
    com.google.protobuf.BoolValue
    getReportCountersAsDeltas()
    If true, counters are reported as the delta between flushing intervals.
    com.google.protobuf.BoolValueOrBuilder
    getReportCountersAsDeltasOrBuilder()
    If true, counters are reported as the delta between flushing intervals.
    ApiVersion
    getTransportApiVersion()
    API version for metric service transport protocol.
    int
    getTransportApiVersionValue()
    API version for metric service transport protocol.
    boolean
    hasGrpcService()
    The upstream gRPC cluster that hosts the metrics service.
    boolean
    hasReportCountersAsDeltas()
    If true, counters are reported as the delta between flushing intervals.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • hasGrpcService

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

    • getGrpcService

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

    • getGrpcServiceOrBuilder

      GrpcServiceOrBuilder getGrpcServiceOrBuilder()
       The upstream gRPC cluster that hosts the metrics service.
      .envoy.config.core.v3.GrpcService grpc_service = 1 [(.validate.rules) = { ... }

    • getTransportApiVersionValue

      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) = { ... }
      Returns:
      The enum numeric value on the wire for transportApiVersion.

    • getTransportApiVersion

      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) = { ... }
      Returns:
      The transportApiVersion.

    • hasReportCountersAsDeltas

      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;
      Returns:
      Whether the reportCountersAsDeltas field is set.

    • getReportCountersAsDeltas

      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;
      Returns:
      The reportCountersAsDeltas.

    • getReportCountersAsDeltasOrBuilder

      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;

    • getEmitTagsAsLabels

      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;
      Returns:
      The emitTagsAsLabels.

    • getHistogramEmitModeValue

      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) = { ... }
      Returns:
      The enum numeric value on the wire for histogramEmitMode.

    • getHistogramEmitMode

      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) = { ... }
      Returns:
      The histogramEmitMode.

    • getBatchSize

      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) = { ... }
      Returns:
      The batchSize.