Package io.envoyproxy.envoy.config.trace.v3

Class OpenTelemetryConfig

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.config.trace.v3.OpenTelemetryConfig
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, OpenTelemetryConfigOrBuilder, Serializable
public final class OpenTelemetryConfig extends com.google.protobuf.GeneratedMessageV3 implements OpenTelemetryConfigOrBuilder
 Configuration for the OpenTelemetry tracer.
  [#extension: envoy.tracers.opentelemetry]
 [#next-free-field: 7]
Protobuf type envoy.config.trace.v3.OpenTelemetryConfig
See Also:

  • Field Details

    • GRPC_SERVICE_FIELD_NUMBER

      public static final int GRPC_SERVICE_FIELD_NUMBER
      See Also:

    • HTTP_SERVICE_FIELD_NUMBER

      public static final int HTTP_SERVICE_FIELD_NUMBER
      See Also:

    • SERVICE_NAME_FIELD_NUMBER

      public static final int SERVICE_NAME_FIELD_NUMBER
      See Also:

    • RESOURCE_DETECTORS_FIELD_NUMBER

      public static final int RESOURCE_DETECTORS_FIELD_NUMBER
      See Also:

    • SAMPLER_FIELD_NUMBER

      public static final int SAMPLER_FIELD_NUMBER
      See Also:

    • MAX_CACHE_SIZE_FIELD_NUMBER

      public static final int MAX_CACHE_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 will receive OTLP traces.
 Note that the tracer drops traces if the server does not read data fast enough.
 This field can be left empty to disable reporting traces to the gRPC service.
 Only one of ``grpc_service``, ``http_service`` may be used.
      .envoy.config.core.v3.GrpcService grpc_service = 1 [(.udpa.annotations.field_migrate) = { ... }
      Specified by:
      hasGrpcService in interface OpenTelemetryConfigOrBuilder
      Returns:
      Whether the grpcService field is set.

    • getGrpcService

      public GrpcService getGrpcService()
       The upstream gRPC cluster that will receive OTLP traces.
 Note that the tracer drops traces if the server does not read data fast enough.
 This field can be left empty to disable reporting traces to the gRPC service.
 Only one of ``grpc_service``, ``http_service`` may be used.
      .envoy.config.core.v3.GrpcService grpc_service = 1 [(.udpa.annotations.field_migrate) = { ... }
      Specified by:
      getGrpcService in interface OpenTelemetryConfigOrBuilder
      Returns:
      The grpcService.

    • getGrpcServiceOrBuilder

      public GrpcServiceOrBuilder getGrpcServiceOrBuilder()
       The upstream gRPC cluster that will receive OTLP traces.
 Note that the tracer drops traces if the server does not read data fast enough.
 This field can be left empty to disable reporting traces to the gRPC service.
 Only one of ``grpc_service``, ``http_service`` may be used.
      .envoy.config.core.v3.GrpcService grpc_service = 1 [(.udpa.annotations.field_migrate) = { ... }
      Specified by:
      getGrpcServiceOrBuilder in interface OpenTelemetryConfigOrBuilder

    • hasHttpService

      public boolean hasHttpService()
       The upstream HTTP cluster that will receive OTLP traces.
 This field can be left empty to disable reporting traces to the HTTP service.
 Only one of ``grpc_service``, ``http_service`` may be used.

 .. note::

   Note: The ``request_headers_to_add`` property in the OTLP HTTP exporter service
   does not support the :ref:`format specifier <config_access_log_format>` as used for
   :ref:`HTTP access logging <config_access_log>`.
   The values configured are added as HTTP headers on the OTLP export request
   without any formatting applied.
      .envoy.config.core.v3.HttpService http_service = 3 [(.udpa.annotations.field_migrate) = { ... }
      Specified by:
      hasHttpService in interface OpenTelemetryConfigOrBuilder
      Returns:
      Whether the httpService field is set.

    • getHttpService

      public HttpService getHttpService()
       The upstream HTTP cluster that will receive OTLP traces.
 This field can be left empty to disable reporting traces to the HTTP service.
 Only one of ``grpc_service``, ``http_service`` may be used.

 .. note::

   Note: The ``request_headers_to_add`` property in the OTLP HTTP exporter service
   does not support the :ref:`format specifier <config_access_log_format>` as used for
   :ref:`HTTP access logging <config_access_log>`.
   The values configured are added as HTTP headers on the OTLP export request
   without any formatting applied.
      .envoy.config.core.v3.HttpService http_service = 3 [(.udpa.annotations.field_migrate) = { ... }
      Specified by:
      getHttpService in interface OpenTelemetryConfigOrBuilder
      Returns:
      The httpService.

    • getHttpServiceOrBuilder

      public HttpServiceOrBuilder getHttpServiceOrBuilder()
       The upstream HTTP cluster that will receive OTLP traces.
 This field can be left empty to disable reporting traces to the HTTP service.
 Only one of ``grpc_service``, ``http_service`` may be used.

 .. note::

   Note: The ``request_headers_to_add`` property in the OTLP HTTP exporter service
   does not support the :ref:`format specifier <config_access_log_format>` as used for
   :ref:`HTTP access logging <config_access_log>`.
   The values configured are added as HTTP headers on the OTLP export request
   without any formatting applied.
      .envoy.config.core.v3.HttpService http_service = 3 [(.udpa.annotations.field_migrate) = { ... }
      Specified by:
      getHttpServiceOrBuilder in interface OpenTelemetryConfigOrBuilder

    • getServiceName

      public String getServiceName()
       The name for the service. This will be populated in the ResourceSpan Resource attributes.
 If it is not provided, it will default to "unknown_service:envoy".
      string service_name = 2;
      Specified by:
      getServiceName in interface OpenTelemetryConfigOrBuilder
      Returns:
      The serviceName.

    • getServiceNameBytes

      public com.google.protobuf.ByteString getServiceNameBytes()
       The name for the service. This will be populated in the ResourceSpan Resource attributes.
 If it is not provided, it will default to "unknown_service:envoy".
      string service_name = 2;
      Specified by:
      getServiceNameBytes in interface OpenTelemetryConfigOrBuilder
      Returns:
      The bytes for serviceName.

    • getResourceDetectorsList

      public List<TypedExtensionConfig> getResourceDetectorsList()
       An ordered list of resource detectors
 [#extension-category: envoy.tracers.opentelemetry.resource_detectors]
      repeated .envoy.config.core.v3.TypedExtensionConfig resource_detectors = 4;
      Specified by:
      getResourceDetectorsList in interface OpenTelemetryConfigOrBuilder

    • getResourceDetectorsOrBuilderList

      public List<? extends TypedExtensionConfigOrBuilder> getResourceDetectorsOrBuilderList()
       An ordered list of resource detectors
 [#extension-category: envoy.tracers.opentelemetry.resource_detectors]
      repeated .envoy.config.core.v3.TypedExtensionConfig resource_detectors = 4;
      Specified by:
      getResourceDetectorsOrBuilderList in interface OpenTelemetryConfigOrBuilder

    • getResourceDetectorsCount

      public int getResourceDetectorsCount()
       An ordered list of resource detectors
 [#extension-category: envoy.tracers.opentelemetry.resource_detectors]
      repeated .envoy.config.core.v3.TypedExtensionConfig resource_detectors = 4;
      Specified by:
      getResourceDetectorsCount in interface OpenTelemetryConfigOrBuilder

    • getResourceDetectors

      public TypedExtensionConfig getResourceDetectors(int index)
       An ordered list of resource detectors
 [#extension-category: envoy.tracers.opentelemetry.resource_detectors]
      repeated .envoy.config.core.v3.TypedExtensionConfig resource_detectors = 4;
      Specified by:
      getResourceDetectors in interface OpenTelemetryConfigOrBuilder

    • getResourceDetectorsOrBuilder

      public TypedExtensionConfigOrBuilder getResourceDetectorsOrBuilder(int index)
       An ordered list of resource detectors
 [#extension-category: envoy.tracers.opentelemetry.resource_detectors]
      repeated .envoy.config.core.v3.TypedExtensionConfig resource_detectors = 4;
      Specified by:
      getResourceDetectorsOrBuilder in interface OpenTelemetryConfigOrBuilder

    • hasSampler

      public boolean hasSampler()
       Specifies the sampler to be used by the OpenTelemetry tracer.
 The configured sampler implements the Sampler interface defined by the OpenTelemetry specification.
 This field can be left empty. In this case, the default Envoy sampling decision is used.

 See: `OpenTelemetry sampler specification <https://opentelemetry.io/docs/specs/otel/trace/sdk/#sampler>`_
 [#extension-category: envoy.tracers.opentelemetry.samplers]
      .envoy.config.core.v3.TypedExtensionConfig sampler = 5;
      Specified by:
      hasSampler in interface OpenTelemetryConfigOrBuilder
      Returns:
      Whether the sampler field is set.

    • getSampler

      public TypedExtensionConfig getSampler()
       Specifies the sampler to be used by the OpenTelemetry tracer.
 The configured sampler implements the Sampler interface defined by the OpenTelemetry specification.
 This field can be left empty. In this case, the default Envoy sampling decision is used.

 See: `OpenTelemetry sampler specification <https://opentelemetry.io/docs/specs/otel/trace/sdk/#sampler>`_
 [#extension-category: envoy.tracers.opentelemetry.samplers]
      .envoy.config.core.v3.TypedExtensionConfig sampler = 5;
      Specified by:
      getSampler in interface OpenTelemetryConfigOrBuilder
      Returns:
      The sampler.

    • getSamplerOrBuilder

      public TypedExtensionConfigOrBuilder getSamplerOrBuilder()
       Specifies the sampler to be used by the OpenTelemetry tracer.
 The configured sampler implements the Sampler interface defined by the OpenTelemetry specification.
 This field can be left empty. In this case, the default Envoy sampling decision is used.

 See: `OpenTelemetry sampler specification <https://opentelemetry.io/docs/specs/otel/trace/sdk/#sampler>`_
 [#extension-category: envoy.tracers.opentelemetry.samplers]
      .envoy.config.core.v3.TypedExtensionConfig sampler = 5;
      Specified by:
      getSamplerOrBuilder in interface OpenTelemetryConfigOrBuilder

    • hasMaxCacheSize

      public boolean hasMaxCacheSize()
       Envoy caches the span in memory when the OpenTelemetry backend service is temporarily unavailable.
 This field specifies the maximum number of spans that can be cached. If not specified, the
 default is 1024.
      .google.protobuf.UInt32Value max_cache_size = 6;
      Specified by:
      hasMaxCacheSize in interface OpenTelemetryConfigOrBuilder
      Returns:
      Whether the maxCacheSize field is set.

    • getMaxCacheSize

      public com.google.protobuf.UInt32Value getMaxCacheSize()
       Envoy caches the span in memory when the OpenTelemetry backend service is temporarily unavailable.
 This field specifies the maximum number of spans that can be cached. If not specified, the
 default is 1024.
      .google.protobuf.UInt32Value max_cache_size = 6;
      Specified by:
      getMaxCacheSize in interface OpenTelemetryConfigOrBuilder
      Returns:
      The maxCacheSize.

    • getMaxCacheSizeOrBuilder

      public com.google.protobuf.UInt32ValueOrBuilder getMaxCacheSizeOrBuilder()
       Envoy caches the span in memory when the OpenTelemetry backend service is temporarily unavailable.
 This field specifies the maximum number of spans that can be cached. If not specified, the
 default is 1024.
      .google.protobuf.UInt32Value max_cache_size = 6;
      Specified by:
      getMaxCacheSizeOrBuilder in interface OpenTelemetryConfigOrBuilder

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static OpenTelemetryConfig.Builder newBuilder()

    • newBuilder

      public static OpenTelemetryConfig.Builder newBuilder(OpenTelemetryConfig prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static OpenTelemetryConfig getDefaultInstance()

    • parser

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

    • getParserForType

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