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

Interface SinkConfigOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    SinkConfig, SinkConfig.Builder
    public interface SinkConfigOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      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.
      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.
      GrpcService getGrpcService()
      The upstream gRPC cluster that implements the OTLP/gRPC collector.
      GrpcServiceOrBuilder getGrpcServiceOrBuilder()
      The upstream gRPC cluster that implements the OTLP/gRPC collector.
      String getPrefix()
      If set, emitted stats names will be prepended with a prefix, so full stat name will be <prefix>.<stats_name>.
      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>.
      SinkConfig.ProtocolSpecifierCase getProtocolSpecifierCase()  
      boolean getReportCountersAsDeltas()
      If set to true, counters will be emitted as deltas, and the OTLP message will have ``AGGREGATION_TEMPORALITY_DELTA`` set as AggregationTemporality.
      boolean getReportHistogramsAsDeltas()
      If set to true, histograms will be emitted as deltas, and the OTLP message will have ``AGGREGATION_TEMPORALITY_DELTA`` set as AggregationTemporality.
      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.
      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.
      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.
      boolean hasGrpcService()
      The upstream gRPC cluster that implements the OTLP/gRPC collector.
      boolean hasUseTagExtractedName()
      If set to true, metric names will be represented as the tag extracted name instead of the full metric name.

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

      • hasGrpcService

        boolean hasGrpcService()
         The upstream gRPC cluster that implements the OTLP/gRPC collector.
        .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 implements the OTLP/gRPC collector.
        .envoy.config.core.v3.GrpcService grpc_service = 1 [(.validate.rules) = { ... }
        Returns:
        The grpcService.

      • getGrpcServiceOrBuilder

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

      • getReportCountersAsDeltas

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

      • getReportHistogramsAsDeltas

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

      • hasEmitTagsAsAttributes

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

      • getEmitTagsAsAttributes

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

      • getEmitTagsAsAttributesOrBuilder

        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;

      • hasUseTagExtractedName

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

      • getUseTagExtractedName

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

      • getUseTagExtractedNameOrBuilder

        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;

      • getPrefix

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

      • getPrefixBytes

        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;
        Returns:
        The bytes for prefix.