Package io.envoyproxy.envoy.extensions.stat_sinks.open_telemetry.v3

Class SinkConfig

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.extensions.stat_sinks.open_telemetry.v3.SinkConfig
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, SinkConfigOrBuilder, Serializable
public final class SinkConfig extends com.google.protobuf.GeneratedMessageV3 implements SinkConfigOrBuilder
 [#next-free-field: 9]
Protobuf type envoy.extensions.stat_sinks.open_telemetry.v3.SinkConfig
See Also:

  • Field Details

    • GRPC_SERVICE_FIELD_NUMBER

      public static final int GRPC_SERVICE_FIELD_NUMBER
      See Also:

    • RESOURCE_DETECTORS_FIELD_NUMBER

      public static final int RESOURCE_DETECTORS_FIELD_NUMBER
      See Also:

    • REPORT_COUNTERS_AS_DELTAS_FIELD_NUMBER

      public static final int REPORT_COUNTERS_AS_DELTAS_FIELD_NUMBER
      See Also:

    • REPORT_HISTOGRAMS_AS_DELTAS_FIELD_NUMBER

      public static final int REPORT_HISTOGRAMS_AS_DELTAS_FIELD_NUMBER
      See Also:

    • EMIT_TAGS_AS_ATTRIBUTES_FIELD_NUMBER

      public static final int EMIT_TAGS_AS_ATTRIBUTES_FIELD_NUMBER
      See Also:

    • USE_TAG_EXTRACTED_NAME_FIELD_NUMBER

      public static final int USE_TAG_EXTRACTED_NAME_FIELD_NUMBER
      See Also:

    • PREFIX_FIELD_NUMBER

      public static final int PREFIX_FIELD_NUMBER
      See Also:

    • CUSTOM_METRIC_CONVERSIONS_FIELD_NUMBER

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

    • getProtocolSpecifierCase

      public SinkConfig.ProtocolSpecifierCase getProtocolSpecifierCase()
      Specified by:
      getProtocolSpecifierCase in interface SinkConfigOrBuilder

    • hasGrpcService

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

    • getGrpcService

      public GrpcService getGrpcService()
       The upstream gRPC cluster that implements the OTLP/gRPC collector.
      .envoy.config.core.v3.GrpcService grpc_service = 1 [(.validate.rules) = { ... }
      Specified by:
      getGrpcService in interface SinkConfigOrBuilder
      Returns:
      The grpcService.

    • getGrpcServiceOrBuilder

      public GrpcServiceOrBuilder getGrpcServiceOrBuilder()
       The upstream gRPC cluster that implements the OTLP/gRPC collector.
      .envoy.config.core.v3.GrpcService grpc_service = 1 [(.validate.rules) = { ... }
      Specified by:
      getGrpcServiceOrBuilder in interface SinkConfigOrBuilder

    • getResourceDetectorsList

      public List<TypedExtensionConfig> getResourceDetectorsList()
       Attributes to be associated with the resource in the OTLP message.
 [#extension-category: envoy.tracers.opentelemetry.resource_detectors]
      repeated .envoy.config.core.v3.TypedExtensionConfig resource_detectors = 7;
      Specified by:
      getResourceDetectorsList in interface SinkConfigOrBuilder

    • getResourceDetectorsOrBuilderList

      public List<? extends TypedExtensionConfigOrBuilder> getResourceDetectorsOrBuilderList()
       Attributes to be associated with the resource in the OTLP message.
 [#extension-category: envoy.tracers.opentelemetry.resource_detectors]
      repeated .envoy.config.core.v3.TypedExtensionConfig resource_detectors = 7;
      Specified by:
      getResourceDetectorsOrBuilderList in interface SinkConfigOrBuilder

    • getResourceDetectorsCount

      public int getResourceDetectorsCount()
       Attributes to be associated with the resource in the OTLP message.
 [#extension-category: envoy.tracers.opentelemetry.resource_detectors]
      repeated .envoy.config.core.v3.TypedExtensionConfig resource_detectors = 7;
      Specified by:
      getResourceDetectorsCount in interface SinkConfigOrBuilder

    • getResourceDetectors

      public TypedExtensionConfig getResourceDetectors(int index)
       Attributes to be associated with the resource in the OTLP message.
 [#extension-category: envoy.tracers.opentelemetry.resource_detectors]
      repeated .envoy.config.core.v3.TypedExtensionConfig resource_detectors = 7;
      Specified by:
      getResourceDetectors in interface SinkConfigOrBuilder

    • getResourceDetectorsOrBuilder

      public TypedExtensionConfigOrBuilder getResourceDetectorsOrBuilder(int index)
       Attributes to be associated with the resource in the OTLP message.
 [#extension-category: envoy.tracers.opentelemetry.resource_detectors]
      repeated .envoy.config.core.v3.TypedExtensionConfig resource_detectors = 7;
      Specified by:
      getResourceDetectorsOrBuilder in interface SinkConfigOrBuilder

    • getReportCountersAsDeltas

      public boolean getReportCountersAsDeltas()
       If set to true, counters will be emitted as deltas, and the OTLP message will have
 ``AGGREGATION_TEMPORALITY_DELTA`` set as AggregationTemporality.
      bool report_counters_as_deltas = 2;
      Specified by:
      getReportCountersAsDeltas in interface SinkConfigOrBuilder
      Returns:
      The reportCountersAsDeltas.

    • getReportHistogramsAsDeltas

      public boolean getReportHistogramsAsDeltas()
       If set to true, histograms will be emitted as deltas, and the OTLP message will have
 ``AGGREGATION_TEMPORALITY_DELTA`` set as AggregationTemporality.
      bool report_histograms_as_deltas = 3;
      Specified by:
      getReportHistogramsAsDeltas in interface SinkConfigOrBuilder
      Returns:
      The reportHistogramsAsDeltas.

    • hasEmitTagsAsAttributes

      public boolean hasEmitTagsAsAttributes()
       If set to true, metrics will have their tags emitted as OTLP attributes, which may
 contain values used by the tag extractor or additional tags added during stats creation.
 Otherwise, no attributes will be associated with the export message. Default value is true.
      .google.protobuf.BoolValue emit_tags_as_attributes = 4;
      Specified by:
      hasEmitTagsAsAttributes in interface SinkConfigOrBuilder
      Returns:
      Whether the emitTagsAsAttributes field is set.

    • getEmitTagsAsAttributes

      public com.google.protobuf.BoolValue getEmitTagsAsAttributes()
       If set to true, metrics will have their tags emitted as OTLP attributes, which may
 contain values used by the tag extractor or additional tags added during stats creation.
 Otherwise, no attributes will be associated with the export message. Default value is true.
      .google.protobuf.BoolValue emit_tags_as_attributes = 4;
      Specified by:
      getEmitTagsAsAttributes in interface SinkConfigOrBuilder
      Returns:
      The emitTagsAsAttributes.

    • getEmitTagsAsAttributesOrBuilder

      public com.google.protobuf.BoolValueOrBuilder getEmitTagsAsAttributesOrBuilder()
       If set to true, metrics will have their tags emitted as OTLP attributes, which may
 contain values used by the tag extractor or additional tags added during stats creation.
 Otherwise, no attributes will be associated with the export message. Default value is true.
      .google.protobuf.BoolValue emit_tags_as_attributes = 4;
      Specified by:
      getEmitTagsAsAttributesOrBuilder in interface SinkConfigOrBuilder

    • hasUseTagExtractedName

      public boolean hasUseTagExtractedName()
       If set to true, metric names will be represented as the tag extracted name instead
 of the full metric name. Default value is true.
      .google.protobuf.BoolValue use_tag_extracted_name = 5;
      Specified by:
      hasUseTagExtractedName in interface SinkConfigOrBuilder
      Returns:
      Whether the useTagExtractedName field is set.

    • getUseTagExtractedName

      public com.google.protobuf.BoolValue getUseTagExtractedName()
       If set to true, metric names will be represented as the tag extracted name instead
 of the full metric name. Default value is true.
      .google.protobuf.BoolValue use_tag_extracted_name = 5;
      Specified by:
      getUseTagExtractedName in interface SinkConfigOrBuilder
      Returns:
      The useTagExtractedName.

    • getUseTagExtractedNameOrBuilder

      public com.google.protobuf.BoolValueOrBuilder getUseTagExtractedNameOrBuilder()
       If set to true, metric names will be represented as the tag extracted name instead
 of the full metric name. Default value is true.
      .google.protobuf.BoolValue use_tag_extracted_name = 5;
      Specified by:
      getUseTagExtractedNameOrBuilder in interface SinkConfigOrBuilder

    • getPrefix

      public String getPrefix()
       If set, emitted stats names will be prepended with a prefix, so full stat name will be
 <prefix>.<stats_name>. For example, if the stat name is "foo.bar" and prefix is
 "pre", the full stat name will be "pre.foo.bar". If this field is not set, there is no
 prefix added. According to the example, the full stat name will remain "foo.bar".
      string prefix = 6;
      Specified by:
      getPrefix in interface SinkConfigOrBuilder
      Returns:
      The prefix.

    • getPrefixBytes

      public com.google.protobuf.ByteString getPrefixBytes()
       If set, emitted stats names will be prepended with a prefix, so full stat name will be
 <prefix>.<stats_name>. For example, if the stat name is "foo.bar" and prefix is
 "pre", the full stat name will be "pre.foo.bar". If this field is not set, there is no
 prefix added. According to the example, the full stat name will remain "foo.bar".
      string prefix = 6;
      Specified by:
      getPrefixBytes in interface SinkConfigOrBuilder
      Returns:
      The bytes for prefix.

    • hasCustomMetricConversions

      public boolean hasCustomMetricConversions()
       The custom conversion from a stat to a metric. Currently, the only supported input is
 ``envoy.extensions.matching.common_inputs.stats.v3.StatFullNameMatchInput``.
 The supported actions are
 - ``envoy.extensions.stat_sinks.open_telemetry.v3.SinkConfig.DropAction``.
 - ``envoy.extensions.stat_sinks.open_telemetry.v3.SinkConfig.ConversionAction``.
 If stats are not matched, they will be directly converted to OTLP metrics as usual.
      .xds.type.matcher.v3.Matcher custom_metric_conversions = 8;
      Specified by:
      hasCustomMetricConversions in interface SinkConfigOrBuilder
      Returns:
      Whether the customMetricConversions field is set.

    • getCustomMetricConversions

      public Matcher getCustomMetricConversions()
       The custom conversion from a stat to a metric. Currently, the only supported input is
 ``envoy.extensions.matching.common_inputs.stats.v3.StatFullNameMatchInput``.
 The supported actions are
 - ``envoy.extensions.stat_sinks.open_telemetry.v3.SinkConfig.DropAction``.
 - ``envoy.extensions.stat_sinks.open_telemetry.v3.SinkConfig.ConversionAction``.
 If stats are not matched, they will be directly converted to OTLP metrics as usual.
      .xds.type.matcher.v3.Matcher custom_metric_conversions = 8;
      Specified by:
      getCustomMetricConversions in interface SinkConfigOrBuilder
      Returns:
      The customMetricConversions.

    • getCustomMetricConversionsOrBuilder

      public MatcherOrBuilder getCustomMetricConversionsOrBuilder()
       The custom conversion from a stat to a metric. Currently, the only supported input is
 ``envoy.extensions.matching.common_inputs.stats.v3.StatFullNameMatchInput``.
 The supported actions are
 - ``envoy.extensions.stat_sinks.open_telemetry.v3.SinkConfig.DropAction``.
 - ``envoy.extensions.stat_sinks.open_telemetry.v3.SinkConfig.ConversionAction``.
 If stats are not matched, they will be directly converted to OTLP metrics as usual.
      .xds.type.matcher.v3.Matcher custom_metric_conversions = 8;
      Specified by:
      getCustomMetricConversionsOrBuilder in interface SinkConfigOrBuilder

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static SinkConfig.Builder newBuilder()

    • newBuilder

      public static SinkConfig.Builder newBuilder(SinkConfig prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static SinkConfig getDefaultInstance()

    • parser

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

    • getParserForType

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