Debian Codegraph @

exporters/otlp/otlplog/otlploggrpc/doc.go

raw
1 // Copyright The OpenTelemetry Authors
2 // SPDX-License-Identifier: Apache-2.0
3
4 /*
5 Package otlploggrpc provides an OTLP log exporter using gRPC. The exporter uses gRPC to
6 transport OTLP protobuf payloads.
7
8 All Exporters must be created with [New].
9
10 The environment variables described below can be used for configuration.
11
12 OTEL_EXPORTER_OTLP_ENDPOINT, OTEL_EXPORTER_OTLP_LOGS_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_LOGS_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_LOGS_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 scheme.
24 OTEL_EXPORTER_OTLP_LOGS_INSECURE takes precedence over OTEL_EXPORTER_OTLP_INSECURE.
25 The configuration can be overridden by [WithInsecure], [WithGRPCConn] options.
26
27 OTEL_EXPORTER_OTLP_HEADERS, OTEL_EXPORTER_OTLP_LOGS_HEADERS (default: none) -
28 key-value pairs used as gRPC metadata associated with gRPC requests.
29 The value is expected to be represented in a format matching the [W3C Baggage HTTP Header Content Format],
30 except that additional semi-colon delimited metadata is not supported.
31 Example value: "key1=value1,key2=value2".
32 OTEL_EXPORTER_OTLP_LOGS_HEADERS takes precedence over OTEL_EXPORTER_OTLP_HEADERS.
33 The configuration can be overridden by [WithHeaders] option.
34
35 OTEL_EXPORTER_OTLP_TIMEOUT, OTEL_EXPORTER_OTLP_LOGS_TIMEOUT (default: "10000") -
36 maximum time in milliseconds the OTLP exporter waits for each batch export.
37 OTEL_EXPORTER_OTLP_LOGS_TIMEOUT takes precedence over OTEL_EXPORTER_OTLP_TIMEOUT.
38 The configuration can be overridden by [WithTimeout] option.
39
40 OTEL_EXPORTER_OTLP_COMPRESSION, OTEL_EXPORTER_OTLP_LOGS_COMPRESSION (default: none) -
41 the gRPC compressor the exporter uses.
42 Supported value: "gzip".
43 OTEL_EXPORTER_OTLP_LOGS_COMPRESSION takes precedence over OTEL_EXPORTER_OTLP_COMPRESSION.
44 The configuration can be overridden by [WithCompressor], [WithGRPCConn] options.
45
46 OTEL_EXPORTER_OTLP_CERTIFICATE, OTEL_EXPORTER_OTLP_LOGS_CERTIFICATE (default: none) -
47 the filepath to the trusted certificate to use when verifying a server's TLS credentials.
48 OTEL_EXPORTER_OTLP_LOGS_CERTIFICATE takes precedence over OTEL_EXPORTER_OTLP_CERTIFICATE.
49 The configuration can be overridden by [WithTLSCredentials], [WithGRPCConn] options.
50
51 OTEL_EXPORTER_OTLP_CLIENT_CERTIFICATE, OTEL_EXPORTER_OTLP_LOGS_CLIENT_CERTIFICATE (default: none) -
52 the filepath to the client certificate/chain trust for client's private key to use in mTLS communication in PEM format.
53 OTEL_EXPORTER_OTLP_LOGS_CLIENT_CERTIFICATE takes precedence over OTEL_EXPORTER_OTLP_CLIENT_CERTIFICATE.
54 The configuration can be overridden by [WithTLSCredentials], [WithGRPCConn] options.
55
56 OTEL_EXPORTER_OTLP_CLIENT_KEY, OTEL_EXPORTER_OTLP_LOGS_CLIENT_KEY (default: none) -
57 the filepath to the client's private key to use in mTLS communication in PEM format.
58 OTEL_EXPORTER_OTLP_LOGS_CLIENT_KEY takes precedence over OTEL_EXPORTER_OTLP_CLIENT_KEY.
59 The configuration can be overridden by [WithTLSCredentials], [WithGRPCConn] option.
60
61 [W3C Baggage HTTP Header Content Format]: https://www.w3.org/TR/baggage/#header-content
62 */
63 package otlploggrpc // import "go.opentelemetry.io/otel/exporters/otlp/otlplog/otlploggrpc"