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
,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 type
envoy.config.trace.v3.OpenTelemetryConfig
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final class
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>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage
com.google.protobuf.AbstractMessage.BuilderParent
Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate int
private static final OpenTelemetryConfig
static final int
private GrpcService
static final int
private HttpService
private byte
private static final com.google.protobuf.Parser
<OpenTelemetryConfig> static final int
private List
<TypedExtensionConfig> private TypedExtensionConfig
static final int
private static final long
static final int
private Object
Fields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders, unknownFields
Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize
Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprivate
private
OpenTelemetryConfig
(com.google.protobuf.GeneratedMessage.Builder<?> builder) -
Method Summary
Modifier and TypeMethodDescriptionboolean
static OpenTelemetryConfig
static final com.google.protobuf.Descriptors.Descriptor
The upstream gRPC cluster that will receive OTLP traces.The upstream gRPC cluster that will receive OTLP traces.The upstream HTTP cluster that will receive OTLP traces.The upstream HTTP cluster that will receive OTLP traces.com.google.protobuf.Parser
<OpenTelemetryConfig> getResourceDetectors
(int index) An ordered list of resource detectors [#extension-category: envoy.tracers.opentelemetry.resource_detectors]int
An ordered list of resource detectors [#extension-category: envoy.tracers.opentelemetry.resource_detectors]An ordered list of resource detectors [#extension-category: envoy.tracers.opentelemetry.resource_detectors]getResourceDetectorsOrBuilder
(int index) An ordered list of resource detectors [#extension-category: envoy.tracers.opentelemetry.resource_detectors]List
<? extends TypedExtensionConfigOrBuilder> An ordered list of resource detectors [#extension-category: envoy.tracers.opentelemetry.resource_detectors]Specifies the sampler to be used by the OpenTelemetry tracer.Specifies the sampler to be used by the OpenTelemetry tracer.int
The name for the service.com.google.protobuf.ByteString
The name for the service.boolean
The upstream gRPC cluster that will receive OTLP traces.int
hashCode()
boolean
The upstream HTTP cluster that will receive OTLP traces.boolean
Specifies the sampler to be used by the OpenTelemetry tracer.protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
final boolean
static OpenTelemetryConfig.Builder
static OpenTelemetryConfig.Builder
newBuilder
(OpenTelemetryConfig prototype) protected OpenTelemetryConfig.Builder
newBuilderForType
(com.google.protobuf.AbstractMessage.BuilderParent parent) static OpenTelemetryConfig
parseDelimitedFrom
(InputStream input) static OpenTelemetryConfig
parseDelimitedFrom
(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
(InputStream input) static OpenTelemetryConfig
parseFrom
(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static OpenTelemetryConfig
parseFrom
(ByteBuffer data) static OpenTelemetryConfig
parseFrom
(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser
<OpenTelemetryConfig> parser()
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
Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
bitField0_
private int bitField0_ -
GRPC_SERVICE_FIELD_NUMBER
public static final int GRPC_SERVICE_FIELD_NUMBER- See Also:
-
grpcService_
-
HTTP_SERVICE_FIELD_NUMBER
public static final int HTTP_SERVICE_FIELD_NUMBER- See Also:
-
httpService_
-
SERVICE_NAME_FIELD_NUMBER
public static final int SERVICE_NAME_FIELD_NUMBER- See Also:
-
serviceName_
-
RESOURCE_DETECTORS_FIELD_NUMBER
public static final int RESOURCE_DETECTORS_FIELD_NUMBER- See Also:
-
resourceDetectors_
-
SAMPLER_FIELD_NUMBER
public static final int SAMPLER_FIELD_NUMBER- See Also:
-
sampler_
-
memoizedIsInitialized
private byte memoizedIsInitialized -
DEFAULT_INSTANCE
-
PARSER
-
-
Constructor Details
-
OpenTelemetryConfig
private OpenTelemetryConfig(com.google.protobuf.GeneratedMessage.Builder<?> builder) -
OpenTelemetryConfig
private OpenTelemetryConfig()
-
-
Method Details
-
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
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
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
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
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
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
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
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
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
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
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
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
- Specified by:
writeTo
in interfacecom.google.protobuf.MessageLite
- Overrides:
writeTo
in classcom.google.protobuf.GeneratedMessage
- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSize
in interfacecom.google.protobuf.MessageLite
- Overrides:
getSerializedSize
in classcom.google.protobuf.GeneratedMessage
-
equals
- 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(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
- Throws:
IOException
-
parseFrom
public static OpenTelemetryConfig parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- 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
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.Message
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
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
-
parser
-
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
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-