structure saas with tools
This commit is contained in:
@@ -0,0 +1,721 @@
|
||||
# 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.
|
||||
|
||||
OTEL_SDK_DISABLED = "OTEL_SDK_DISABLED"
|
||||
"""
|
||||
.. envvar:: OTEL_SDK_DISABLED
|
||||
|
||||
The :envvar:`OTEL_SDK_DISABLED` environment variable disables the SDK for all signals
|
||||
Default: "false"
|
||||
"""
|
||||
|
||||
OTEL_RESOURCE_ATTRIBUTES = "OTEL_RESOURCE_ATTRIBUTES"
|
||||
"""
|
||||
.. envvar:: OTEL_RESOURCE_ATTRIBUTES
|
||||
|
||||
The :envvar:`OTEL_RESOURCE_ATTRIBUTES` environment variable allows resource
|
||||
attributes to be passed to the SDK at process invocation. The attributes from
|
||||
:envvar:`OTEL_RESOURCE_ATTRIBUTES` are merged with those passed to
|
||||
`Resource.create`, meaning :envvar:`OTEL_RESOURCE_ATTRIBUTES` takes *lower*
|
||||
priority. Attributes should be in the format ``key1=value1,key2=value2``.
|
||||
Additional details are available `in the specification
|
||||
<https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/resource/sdk.md#specifying-resource-information-via-an-environment-variable>`__.
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ OTEL_RESOURCE_ATTRIBUTES="service.name=shoppingcard,will_be_overridden=foo" python - <<EOF
|
||||
import pprint
|
||||
from opentelemetry.sdk.resources import Resource
|
||||
pprint.pprint(Resource.create({"will_be_overridden": "bar"}).attributes)
|
||||
EOF
|
||||
{'service.name': 'shoppingcard',
|
||||
'telemetry.sdk.language': 'python',
|
||||
'telemetry.sdk.name': 'opentelemetry',
|
||||
'telemetry.sdk.version': '0.13.dev0',
|
||||
'will_be_overridden': 'bar'}
|
||||
"""
|
||||
|
||||
OTEL_LOG_LEVEL = "OTEL_LOG_LEVEL"
|
||||
"""
|
||||
.. envvar:: OTEL_LOG_LEVEL
|
||||
|
||||
The :envvar:`OTEL_LOG_LEVEL` environment variable sets the log level used by the SDK logger
|
||||
Default: "info"
|
||||
"""
|
||||
|
||||
OTEL_TRACES_SAMPLER = "OTEL_TRACES_SAMPLER"
|
||||
"""
|
||||
.. envvar:: OTEL_TRACES_SAMPLER
|
||||
|
||||
The :envvar:`OTEL_TRACES_SAMPLER` environment variable sets the sampler to be used for traces.
|
||||
Sampling is a mechanism to control the noise introduced by OpenTelemetry by reducing the number
|
||||
of traces collected and sent to the backend
|
||||
Default: "parentbased_always_on"
|
||||
"""
|
||||
|
||||
OTEL_TRACES_SAMPLER_ARG = "OTEL_TRACES_SAMPLER_ARG"
|
||||
"""
|
||||
.. envvar:: OTEL_TRACES_SAMPLER_ARG
|
||||
|
||||
The :envvar:`OTEL_TRACES_SAMPLER_ARG` environment variable will only be used if OTEL_TRACES_SAMPLER is set.
|
||||
Each Sampler type defines its own expected input, if any.
|
||||
Invalid or unrecognized input is ignored,
|
||||
i.e. the SDK behaves as if OTEL_TRACES_SAMPLER_ARG is not set.
|
||||
"""
|
||||
|
||||
OTEL_BLRP_SCHEDULE_DELAY = "OTEL_BLRP_SCHEDULE_DELAY"
|
||||
"""
|
||||
.. envvar:: OTEL_BLRP_SCHEDULE_DELAY
|
||||
|
||||
The :envvar:`OTEL_BLRP_SCHEDULE_DELAY` represents the delay interval between two consecutive exports of the BatchLogRecordProcessor.
|
||||
Default: 5000
|
||||
"""
|
||||
|
||||
OTEL_BLRP_EXPORT_TIMEOUT = "OTEL_BLRP_EXPORT_TIMEOUT"
|
||||
"""
|
||||
.. envvar:: OTEL_BLRP_EXPORT_TIMEOUT
|
||||
|
||||
The :envvar:`OTEL_BLRP_EXPORT_TIMEOUT` represents the maximum allowed time to export data from the BatchLogRecordProcessor.
|
||||
Default: 30000
|
||||
"""
|
||||
|
||||
OTEL_BLRP_MAX_QUEUE_SIZE = "OTEL_BLRP_MAX_QUEUE_SIZE"
|
||||
"""
|
||||
.. envvar:: OTEL_BLRP_MAX_QUEUE_SIZE
|
||||
|
||||
The :envvar:`OTEL_BLRP_MAX_QUEUE_SIZE` represents the maximum queue size for the data export of the BatchLogRecordProcessor.
|
||||
Default: 2048
|
||||
"""
|
||||
|
||||
OTEL_BLRP_MAX_EXPORT_BATCH_SIZE = "OTEL_BLRP_MAX_EXPORT_BATCH_SIZE"
|
||||
"""
|
||||
.. envvar:: OTEL_BLRP_MAX_EXPORT_BATCH_SIZE
|
||||
|
||||
The :envvar:`OTEL_BLRP_MAX_EXPORT_BATCH_SIZE` represents the maximum batch size for the data export of the BatchLogRecordProcessor.
|
||||
Default: 512
|
||||
"""
|
||||
|
||||
OTEL_BSP_SCHEDULE_DELAY = "OTEL_BSP_SCHEDULE_DELAY"
|
||||
"""
|
||||
.. envvar:: OTEL_BSP_SCHEDULE_DELAY
|
||||
|
||||
The :envvar:`OTEL_BSP_SCHEDULE_DELAY` represents the delay interval between two consecutive exports of the BatchSpanProcessor.
|
||||
Default: 5000
|
||||
"""
|
||||
|
||||
OTEL_BSP_EXPORT_TIMEOUT = "OTEL_BSP_EXPORT_TIMEOUT"
|
||||
"""
|
||||
.. envvar:: OTEL_BSP_EXPORT_TIMEOUT
|
||||
|
||||
The :envvar:`OTEL_BSP_EXPORT_TIMEOUT` represents the maximum allowed time to export data from the BatchSpanProcessor.
|
||||
Default: 30000
|
||||
"""
|
||||
|
||||
OTEL_BSP_MAX_QUEUE_SIZE = "OTEL_BSP_MAX_QUEUE_SIZE"
|
||||
"""
|
||||
.. envvar:: OTEL_BSP_MAX_QUEUE_SIZE
|
||||
|
||||
The :envvar:`OTEL_BSP_MAX_QUEUE_SIZE` represents the maximum queue size for the data export of the BatchSpanProcessor.
|
||||
Default: 2048
|
||||
"""
|
||||
|
||||
OTEL_BSP_MAX_EXPORT_BATCH_SIZE = "OTEL_BSP_MAX_EXPORT_BATCH_SIZE"
|
||||
"""
|
||||
.. envvar:: OTEL_BSP_MAX_EXPORT_BATCH_SIZE
|
||||
|
||||
The :envvar:`OTEL_BSP_MAX_EXPORT_BATCH_SIZE` represents the maximum batch size for the data export of the BatchSpanProcessor.
|
||||
Default: 512
|
||||
"""
|
||||
|
||||
OTEL_ATTRIBUTE_COUNT_LIMIT = "OTEL_ATTRIBUTE_COUNT_LIMIT"
|
||||
"""
|
||||
.. envvar:: OTEL_ATTRIBUTE_COUNT_LIMIT
|
||||
|
||||
The :envvar:`OTEL_ATTRIBUTE_COUNT_LIMIT` represents the maximum allowed attribute count for spans, events and links.
|
||||
This limit is overridden by model specific limits such as OTEL_SPAN_ATTRIBUTE_COUNT_LIMIT.
|
||||
Default: 128
|
||||
"""
|
||||
|
||||
OTEL_ATTRIBUTE_VALUE_LENGTH_LIMIT = "OTEL_ATTRIBUTE_VALUE_LENGTH_LIMIT"
|
||||
"""
|
||||
.. envvar:: OTEL_ATTRIBUTE_VALUE_LENGTH_LIMIT
|
||||
|
||||
The :envvar:`OTEL_ATTRIBUTE_VALUE_LENGTH_LIMIT` represents the maximum allowed attribute length.
|
||||
"""
|
||||
|
||||
OTEL_EVENT_ATTRIBUTE_COUNT_LIMIT = "OTEL_EVENT_ATTRIBUTE_COUNT_LIMIT"
|
||||
"""
|
||||
.. envvar:: OTEL_EVENT_ATTRIBUTE_COUNT_LIMIT
|
||||
|
||||
The :envvar:`OTEL_EVENT_ATTRIBUTE_COUNT_LIMIT` represents the maximum allowed event attribute count.
|
||||
Default: 128
|
||||
"""
|
||||
|
||||
OTEL_LINK_ATTRIBUTE_COUNT_LIMIT = "OTEL_LINK_ATTRIBUTE_COUNT_LIMIT"
|
||||
"""
|
||||
.. envvar:: OTEL_LINK_ATTRIBUTE_COUNT_LIMIT
|
||||
|
||||
The :envvar:`OTEL_LINK_ATTRIBUTE_COUNT_LIMIT` represents the maximum allowed link attribute count.
|
||||
Default: 128
|
||||
"""
|
||||
|
||||
OTEL_SPAN_ATTRIBUTE_COUNT_LIMIT = "OTEL_SPAN_ATTRIBUTE_COUNT_LIMIT"
|
||||
"""
|
||||
.. envvar:: OTEL_SPAN_ATTRIBUTE_COUNT_LIMIT
|
||||
|
||||
The :envvar:`OTEL_SPAN_ATTRIBUTE_COUNT_LIMIT` represents the maximum allowed span attribute count.
|
||||
Default: 128
|
||||
"""
|
||||
|
||||
OTEL_SPAN_ATTRIBUTE_VALUE_LENGTH_LIMIT = (
|
||||
"OTEL_SPAN_ATTRIBUTE_VALUE_LENGTH_LIMIT"
|
||||
)
|
||||
"""
|
||||
.. envvar:: OTEL_SPAN_ATTRIBUTE_VALUE_LENGTH_LIMIT
|
||||
|
||||
The :envvar:`OTEL_SPAN_ATTRIBUTE_VALUE_LENGTH_LIMIT` represents the maximum allowed length
|
||||
span attribute values can have. This takes precedence over :envvar:`OTEL_ATTRIBUTE_VALUE_LENGTH_LIMIT`.
|
||||
"""
|
||||
|
||||
OTEL_SPAN_EVENT_COUNT_LIMIT = "OTEL_SPAN_EVENT_COUNT_LIMIT"
|
||||
"""
|
||||
.. envvar:: OTEL_SPAN_EVENT_COUNT_LIMIT
|
||||
|
||||
The :envvar:`OTEL_SPAN_EVENT_COUNT_LIMIT` represents the maximum allowed span event count.
|
||||
Default: 128
|
||||
"""
|
||||
|
||||
OTEL_SPAN_LINK_COUNT_LIMIT = "OTEL_SPAN_LINK_COUNT_LIMIT"
|
||||
"""
|
||||
.. envvar:: OTEL_SPAN_LINK_COUNT_LIMIT
|
||||
|
||||
The :envvar:`OTEL_SPAN_LINK_COUNT_LIMIT` represents the maximum allowed span link count.
|
||||
Default: 128
|
||||
"""
|
||||
|
||||
OTEL_EXPORTER_JAEGER_AGENT_HOST = "OTEL_EXPORTER_JAEGER_AGENT_HOST"
|
||||
"""
|
||||
.. envvar:: OTEL_EXPORTER_JAEGER_AGENT_HOST
|
||||
|
||||
The :envvar:`OTEL_EXPORTER_JAEGER_AGENT_HOST` represents the hostname for the Jaeger agent.
|
||||
Default: "localhost"
|
||||
"""
|
||||
|
||||
OTEL_EXPORTER_JAEGER_AGENT_PORT = "OTEL_EXPORTER_JAEGER_AGENT_PORT"
|
||||
"""
|
||||
.. envvar:: OTEL_EXPORTER_JAEGER_AGENT_PORT
|
||||
|
||||
The :envvar:`OTEL_EXPORTER_JAEGER_AGENT_PORT` represents the port for the Jaeger agent.
|
||||
Default: 6831
|
||||
"""
|
||||
|
||||
OTEL_EXPORTER_JAEGER_ENDPOINT = "OTEL_EXPORTER_JAEGER_ENDPOINT"
|
||||
"""
|
||||
.. envvar:: OTEL_EXPORTER_JAEGER_ENDPOINT
|
||||
|
||||
The :envvar:`OTEL_EXPORTER_JAEGER_ENDPOINT` represents the HTTP endpoint for Jaeger traces.
|
||||
Default: "http://localhost:14250"
|
||||
"""
|
||||
|
||||
OTEL_EXPORTER_JAEGER_USER = "OTEL_EXPORTER_JAEGER_USER"
|
||||
"""
|
||||
.. envvar:: OTEL_EXPORTER_JAEGER_USER
|
||||
|
||||
The :envvar:`OTEL_EXPORTER_JAEGER_USER` represents the username to be used for HTTP basic authentication.
|
||||
"""
|
||||
|
||||
OTEL_EXPORTER_JAEGER_PASSWORD = "OTEL_EXPORTER_JAEGER_PASSWORD"
|
||||
"""
|
||||
.. envvar:: OTEL_EXPORTER_JAEGER_PASSWORD
|
||||
|
||||
The :envvar:`OTEL_EXPORTER_JAEGER_PASSWORD` represents the password to be used for HTTP basic authentication.
|
||||
"""
|
||||
|
||||
OTEL_EXPORTER_JAEGER_TIMEOUT = "OTEL_EXPORTER_JAEGER_TIMEOUT"
|
||||
"""
|
||||
.. envvar:: OTEL_EXPORTER_JAEGER_TIMEOUT
|
||||
|
||||
Maximum time the Jaeger exporter will wait for each batch export.
|
||||
Default: 10
|
||||
"""
|
||||
|
||||
OTEL_EXPORTER_ZIPKIN_ENDPOINT = "OTEL_EXPORTER_ZIPKIN_ENDPOINT"
|
||||
"""
|
||||
.. envvar:: OTEL_EXPORTER_ZIPKIN_ENDPOINT
|
||||
|
||||
Zipkin collector endpoint to which the exporter will send data. This may
|
||||
include a path (e.g. ``http://example.com:9411/api/v2/spans``).
|
||||
"""
|
||||
|
||||
OTEL_EXPORTER_ZIPKIN_TIMEOUT = "OTEL_EXPORTER_ZIPKIN_TIMEOUT"
|
||||
"""
|
||||
.. envvar:: OTEL_EXPORTER_ZIPKIN_TIMEOUT
|
||||
|
||||
Maximum time (in seconds) the Zipkin exporter will wait for each batch export.
|
||||
Default: 10
|
||||
"""
|
||||
|
||||
OTEL_EXPORTER_OTLP_PROTOCOL = "OTEL_EXPORTER_OTLP_PROTOCOL"
|
||||
"""
|
||||
.. envvar:: OTEL_EXPORTER_OTLP_PROTOCOL
|
||||
|
||||
The :envvar:`OTEL_EXPORTER_OTLP_PROTOCOL` represents the transport protocol for the
|
||||
OTLP exporter.
|
||||
"""
|
||||
|
||||
OTEL_EXPORTER_OTLP_TRACES_PROTOCOL = "OTEL_EXPORTER_OTLP_TRACES_PROTOCOL"
|
||||
"""
|
||||
.. envvar:: OTEL_EXPORTER_OTLP_TRACES_PROTOCOL
|
||||
|
||||
The :envvar:`OTEL_EXPORTER_OTLP_TRACES_PROTOCOL` represents the transport protocol for spans.
|
||||
"""
|
||||
|
||||
OTEL_EXPORTER_OTLP_METRICS_PROTOCOL = "OTEL_EXPORTER_OTLP_METRICS_PROTOCOL"
|
||||
"""
|
||||
.. envvar:: OTEL_EXPORTER_OTLP_METRICS_PROTOCOL
|
||||
|
||||
The :envvar:`OTEL_EXPORTER_OTLP_METRICS_PROTOCOL` represents the transport protocol for metrics.
|
||||
"""
|
||||
|
||||
OTEL_EXPORTER_OTLP_LOGS_PROTOCOL = "OTEL_EXPORTER_OTLP_LOGS_PROTOCOL"
|
||||
"""
|
||||
.. envvar:: OTEL_EXPORTER_OTLP_LOGS_PROTOCOL
|
||||
|
||||
The :envvar:`OTEL_EXPORTER_OTLP_LOGS_PROTOCOL` represents the transport protocol for logs.
|
||||
"""
|
||||
|
||||
OTEL_EXPORTER_OTLP_CERTIFICATE = "OTEL_EXPORTER_OTLP_CERTIFICATE"
|
||||
"""
|
||||
.. envvar:: OTEL_EXPORTER_OTLP_CERTIFICATE
|
||||
|
||||
The :envvar:`OTEL_EXPORTER_OTLP_CERTIFICATE` stores the path to the certificate file for
|
||||
TLS credentials of gRPC client. Should only be used for a secure connection.
|
||||
"""
|
||||
|
||||
OTEL_EXPORTER_OTLP_HEADERS = "OTEL_EXPORTER_OTLP_HEADERS"
|
||||
"""
|
||||
.. envvar:: OTEL_EXPORTER_OTLP_HEADERS
|
||||
|
||||
The :envvar:`OTEL_EXPORTER_OTLP_HEADERS` contains the key-value pairs to be used as headers
|
||||
associated with gRPC or HTTP requests.
|
||||
"""
|
||||
|
||||
|
||||
OTEL_EXPORTER_OTLP_COMPRESSION = "OTEL_EXPORTER_OTLP_COMPRESSION"
|
||||
"""
|
||||
.. envvar:: OTEL_EXPORTER_OTLP_COMPRESSION
|
||||
|
||||
Specifies a gRPC compression method to be used in the OTLP exporters.
|
||||
Possible values are:
|
||||
|
||||
- ``gzip`` corresponding to `grpc.Compression.Gzip`.
|
||||
- ``deflate`` corresponding to `grpc.Compression.Deflate`.
|
||||
|
||||
If no ``OTEL_EXPORTER_OTLP_*COMPRESSION`` environment variable is present or
|
||||
``compression`` argument passed to the exporter, the default
|
||||
`grpc.Compression.NoCompression` will be used. Additional details are
|
||||
available `in the specification
|
||||
<https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/exporter.md#opentelemetry-protocol-exporter>`__.
|
||||
"""
|
||||
|
||||
OTEL_EXPORTER_OTLP_TIMEOUT = "OTEL_EXPORTER_OTLP_TIMEOUT"
|
||||
"""
|
||||
.. envvar:: OTEL_EXPORTER_OTLP_TIMEOUT
|
||||
|
||||
The :envvar:`OTEL_EXPORTER_OTLP_TIMEOUT` is the maximum time the OTLP exporter will wait for each batch export.
|
||||
Default: 10
|
||||
"""
|
||||
|
||||
OTEL_EXPORTER_OTLP_ENDPOINT = "OTEL_EXPORTER_OTLP_ENDPOINT"
|
||||
"""
|
||||
.. envvar:: OTEL_EXPORTER_OTLP_ENDPOINT
|
||||
|
||||
The :envvar:`OTEL_EXPORTER_OTLP_ENDPOINT` target to which the exporter is going to send spans or metrics.
|
||||
The endpoint MUST be a valid URL host, and MAY contain a scheme (http or https), port and path.
|
||||
A scheme of https indicates a secure connection and takes precedence over the insecure configuration setting.
|
||||
Default: "http://localhost:4317"
|
||||
"""
|
||||
|
||||
OTEL_EXPORTER_OTLP_INSECURE = "OTEL_EXPORTER_OTLP_INSECURE"
|
||||
"""
|
||||
.. envvar:: OTEL_EXPORTER_OTLP_INSECURE
|
||||
|
||||
The :envvar:`OTEL_EXPORTER_OTLP_INSECURE` represents whether to enable client transport security for gRPC requests.
|
||||
A scheme of https takes precedence over this configuration setting.
|
||||
Default: False
|
||||
"""
|
||||
|
||||
OTEL_EXPORTER_OTLP_TRACES_INSECURE = "OTEL_EXPORTER_OTLP_TRACES_INSECURE"
|
||||
"""
|
||||
.. envvar:: OTEL_EXPORTER_OTLP_TRACES_INSECURE
|
||||
|
||||
The :envvar:`OTEL_EXPORTER_OTLP_TRACES_INSECURE` represents whether to enable client transport security
|
||||
for gRPC requests for spans. A scheme of https takes precedence over the this configuration setting.
|
||||
Default: False
|
||||
"""
|
||||
|
||||
|
||||
OTEL_EXPORTER_OTLP_TRACES_ENDPOINT = "OTEL_EXPORTER_OTLP_TRACES_ENDPOINT"
|
||||
"""
|
||||
.. envvar:: OTEL_EXPORTER_OTLP_TRACES_ENDPOINT
|
||||
|
||||
The :envvar:`OTEL_EXPORTER_OTLP_TRACES_ENDPOINT` target to which the span exporter is going to send spans.
|
||||
The endpoint MUST be a valid URL host, and MAY contain a scheme (http or https), port and path.
|
||||
A scheme of https indicates a secure connection and takes precedence over this configuration setting.
|
||||
"""
|
||||
|
||||
OTEL_EXPORTER_OTLP_METRICS_ENDPOINT = "OTEL_EXPORTER_OTLP_METRICS_ENDPOINT"
|
||||
"""
|
||||
.. envvar:: OTEL_EXPORTER_OTLP_METRICS_ENDPOINT
|
||||
|
||||
The :envvar:`OTEL_EXPORTER_OTLP_METRICS_ENDPOINT` target to which the metrics exporter is going to send metrics.
|
||||
The endpoint MUST be a valid URL host, and MAY contain a scheme (http or https), port and path.
|
||||
A scheme of https indicates a secure connection and takes precedence over this configuration setting.
|
||||
"""
|
||||
|
||||
OTEL_EXPORTER_OTLP_LOGS_ENDPOINT = "OTEL_EXPORTER_OTLP_LOGS_ENDPOINT"
|
||||
"""
|
||||
.. envvar:: OTEL_EXPORTER_OTLP_LOGS_ENDPOINT
|
||||
|
||||
The :envvar:`OTEL_EXPORTER_OTLP_LOGS_ENDPOINT` target to which the log exporter is going to send logs.
|
||||
The endpoint MUST be a valid URL host, and MAY contain a scheme (http or https), port and path.
|
||||
A scheme of https indicates a secure connection and takes precedence over this configuration setting.
|
||||
"""
|
||||
|
||||
OTEL_EXPORTER_OTLP_TRACES_CERTIFICATE = "OTEL_EXPORTER_OTLP_TRACES_CERTIFICATE"
|
||||
"""
|
||||
.. envvar:: OTEL_EXPORTER_OTLP_TRACES_CERTIFICATE
|
||||
|
||||
The :envvar:`OTEL_EXPORTER_OTLP_TRACES_CERTIFICATE` stores the path to the certificate file for
|
||||
TLS credentials of gRPC client for traces. Should only be used for a secure connection for tracing.
|
||||
"""
|
||||
|
||||
OTEL_EXPORTER_OTLP_METRICS_CERTIFICATE = (
|
||||
"OTEL_EXPORTER_OTLP_METRICS_CERTIFICATE"
|
||||
)
|
||||
"""
|
||||
.. envvar:: OTEL_EXPORTER_OTLP_METRICS_CERTIFICATE
|
||||
|
||||
The :envvar:`OTEL_EXPORTER_OTLP_METRICS_CERTIFICATE` stores the path to the certificate file for
|
||||
TLS credentials of gRPC client for metrics. Should only be used for a secure connection for exporting metrics.
|
||||
"""
|
||||
|
||||
OTEL_EXPORTER_OTLP_CLIENT_KEY = "OTEL_EXPORTER_OTLP_CLIENT_KEY"
|
||||
"""
|
||||
.. envvar:: OTEL_EXPORTER_OTLP_CLIENT_KEY
|
||||
|
||||
The :envvar:`OTEL_EXPORTER_OTLP_CLIENT_KEY` stores the path to the client private key to use
|
||||
in mTLS communication in PEM format.
|
||||
"""
|
||||
|
||||
OTEL_EXPORTER_OTLP_TRACES_CLIENT_KEY = "OTEL_EXPORTER_OTLP_TRACES_CLIENT_KEY"
|
||||
"""
|
||||
.. envvar:: OTEL_EXPORTER_OTLP_TRACES_CLIENT_KEY
|
||||
|
||||
The :envvar:`OTEL_EXPORTER_OTLP_TRACES_CLIENT_KEY` stores the path to the client private key to use
|
||||
in mTLS communication in PEM format for traces.
|
||||
"""
|
||||
|
||||
OTEL_EXPORTER_OTLP_METRICS_CLIENT_KEY = "OTEL_EXPORTER_OTLP_METRICS_CLIENT_KEY"
|
||||
"""
|
||||
.. envvar:: OTEL_EXPORTER_OTLP_METRICS_CLIENT_KEY
|
||||
|
||||
The :envvar:`OTEL_EXPORTER_OTLP_METRICS_CLIENT_KEY` stores the path to the client private key to use
|
||||
in mTLS communication in PEM format for metrics.
|
||||
"""
|
||||
|
||||
OTEL_EXPORTER_OTLP_LOGS_CLIENT_KEY = "OTEL_EXPORTER_OTLP_LOGS_CLIENT_KEY"
|
||||
"""
|
||||
.. envvar:: OTEL_EXPORTER_OTLP_LOGS_CLIENT_KEY
|
||||
|
||||
The :envvar:`OTEL_EXPORTER_OTLP_LOGS_CLIENT_KEY` stores the path to the client private key to use
|
||||
in mTLS communication in PEM format for logs.
|
||||
"""
|
||||
|
||||
OTEL_EXPORTER_OTLP_CLIENT_CERTIFICATE = "OTEL_EXPORTER_OTLP_CLIENT_CERTIFICATE"
|
||||
"""
|
||||
.. envvar:: OTEL_EXPORTER_OTLP_CLIENT_CERTIFICATE
|
||||
|
||||
The :envvar:`OTEL_EXPORTER_OTLP_CLIENT_CERTIFICATE` stores the path to the client certificate/chain trust for
|
||||
clients private key to use in mTLS communication in PEM format.
|
||||
"""
|
||||
|
||||
OTEL_EXPORTER_OTLP_TRACES_CLIENT_CERTIFICATE = (
|
||||
"OTEL_EXPORTER_OTLP_TRACES_CLIENT_CERTIFICATE"
|
||||
)
|
||||
"""
|
||||
.. envvar:: OTEL_EXPORTER_OTLP_TRACES_CLIENT_CERTIFICATE
|
||||
|
||||
The :envvar:`OTEL_EXPORTER_OTLP_TRACES_CLIENT_CERTIFICATE` stores the path to the client certificate/chain trust for
|
||||
clients private key to use in mTLS communication in PEM format for traces.
|
||||
"""
|
||||
|
||||
OTEL_EXPORTER_OTLP_METRICS_CLIENT_CERTIFICATE = (
|
||||
"OTEL_EXPORTER_OTLP_METRICS_CLIENT_CERTIFICATE"
|
||||
)
|
||||
"""
|
||||
.. envvar:: OTEL_EXPORTER_OTLP_METRICS_CLIENT_CERTIFICATE
|
||||
|
||||
The :envvar:`OTEL_EXPORTER_OTLP_METRICS_CLIENT_CERTIFICATE` stores the path to the client certificate/chain trust for
|
||||
clients private key to use in mTLS communication in PEM format for metrics.
|
||||
"""
|
||||
|
||||
OTEL_EXPORTER_OTLP_LOGS_CLIENT_CERTIFICATE = (
|
||||
"OTEL_EXPORTER_OTLP_LOGS_CLIENT_CERTIFICATE"
|
||||
)
|
||||
"""
|
||||
.. envvar:: OTEL_EXPORTER_OTLP_LOGS_CLIENT_CERTIFICATE
|
||||
|
||||
The :envvar:`OTEL_EXPORTER_OTLP_LOGS_CLIENT_CERTIFICATE` stores the path to the client certificate/chain trust for
|
||||
clients private key to use in mTLS communication in PEM format for logs.
|
||||
"""
|
||||
|
||||
OTEL_EXPORTER_OTLP_TRACES_HEADERS = "OTEL_EXPORTER_OTLP_TRACES_HEADERS"
|
||||
"""
|
||||
.. envvar:: OTEL_EXPORTER_OTLP_TRACES_HEADERS
|
||||
|
||||
The :envvar:`OTEL_EXPORTER_OTLP_TRACES_HEADERS` contains the key-value pairs to be used as headers for spans
|
||||
associated with gRPC or HTTP requests.
|
||||
"""
|
||||
|
||||
OTEL_EXPORTER_OTLP_METRICS_HEADERS = "OTEL_EXPORTER_OTLP_METRICS_HEADERS"
|
||||
"""
|
||||
.. envvar:: OTEL_EXPORTER_OTLP_METRICS_HEADERS
|
||||
|
||||
The :envvar:`OTEL_EXPORTER_OTLP_METRICS_HEADERS` contains the key-value pairs to be used as headers for metrics
|
||||
associated with gRPC or HTTP requests.
|
||||
"""
|
||||
|
||||
OTEL_EXPORTER_OTLP_LOGS_HEADERS = "OTEL_EXPORTER_OTLP_LOGS_HEADERS"
|
||||
"""
|
||||
.. envvar:: OTEL_EXPORTER_OTLP_LOGS_HEADERS
|
||||
|
||||
The :envvar:`OTEL_EXPORTER_OTLP_LOGS_HEADERS` contains the key-value pairs to be used as headers for logs
|
||||
associated with gRPC or HTTP requests.
|
||||
"""
|
||||
|
||||
OTEL_EXPORTER_OTLP_TRACES_COMPRESSION = "OTEL_EXPORTER_OTLP_TRACES_COMPRESSION"
|
||||
"""
|
||||
.. envvar:: OTEL_EXPORTER_OTLP_TRACES_COMPRESSION
|
||||
|
||||
Same as :envvar:`OTEL_EXPORTER_OTLP_COMPRESSION` but only for the span
|
||||
exporter. If both are present, this takes higher precedence.
|
||||
"""
|
||||
|
||||
OTEL_EXPORTER_OTLP_METRICS_COMPRESSION = (
|
||||
"OTEL_EXPORTER_OTLP_METRICS_COMPRESSION"
|
||||
)
|
||||
"""
|
||||
.. envvar:: OTEL_EXPORTER_OTLP_METRICS_COMPRESSION
|
||||
|
||||
Same as :envvar:`OTEL_EXPORTER_OTLP_COMPRESSION` but only for the metric
|
||||
exporter. If both are present, this takes higher precedence.
|
||||
"""
|
||||
|
||||
OTEL_EXPORTER_OTLP_LOGS_COMPRESSION = "OTEL_EXPORTER_OTLP_LOGS_COMPRESSION"
|
||||
"""
|
||||
.. envvar:: OTEL_EXPORTER_OTLP_LOGS_COMPRESSION
|
||||
|
||||
Same as :envvar:`OTEL_EXPORTER_OTLP_COMPRESSION` but only for the log
|
||||
exporter. If both are present, this takes higher precedence.
|
||||
"""
|
||||
|
||||
OTEL_EXPORTER_OTLP_TRACES_TIMEOUT = "OTEL_EXPORTER_OTLP_TRACES_TIMEOUT"
|
||||
"""
|
||||
.. envvar:: OTEL_EXPORTER_OTLP_TRACES_TIMEOUT
|
||||
|
||||
The :envvar:`OTEL_EXPORTER_OTLP_TRACES_TIMEOUT` is the maximum time the OTLP exporter will
|
||||
wait for each batch export for spans.
|
||||
"""
|
||||
|
||||
OTEL_EXPORTER_OTLP_METRICS_TIMEOUT = "OTEL_EXPORTER_OTLP_METRICS_TIMEOUT"
|
||||
"""
|
||||
.. envvar:: OTEL_EXPORTER_OTLP_METRICS_TIMEOUT
|
||||
|
||||
The :envvar:`OTEL_EXPORTER_OTLP_METRICS_TIMEOUT` is the maximum time the OTLP exporter will
|
||||
wait for each batch export for metrics.
|
||||
"""
|
||||
|
||||
OTEL_EXPORTER_OTLP_METRICS_INSECURE = "OTEL_EXPORTER_OTLP_METRICS_INSECURE"
|
||||
"""
|
||||
.. envvar:: OTEL_EXPORTER_OTLP_METRICS_INSECURE
|
||||
|
||||
The :envvar:`OTEL_EXPORTER_OTLP_METRICS_INSECURE` represents whether to enable client transport security
|
||||
for gRPC requests for metrics. A scheme of https takes precedence over the this configuration setting.
|
||||
Default: False
|
||||
"""
|
||||
|
||||
OTEL_EXPORTER_OTLP_LOGS_INSECURE = "OTEL_EXPORTER_OTLP_LOGS_INSECURE"
|
||||
"""
|
||||
.. envvar:: OTEL_EXPORTER_OTLP_LOGS_INSECURE
|
||||
|
||||
The :envvar:`OTEL_EXPORTER_OTLP_LOGS_INSECURE` represents whether to enable client transport security
|
||||
for gRPC requests for logs. A scheme of https takes precedence over the this configuration setting.
|
||||
Default: False
|
||||
"""
|
||||
|
||||
OTEL_EXPORTER_OTLP_LOGS_CERTIFICATE = "OTEL_EXPORTER_OTLP_LOGS_CERTIFICATE"
|
||||
"""
|
||||
.. envvar:: OTEL_EXPORTER_OTLP_LOGS_CERTIFICATE
|
||||
|
||||
The :envvar:`OTEL_EXPORTER_OTLP_LOGS_CERTIFICATE` stores the path to the certificate file for
|
||||
TLS credentials of gRPC client for logs. Should only be used for a secure connection for logs.
|
||||
"""
|
||||
|
||||
OTEL_EXPORTER_OTLP_LOGS_TIMEOUT = "OTEL_EXPORTER_OTLP_LOGS_TIMEOUT"
|
||||
"""
|
||||
.. envvar:: OTEL_EXPORTER_OTLP_LOGS_TIMEOUT
|
||||
|
||||
The :envvar:`OTEL_EXPORTER_OTLP_LOGS_TIMEOUT` is the maximum time the OTLP exporter will
|
||||
wait for each batch export for logs.
|
||||
"""
|
||||
|
||||
OTEL_EXPORTER_JAEGER_CERTIFICATE = "OTEL_EXPORTER_JAEGER_CERTIFICATE"
|
||||
"""
|
||||
.. envvar:: OTEL_EXPORTER_JAEGER_CERTIFICATE
|
||||
|
||||
The :envvar:`OTEL_EXPORTER_JAEGER_CERTIFICATE` stores the path to the certificate file for
|
||||
TLS credentials of gRPC client for Jaeger. Should only be used for a secure connection with Jaeger.
|
||||
"""
|
||||
|
||||
OTEL_EXPORTER_JAEGER_AGENT_SPLIT_OVERSIZED_BATCHES = (
|
||||
"OTEL_EXPORTER_JAEGER_AGENT_SPLIT_OVERSIZED_BATCHES"
|
||||
)
|
||||
"""
|
||||
.. envvar:: OTEL_EXPORTER_JAEGER_AGENT_SPLIT_OVERSIZED_BATCHES
|
||||
|
||||
The :envvar:`OTEL_EXPORTER_JAEGER_AGENT_SPLIT_OVERSIZED_BATCHES` is a boolean flag to determine whether
|
||||
to split a large span batch to admire the udp packet size limit.
|
||||
"""
|
||||
|
||||
OTEL_SERVICE_NAME = "OTEL_SERVICE_NAME"
|
||||
"""
|
||||
.. envvar:: OTEL_SERVICE_NAME
|
||||
|
||||
Convenience environment variable for setting the service name resource attribute.
|
||||
The following two environment variables have the same effect
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
OTEL_SERVICE_NAME=my-python-service
|
||||
|
||||
OTEL_RESOURCE_ATTRIBUTES=service.name=my-python-service
|
||||
|
||||
|
||||
If both are set, :envvar:`OTEL_SERVICE_NAME` takes precedence.
|
||||
"""
|
||||
|
||||
|
||||
_OTEL_PYTHON_LOGGING_AUTO_INSTRUMENTATION_ENABLED = (
|
||||
"OTEL_PYTHON_LOGGING_AUTO_INSTRUMENTATION_ENABLED"
|
||||
)
|
||||
"""
|
||||
.. envvar:: OTEL_PYTHON_LOGGING_AUTO_INSTRUMENTATION_ENABLED
|
||||
|
||||
The :envvar:`OTEL_PYTHON_LOGGING_AUTO_INSTRUMENTATION_ENABLED` environment variable allows users to
|
||||
enable/disable the auto instrumentation for the python logging module.
|
||||
Default: False
|
||||
|
||||
Note: Logs SDK and its related settings are experimental.
|
||||
"""
|
||||
|
||||
|
||||
OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE = (
|
||||
"OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE"
|
||||
)
|
||||
"""
|
||||
.. envvar:: OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE
|
||||
|
||||
The :envvar:`OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE` environment
|
||||
variable allows users to set the default aggregation temporality policy to use
|
||||
on the basis of instrument kind. The valid (case-insensitive) values are:
|
||||
|
||||
``CUMULATIVE``: Use ``CUMULATIVE`` aggregation temporality for all instrument kinds.
|
||||
``DELTA``: Use ``DELTA`` aggregation temporality for ``Counter``, ``Asynchronous Counter`` and ``Histogram``.
|
||||
Use ``CUMULATIVE`` aggregation temporality for ``UpDownCounter`` and ``Asynchronous UpDownCounter``.
|
||||
``LOWMEMORY``: Use ``DELTA`` aggregation temporality for ``Counter`` and ``Histogram``.
|
||||
Use ``CUMULATIVE`` aggregation temporality for ``UpDownCounter``, ``AsynchronousCounter`` and ``Asynchronous UpDownCounter``.
|
||||
"""
|
||||
|
||||
OTEL_EXPORTER_JAEGER_GRPC_INSECURE = "OTEL_EXPORTER_JAEGER_GRPC_INSECURE"
|
||||
"""
|
||||
.. envvar:: OTEL_EXPORTER_JAEGER_GRPC_INSECURE
|
||||
|
||||
The :envvar:`OTEL_EXPORTER_JAEGER_GRPC_INSECURE` is a boolean flag to True if collector has no encryption or authentication.
|
||||
"""
|
||||
|
||||
OTEL_METRIC_EXPORT_INTERVAL = "OTEL_METRIC_EXPORT_INTERVAL"
|
||||
"""
|
||||
.. envvar:: OTEL_METRIC_EXPORT_INTERVAL
|
||||
|
||||
The :envvar:`OTEL_METRIC_EXPORT_INTERVAL` is the time interval (in milliseconds) between the start of two export attempts.
|
||||
"""
|
||||
|
||||
OTEL_METRIC_EXPORT_TIMEOUT = "OTEL_METRIC_EXPORT_TIMEOUT"
|
||||
"""
|
||||
.. envvar:: OTEL_METRIC_EXPORT_TIMEOUT
|
||||
|
||||
The :envvar:`OTEL_METRIC_EXPORT_TIMEOUT` is the maximum allowed time (in milliseconds) to export data.
|
||||
"""
|
||||
|
||||
OTEL_METRICS_EXEMPLAR_FILTER = "OTEL_METRICS_EXEMPLAR_FILTER"
|
||||
"""
|
||||
.. envvar:: OTEL_METRICS_EXEMPLAR_FILTER
|
||||
|
||||
The :envvar:`OTEL_METRICS_EXEMPLAR_FILTER` is the filter for which measurements can become Exemplars.
|
||||
"""
|
||||
|
||||
OTEL_EXPORTER_OTLP_METRICS_DEFAULT_HISTOGRAM_AGGREGATION = (
|
||||
"OTEL_EXPORTER_OTLP_METRICS_DEFAULT_HISTOGRAM_AGGREGATION"
|
||||
)
|
||||
"""
|
||||
.. envvar:: OTEL_EXPORTER_OTLP_METRICS_DEFAULT_HISTOGRAM_AGGREGATION
|
||||
|
||||
The :envvar:`OTEL_EXPORTER_OTLP_METRICS_DEFAULT_HISTOGRAM_AGGREGATION` is the default aggregation to use for histogram instruments.
|
||||
"""
|
||||
|
||||
OTEL_EXPERIMENTAL_RESOURCE_DETECTORS = "OTEL_EXPERIMENTAL_RESOURCE_DETECTORS"
|
||||
"""
|
||||
.. envvar:: OTEL_EXPERIMENTAL_RESOURCE_DETECTORS
|
||||
|
||||
The :envvar:`OTEL_EXPERIMENTAL_RESOURCE_DETECTORS` is a comma-separated string
|
||||
of names of resource detectors. These names must be the same as the names of
|
||||
entry points for the ```opentelemetry_resource_detector``` entry point. This is an
|
||||
experimental feature and the name of this variable and its behavior can change
|
||||
in a non-backwards compatible way.
|
||||
"""
|
||||
|
||||
OTEL_EXPORTER_PROMETHEUS_HOST = "OTEL_EXPORTER_PROMETHEUS_HOST"
|
||||
"""
|
||||
.. envvar:: OTEL_EXPORTER_PROMETHEUS_HOST
|
||||
|
||||
The :envvar:`OTEL_EXPORTER_PROMETHEUS_HOST` environment variable configures the host used by
|
||||
the Prometheus exporter.
|
||||
Default: "localhost"
|
||||
|
||||
This is an experimental environment variable and the name of this variable and its behavior can
|
||||
change in a non-backwards compatible way.
|
||||
"""
|
||||
|
||||
OTEL_EXPORTER_PROMETHEUS_PORT = "OTEL_EXPORTER_PROMETHEUS_PORT"
|
||||
"""
|
||||
.. envvar:: OTEL_EXPORTER_PROMETHEUS_PORT
|
||||
|
||||
The :envvar:`OTEL_EXPORTER_PROMETHEUS_PORT` environment variable configures the port used by
|
||||
the Prometheus exporter.
|
||||
Default: 9464
|
||||
|
||||
This is an experimental environment variable and the name of this variable and its behavior can
|
||||
change in a non-backwards compatible way.
|
||||
"""
|
||||
Binary file not shown.
Reference in New Issue
Block a user