Interface OpenTelemetryConfigOrBuilder
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
OpenTelemetryConfig
,OpenTelemetryConfig.Builder
public interface OpenTelemetryConfigOrBuilder
extends com.google.protobuf.MessageOrBuilder
-
Method Summary
Modifier and TypeMethodDescriptionThe 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.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.The name for the service.com.google.protobuf.ByteString
The name for the service.boolean
The upstream gRPC cluster that will receive OTLP traces.boolean
The upstream HTTP cluster that will receive OTLP traces.boolean
Specifies the sampler to be used by the OpenTelemetry tracer.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 Details
-
hasGrpcService
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) = { ... }
- Returns:
- Whether the grpcService field is set.
-
getGrpcService
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) = { ... }
- Returns:
- The grpcService.
-
getGrpcServiceOrBuilder
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) = { ... }
-
hasHttpService
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) = { ... }
- Returns:
- Whether the httpService field is set.
-
getHttpService
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) = { ... }
- Returns:
- The httpService.
-
getHttpServiceOrBuilder
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) = { ... }
-
getServiceName
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;
- Returns:
- The serviceName.
-
getServiceNameBytes
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;
- Returns:
- The bytes for serviceName.
-
getResourceDetectorsList
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;
-
getResourceDetectors
An ordered list of resource detectors [#extension-category: envoy.tracers.opentelemetry.resource_detectors]
repeated .envoy.config.core.v3.TypedExtensionConfig resource_detectors = 4;
-
getResourceDetectorsCount
int getResourceDetectorsCount()An ordered list of resource detectors [#extension-category: envoy.tracers.opentelemetry.resource_detectors]
repeated .envoy.config.core.v3.TypedExtensionConfig resource_detectors = 4;
-
getResourceDetectorsOrBuilderList
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;
-
getResourceDetectorsOrBuilder
An ordered list of resource detectors [#extension-category: envoy.tracers.opentelemetry.resource_detectors]
repeated .envoy.config.core.v3.TypedExtensionConfig resource_detectors = 4;
-
hasSampler
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;
- Returns:
- Whether the sampler field is set.
-
getSampler
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;
- Returns:
- The sampler.
-
getSamplerOrBuilder
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;
-