78 lines
4.4 KiB
Go
78 lines
4.4 KiB
Go
// Copyright The OpenTelemetry Authors
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
/*
|
|
Package otlptracegrpc provides an OTLP span exporter using gRPC.
|
|
By default the telemetry is sent to https://localhost:4317.
|
|
|
|
Exporter should be created using [New].
|
|
|
|
The environment variables described below can be used for configuration.
|
|
|
|
OTEL_EXPORTER_OTLP_ENDPOINT, OTEL_EXPORTER_OTLP_TRACES_ENDPOINT (default: "https://localhost:4317") -
|
|
target to which the exporter sends telemetry.
|
|
The target syntax is defined in https://github.com/grpc/grpc/blob/master/doc/naming.md.
|
|
The value must contain a host.
|
|
The value may additionally a port, a scheme, and a path.
|
|
The value accepts "http" and "https" scheme.
|
|
The value should not contain a query string or fragment.
|
|
OTEL_EXPORTER_OTLP_TRACES_ENDPOINT takes precedence over OTEL_EXPORTER_OTLP_ENDPOINT.
|
|
The configuration can be overridden by [WithEndpoint], [WithEndpointURL], [WithInsecure], and [WithGRPCConn] options.
|
|
|
|
OTEL_EXPORTER_OTLP_INSECURE, OTEL_EXPORTER_OTLP_TRACES_INSECURE (default: "false") -
|
|
setting "true" disables client transport security for the exporter's gRPC connection.
|
|
You can use this only when an endpoint is provided without the http or https scheme.
|
|
OTEL_EXPORTER_OTLP_ENDPOINT, OTEL_EXPORTER_OTLP_TRACES_ENDPOINT setting overrides
|
|
the scheme defined via OTEL_EXPORTER_OTLP_ENDPOINT, OTEL_EXPORTER_OTLP_TRACES_ENDPOINT.
|
|
OTEL_EXPORTER_OTLP_TRACES_INSECURE takes precedence over OTEL_EXPORTER_OTLP_INSECURE.
|
|
The configuration can be overridden by [WithInsecure], [WithGRPCConn] options.
|
|
|
|
OTEL_EXPORTER_OTLP_HEADERS, OTEL_EXPORTER_OTLP_TRACES_HEADERS (default: none) -
|
|
key-value pairs used as gRPC metadata associated with gRPC requests.
|
|
The value is expected to be represented in a format matching to the [W3C Baggage HTTP Header Content Format],
|
|
except that additional semi-colon delimited metadata is not supported.
|
|
Example value: "key1=value1,key2=value2".
|
|
OTEL_EXPORTER_OTLP_TRACES_HEADERS takes precedence over OTEL_EXPORTER_OTLP_HEADERS.
|
|
The configuration can be overridden by [WithHeaders] option.
|
|
|
|
OTEL_EXPORTER_OTLP_TIMEOUT, OTEL_EXPORTER_OTLP_TRACES_TIMEOUT (default: "10000") -
|
|
maximum time in milliseconds the OTLP exporter waits for each batch export.
|
|
OTEL_EXPORTER_OTLP_TRACES_TIMEOUT takes precedence over OTEL_EXPORTER_OTLP_TIMEOUT.
|
|
The configuration can be overridden by [WithTimeout] option.
|
|
|
|
OTEL_EXPORTER_OTLP_COMPRESSION, OTEL_EXPORTER_OTLP_TRACES_COMPRESSION (default: none) -
|
|
the gRPC compressor the exporter uses.
|
|
Supported value: "gzip".
|
|
OTEL_EXPORTER_OTLP_TRACES_COMPRESSION takes precedence over OTEL_EXPORTER_OTLP_COMPRESSION.
|
|
The configuration can be overridden by [WithCompressor], [WithGRPCConn] options.
|
|
|
|
OTEL_EXPORTER_OTLP_CERTIFICATE, OTEL_EXPORTER_OTLP_TRACES_CERTIFICATE (default: none) -
|
|
the filepath to the trusted certificate to use when verifying a server's TLS credentials.
|
|
OTEL_EXPORTER_OTLP_TRACES_CERTIFICATE takes precedence over OTEL_EXPORTER_OTLP_CERTIFICATE.
|
|
The configuration can be overridden by [WithTLSCredentials], [WithGRPCConn] options.
|
|
|
|
OTEL_EXPORTER_OTLP_CLIENT_CERTIFICATE, OTEL_EXPORTER_OTLP_TRACES_CLIENT_CERTIFICATE (default: none) -
|
|
the filepath to the client certificate/chain trust for clients private key to use in mTLS communication in PEM format.
|
|
OTEL_EXPORTER_OTLP_TRACES_CLIENT_CERTIFICATE takes precedence over OTEL_EXPORTER_OTLP_CLIENT_CERTIFICATE.
|
|
The configuration can be overridden by [WithTLSCredentials], [WithGRPCConn] options.
|
|
|
|
OTEL_EXPORTER_OTLP_CLIENT_KEY, OTEL_EXPORTER_OTLP_TRACES_CLIENT_KEY (default: none) -
|
|
the filepath to the clients private key to use in mTLS communication in PEM format.
|
|
OTEL_EXPORTER_OTLP_TRACES_CLIENT_KEY takes precedence over OTEL_EXPORTER_OTLP_CLIENT_KEY.
|
|
The configuration can be overridden by [WithTLSCredentials], [WithGRPCConn] option.
|
|
|
|
[W3C Baggage HTTP Header Content Format]: https://www.w3.org/TR/baggage/#header-content
|
|
*/
|
|
package otlptracegrpc // import "go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc"
|