# 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_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 `__. .. code-block:: console $ OTEL_RESOURCE_ATTRIBUTES="service.name=shoppingcard,will_be_overridden=foo" python - <`__. """ 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_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 metrics. A scheme of https takes precedence over the this configuration setting. Default: False """ 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 metric 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_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 traces. Should only be used for a secure connection for tracing. """ 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 traces. Should only be used for a secure connection for tracing. """ 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_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_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_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_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 logging SDK auto instrumentation. 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_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` is the clients private key to use in mTLS communication in PEM format. """ 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_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` is the client certificate/chain trust for clients private key to use in mTLS communication in PEM format. """ 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. """