@ThreadSafe public final class OtlpGrpcMetricExporter extends Object implements io.opentelemetry.sdk.metrics.export.MetricExporter
Configuration options for OtlpGrpcMetricExporter can be read from system properties,
environment variables, or Properties objects.
For system properties and Properties objects, OtlpGrpcMetricExporter
will look for the following names:
otel.exporter.otlp.metric.timeout: to set the max waiting time allowed to send each
span batch.
otel.exporter.otlp.metric.endpoint: to set the endpoint to connect to.
otel.exporter.otlp.metric.insecure: whether to enable client transport security for
the connection.
otel.exporter.otlp.metric.headers: the headers associated with the requests.
For environment variables, OtlpGrpcMetricExporter will look for the following names:
OTEL_EXPORTER_OTLP_METRIC_TIMEOUT: to set the max waiting time allowed to send each
span batch.
OTEL_EXPORTER_OTLP_METRIC_ENDPOINT: to set the endpoint to connect to.
OTEL_EXPORTER_OTLP_METRIC_INSECURE: whether to enable client transport security for
the connection.
OTEL_EXPORTER_OTLP_METRIC_HEADERS: the headers associated with the requests.
In both cases, if a property is missing, the name without "span" is used to resolve the value.
| Modifier and Type | Class and Description |
|---|---|
static class |
OtlpGrpcMetricExporter.Builder
Builder utility for this exporter.
|
| Modifier and Type | Field and Description |
|---|---|
static long |
DEFAULT_DEADLINE_MS |
static String |
DEFAULT_ENDPOINT |
| Modifier and Type | Method and Description |
|---|---|
io.opentelemetry.sdk.common.CompletableResultCode |
export(Collection<io.opentelemetry.sdk.metrics.data.MetricData> metrics)
Submits all the given metrics in a single batch to the OpenTelemetry collector.
|
io.opentelemetry.sdk.common.CompletableResultCode |
flush()
The OTLP exporter does not batch metrics, so this method will immediately return with success.
|
static OtlpGrpcMetricExporter |
getDefault()
Returns a new
OtlpGrpcMetricExporter reading the configuration values from the
environment and from system properties. |
static OtlpGrpcMetricExporter.Builder |
newBuilder()
Returns a new builder instance for this exporter.
|
void |
shutdown()
Initiates an orderly shutdown in which preexisting calls continue but new calls are immediately
cancelled.
|
public static final String DEFAULT_ENDPOINT
public static final long DEFAULT_DEADLINE_MS
public io.opentelemetry.sdk.common.CompletableResultCode export(Collection<io.opentelemetry.sdk.metrics.data.MetricData> metrics)
export in interface io.opentelemetry.sdk.metrics.export.MetricExportermetrics - the list of Metrics to be exported.public io.opentelemetry.sdk.common.CompletableResultCode flush()
flush in interface io.opentelemetry.sdk.metrics.export.MetricExporterpublic static OtlpGrpcMetricExporter.Builder newBuilder()
public static OtlpGrpcMetricExporter getDefault()
OtlpGrpcMetricExporter reading the configuration values from the
environment and from system properties. System properties override values defined in the
environment. If a configuration value is missing, it uses the default value.OtlpGrpcMetricExporter instance.public void shutdown()
shutdown in interface io.opentelemetry.sdk.metrics.export.MetricExporter