Class OpenTelemetryConfig
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite
-
- com.google.protobuf.AbstractMessage
-
- com.google.protobuf.GeneratedMessage
-
- 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
,java.io.Serializable
public final class OpenTelemetryConfig extends com.google.protobuf.GeneratedMessage implements OpenTelemetryConfigOrBuilder
Configuration for the OpenTelemetry tracer. [#extension: envoy.tracers.opentelemetry] [#next-free-field: 6]
Protobuf typeenvoy.config.trace.v3.OpenTelemetryConfig
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
OpenTelemetryConfig.Builder
Configuration for the OpenTelemetry tracer.-
Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage
com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends java.lang.Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter
-
-
Field Summary
Fields Modifier and Type Field Description private int
bitField0_
private static OpenTelemetryConfig
DEFAULT_INSTANCE
static int
GRPC_SERVICE_FIELD_NUMBER
private GrpcService
grpcService_
static int
HTTP_SERVICE_FIELD_NUMBER
private HttpService
httpService_
private byte
memoizedIsInitialized
private static com.google.protobuf.Parser<OpenTelemetryConfig>
PARSER
static int
RESOURCE_DETECTORS_FIELD_NUMBER
private java.util.List<TypedExtensionConfig>
resourceDetectors_
private TypedExtensionConfig
sampler_
static int
SAMPLER_FIELD_NUMBER
private static long
serialVersionUID
static int
SERVICE_NAME_FIELD_NUMBER
private java.lang.Object
serviceName_
-
Constructor Summary
Constructors Modifier Constructor Description private
OpenTelemetryConfig()
private
OpenTelemetryConfig(com.google.protobuf.GeneratedMessage.Builder<?> builder)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(java.lang.Object obj)
static OpenTelemetryConfig
getDefaultInstance()
OpenTelemetryConfig
getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor
getDescriptor()
GrpcService
getGrpcService()
The upstream gRPC cluster that will receive OTLP traces.GrpcServiceOrBuilder
getGrpcServiceOrBuilder()
The upstream gRPC cluster that will receive OTLP traces.HttpService
getHttpService()
The upstream HTTP cluster that will receive OTLP traces.HttpServiceOrBuilder
getHttpServiceOrBuilder()
The upstream HTTP cluster that will receive OTLP traces.com.google.protobuf.Parser<OpenTelemetryConfig>
getParserForType()
TypedExtensionConfig
getResourceDetectors(int index)
An ordered list of resource detectors [#extension-category: envoy.tracers.opentelemetry.resource_detectors]int
getResourceDetectorsCount()
An ordered list of resource detectors [#extension-category: envoy.tracers.opentelemetry.resource_detectors]java.util.List<TypedExtensionConfig>
getResourceDetectorsList()
An ordered list of resource detectors [#extension-category: envoy.tracers.opentelemetry.resource_detectors]TypedExtensionConfigOrBuilder
getResourceDetectorsOrBuilder(int index)
An ordered list of resource detectors [#extension-category: envoy.tracers.opentelemetry.resource_detectors]java.util.List<? extends TypedExtensionConfigOrBuilder>
getResourceDetectorsOrBuilderList()
An ordered list of resource detectors [#extension-category: envoy.tracers.opentelemetry.resource_detectors]TypedExtensionConfig
getSampler()
Specifies the sampler to be used by the OpenTelemetry tracer.TypedExtensionConfigOrBuilder
getSamplerOrBuilder()
Specifies the sampler to be used by the OpenTelemetry tracer.int
getSerializedSize()
java.lang.String
getServiceName()
The name for the service.com.google.protobuf.ByteString
getServiceNameBytes()
The name for the service.boolean
hasGrpcService()
The upstream gRPC cluster that will receive OTLP traces.int
hashCode()
boolean
hasHttpService()
The upstream HTTP cluster that will receive OTLP traces.boolean
hasSampler()
Specifies the sampler to be used by the OpenTelemetry tracer.protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
internalGetFieldAccessorTable()
boolean
isInitialized()
static OpenTelemetryConfig.Builder
newBuilder()
static OpenTelemetryConfig.Builder
newBuilder(OpenTelemetryConfig prototype)
OpenTelemetryConfig.Builder
newBuilderForType()
protected OpenTelemetryConfig.Builder
newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
static OpenTelemetryConfig
parseDelimitedFrom(java.io.InputStream input)
static OpenTelemetryConfig
parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static OpenTelemetryConfig
parseFrom(byte[] data)
static OpenTelemetryConfig
parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static OpenTelemetryConfig
parseFrom(com.google.protobuf.ByteString data)
static OpenTelemetryConfig
parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static OpenTelemetryConfig
parseFrom(com.google.protobuf.CodedInputStream input)
static OpenTelemetryConfig
parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static OpenTelemetryConfig
parseFrom(java.io.InputStream input)
static OpenTelemetryConfig
parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static OpenTelemetryConfig
parseFrom(java.nio.ByteBuffer data)
static OpenTelemetryConfig
parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<OpenTelemetryConfig>
parser()
OpenTelemetryConfig.Builder
toBuilder()
void
writeTo(com.google.protobuf.CodedOutputStream output)
-
Methods inherited from class com.google.protobuf.GeneratedMessage
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag
-
Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashFields, toString
-
Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
-
-
-
Field Detail
-
serialVersionUID
private static final long serialVersionUID
- See Also:
- Constant Field Values
-
bitField0_
private int bitField0_
-
GRPC_SERVICE_FIELD_NUMBER
public static final int GRPC_SERVICE_FIELD_NUMBER
- See Also:
- Constant Field Values
-
grpcService_
private GrpcService grpcService_
-
HTTP_SERVICE_FIELD_NUMBER
public static final int HTTP_SERVICE_FIELD_NUMBER
- See Also:
- Constant Field Values
-
httpService_
private HttpService httpService_
-
SERVICE_NAME_FIELD_NUMBER
public static final int SERVICE_NAME_FIELD_NUMBER
- See Also:
- Constant Field Values
-
serviceName_
private volatile java.lang.Object serviceName_
-
RESOURCE_DETECTORS_FIELD_NUMBER
public static final int RESOURCE_DETECTORS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
resourceDetectors_
private java.util.List<TypedExtensionConfig> resourceDetectors_
-
SAMPLER_FIELD_NUMBER
public static final int SAMPLER_FIELD_NUMBER
- See Also:
- Constant Field Values
-
sampler_
private TypedExtensionConfig sampler_
-
memoizedIsInitialized
private byte memoizedIsInitialized
-
DEFAULT_INSTANCE
private static final OpenTelemetryConfig DEFAULT_INSTANCE
-
PARSER
private static final com.google.protobuf.Parser<OpenTelemetryConfig> PARSER
-
-
Method Detail
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
- Specified by:
internalGetFieldAccessorTable
in classcom.google.protobuf.GeneratedMessage
-
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 interfaceOpenTelemetryConfigOrBuilder
- 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 interfaceOpenTelemetryConfigOrBuilder
- 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 interfaceOpenTelemetryConfigOrBuilder
-
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 interfaceOpenTelemetryConfigOrBuilder
- 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 interfaceOpenTelemetryConfigOrBuilder
- 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 interfaceOpenTelemetryConfigOrBuilder
-
getServiceName
public java.lang.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 interfaceOpenTelemetryConfigOrBuilder
- 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 interfaceOpenTelemetryConfigOrBuilder
- Returns:
- The bytes for serviceName.
-
getResourceDetectorsList
public java.util.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 interfaceOpenTelemetryConfigOrBuilder
-
getResourceDetectorsOrBuilderList
public java.util.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 interfaceOpenTelemetryConfigOrBuilder
-
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 interfaceOpenTelemetryConfigOrBuilder
-
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 interfaceOpenTelemetryConfigOrBuilder
-
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 interfaceOpenTelemetryConfigOrBuilder
-
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 interfaceOpenTelemetryConfigOrBuilder
- 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 interfaceOpenTelemetryConfigOrBuilder
- 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 interfaceOpenTelemetryConfigOrBuilder
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessage
-
writeTo
public void writeTo(com.google.protobuf.CodedOutputStream output) throws java.io.IOException
- Specified by:
writeTo
in interfacecom.google.protobuf.MessageLite
- Overrides:
writeTo
in classcom.google.protobuf.GeneratedMessage
- Throws:
java.io.IOException
-
getSerializedSize
public int getSerializedSize()
- Specified by:
getSerializedSize
in interfacecom.google.protobuf.MessageLite
- Overrides:
getSerializedSize
in classcom.google.protobuf.GeneratedMessage
-
equals
public boolean equals(java.lang.Object obj)
- Specified by:
equals
in interfacecom.google.protobuf.Message
- Overrides:
equals
in classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()
- Specified by:
hashCode
in interfacecom.google.protobuf.Message
- Overrides:
hashCode
in classcom.google.protobuf.AbstractMessage
-
parseFrom
public static OpenTelemetryConfig parseFrom(java.nio.ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static OpenTelemetryConfig parseFrom(java.nio.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(java.io.InputStream input) throws java.io.IOException
- Throws:
java.io.IOException
-
parseFrom
public static OpenTelemetryConfig parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
-
parseDelimitedFrom
public static OpenTelemetryConfig parseDelimitedFrom(java.io.InputStream input) throws java.io.IOException
- Throws:
java.io.IOException
-
parseDelimitedFrom
public static OpenTelemetryConfig parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
-
parseFrom
public static OpenTelemetryConfig parseFrom(com.google.protobuf.CodedInputStream input) throws java.io.IOException
- Throws:
java.io.IOException
-
parseFrom
public static OpenTelemetryConfig parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
-
newBuilderForType
public OpenTelemetryConfig.Builder newBuilderForType()
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.Message
- Specified by:
newBuilderForType
in interfacecom.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 interfacecom.google.protobuf.Message
- Specified by:
toBuilder
in interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected OpenTelemetryConfig.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
- Overrides:
newBuilderForType
in classcom.google.protobuf.AbstractMessage
-
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 interfacecom.google.protobuf.Message
- Specified by:
getParserForType
in interfacecom.google.protobuf.MessageLite
- Overrides:
getParserForType
in classcom.google.protobuf.GeneratedMessage
-
getDefaultInstanceForType
public OpenTelemetryConfig getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
-