Debian Codegraph @

exporters/otlp/otlpmetric/otlpmetricgrpc/doc.go

raw
1 // Copyright The OpenTelemetry Authors
2 // SPDX-License-Identifier: Apache-2.0
3
4 /*
5 Package otlpmetricgrpc provides an OTLP metrics exporter using gRPC.
6 By default the telemetry is sent to https://localhost:4317.
7
8 Exporter should be created using [New] and used with a [metric.PeriodicReader].
9
10 The environment variables described below can be used for configuration.
11
12 OTEL_EXPORTER_OTLP_ENDPOINT, OTEL_EXPORTER_OTLP_METRICS_ENDPOINT (default: "https://localhost:4317") -
13 target to which the exporter sends telemetry.
14 The target syntax is defined in https://github.com/grpc/grpc/blob/master/doc/naming.md.
15 The value must contain a scheme ("http" or "https") and host.
16 The value may additionally contain a port, and a path.
17 The value should not contain a query string or fragment.
18 OTEL_EXPORTER_OTLP_METRICS_ENDPOINT takes precedence over OTEL_EXPORTER_OTLP_ENDPOINT.
19 The configuration can be overridden by [WithEndpoint], [WithEndpointURL], [WithInsecure], and [WithGRPCConn] options.
20
21 OTEL_EXPORTER_OTLP_INSECURE, OTEL_EXPORTER_OTLP_METRICS_INSECURE (default: "false") -
22 setting "true" disables client transport security for the exporter's gRPC connection.
23 You can use this only when an endpoint is provided without the http or https scheme.
24 OTEL_EXPORTER_OTLP_ENDPOINT, OTEL_EXPORTER_OTLP_METRICS_ENDPOINT setting overrides
25 the scheme defined via OTEL_EXPORTER_OTLP_ENDPOINT, OTEL_EXPORTER_OTLP_METRICS_ENDPOINT.
26 OTEL_EXPORTER_OTLP_METRICS_INSECURE takes precedence over OTEL_EXPORTER_OTLP_INSECURE.
27 The configuration can be overridden by [WithInsecure], [WithGRPCConn] options.
28
29 OTEL_EXPORTER_OTLP_HEADERS, OTEL_EXPORTER_OTLP_METRICS_HEADERS (default: none) -
30 key-value pairs used as gRPC metadata associated with gRPC requests.
31 The value is expected to be represented in a format matching the [W3C Baggage HTTP Header Content Format],
32 except that additional semi-colon delimited metadata is not supported.
33 Example value: "key1=value1,key2=value2".
34 OTEL_EXPORTER_OTLP_METRICS_HEADERS takes precedence over OTEL_EXPORTER_OTLP_HEADERS.
35 The configuration can be overridden by [WithHeaders] option.
36
37 OTEL_EXPORTER_OTLP_TIMEOUT, OTEL_EXPORTER_OTLP_METRICS_TIMEOUT (default: "10000") -
38 maximum time in milliseconds the OTLP exporter waits for each batch export.
39 OTEL_EXPORTER_OTLP_METRICS_TIMEOUT takes precedence over OTEL_EXPORTER_OTLP_TIMEOUT.
40 The configuration can be overridden by [WithTimeout] option.
41
42 OTEL_EXPORTER_OTLP_COMPRESSION, OTEL_EXPORTER_OTLP_METRICS_COMPRESSION (default: none) -
43 the gRPC compressor the exporter uses.
44 Supported value: "gzip".
45 OTEL_EXPORTER_OTLP_METRICS_COMPRESSION takes precedence over OTEL_EXPORTER_OTLP_COMPRESSION.
46 The configuration can be overridden by [WithCompressor], [WithGRPCConn] options.
47
48 OTEL_EXPORTER_OTLP_CERTIFICATE, OTEL_EXPORTER_OTLP_METRICS_CERTIFICATE (default: none) -
49 the filepath to the trusted certificate to use when verifying a server's TLS credentials.
50 OTEL_EXPORTER_OTLP_METRICS_CERTIFICATE takes precedence over OTEL_EXPORTER_OTLP_CERTIFICATE.
51 The configuration can be overridden by [WithTLSCredentials], [WithGRPCConn] options.
52
53 OTEL_EXPORTER_OTLP_CLIENT_CERTIFICATE, OTEL_EXPORTER_OTLP_METRICS_CLIENT_CERTIFICATE (default: none) -
54 the filepath to the client certificate/chain trust for client's private key to use in mTLS communication in PEM format.
55 OTEL_EXPORTER_OTLP_METRICS_CLIENT_CERTIFICATE takes precedence over OTEL_EXPORTER_OTLP_CLIENT_CERTIFICATE.
56 The configuration can be overridden by [WithTLSCredentials], [WithGRPCConn] options.
57
58 OTEL_EXPORTER_OTLP_CLIENT_KEY, OTEL_EXPORTER_OTLP_METRICS_CLIENT_KEY (default: none) -
59 the filepath to the client's private key to use in mTLS communication in PEM format.
60 OTEL_EXPORTER_OTLP_METRICS_CLIENT_KEY takes precedence over OTEL_EXPORTER_OTLP_CLIENT_KEY.
61 The configuration can be overridden by [WithTLSCredentials], [WithGRPCConn] option.
62
63 OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE (default: "cumulative") -
64 aggregation temporality to use on the basis of instrument kind. Supported values:
65 - "cumulative" - Cumulative aggregation temporality for all instrument kinds,
66 - "delta" - Delta aggregation temporality for Counter, Asynchronous Counter and Histogram instrument kinds;
67 Cumulative aggregation for UpDownCounter and Asynchronous UpDownCounter instrument kinds,
68 - "lowmemory" - Delta aggregation temporality for Synchronous Counter and Histogram instrument kinds;
69 Cumulative aggregation temporality for Synchronous UpDownCounter, Asynchronous Counter, and Asynchronous UpDownCounter instrument kinds.
70
71 The configuration can be overridden by [WithTemporalitySelector] option.
72
73 OTEL_EXPORTER_OTLP_METRICS_DEFAULT_HISTOGRAM_AGGREGATION (default: "explicit_bucket_histogram") -
74 default aggregation to use for histogram instruments. Supported values:
75 - "explicit_bucket_histogram" - [Explicit Bucket Histogram Aggregation],
76 - "base2_exponential_bucket_histogram" - [Base2 Exponential Bucket Histogram Aggregation].
77
78 The configuration can be overridden by [WithAggregationSelector] option.
79
80 [W3C Baggage HTTP Header Content Format]: https://www.w3.org/TR/baggage/#header-content
81 [Explicit Bucket Histogram Aggregation]: https://github.com/open-telemetry/opentelemetry-specification/blob/v1.26.0/specification/metrics/sdk.md#explicit-bucket-histogram-aggregation
82 [Base2 Exponential Bucket Histogram Aggregation]: https://github.com/open-telemetry/opentelemetry-specification/blob/v1.26.0/specification/metrics/sdk.md#base2-exponential-bucket-histogram-aggregation
83 */
84 package otlpmetricgrpc // import "go.opentelemetry.io/otel/exporters/otlp/otlpmetric/otlpmetricgrpc"