Coverage for /pythoncovmergedfiles/medio/medio/usr/local/lib/python3.8/site-packages/opentelemetry/sdk/environment_variables.py: 100%
64 statements
« prev ^ index » next coverage.py v7.2.7, created at 2023-06-07 06:35 +0000
1# Copyright The OpenTelemetry Authors
2#
3# Licensed under the Apache License, Version 2.0 (the "License");
4# you may not use this file except in compliance with the License.
5# You may obtain a copy of the License at
6#
7# http://www.apache.org/licenses/LICENSE-2.0
8#
9# Unless required by applicable law or agreed to in writing, software
10# distributed under the License is distributed on an "AS IS" BASIS,
11# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12# See the License for the specific language governing permissions and
13# limitations under the License.
15OTEL_RESOURCE_ATTRIBUTES = "OTEL_RESOURCE_ATTRIBUTES"
16"""
17.. envvar:: OTEL_RESOURCE_ATTRIBUTES
19The :envvar:`OTEL_RESOURCE_ATTRIBUTES` environment variable allows resource
20attributes to be passed to the SDK at process invocation. The attributes from
21:envvar:`OTEL_RESOURCE_ATTRIBUTES` are merged with those passed to
22`Resource.create`, meaning :envvar:`OTEL_RESOURCE_ATTRIBUTES` takes *lower*
23priority. Attributes should be in the format ``key1=value1,key2=value2``.
24Additional details are available `in the specification
25<https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/resource/sdk.md#specifying-resource-information-via-an-environment-variable>`__.
27.. code-block:: console
29 $ OTEL_RESOURCE_ATTRIBUTES="service.name=shoppingcard,will_be_overridden=foo" python - <<EOF
30 import pprint
31 from opentelemetry.sdk.resources import Resource
32 pprint.pprint(Resource.create({"will_be_overridden": "bar"}).attributes)
33 EOF
34 {'service.name': 'shoppingcard',
35 'telemetry.sdk.language': 'python',
36 'telemetry.sdk.name': 'opentelemetry',
37 'telemetry.sdk.version': '0.13.dev0',
38 'will_be_overridden': 'bar'}
39"""
41OTEL_LOG_LEVEL = "OTEL_LOG_LEVEL"
42"""
43.. envvar:: OTEL_LOG_LEVEL
45The :envvar:`OTEL_LOG_LEVEL` environment variable sets the log level used by the SDK logger
46Default: "info"
47"""
49OTEL_TRACES_SAMPLER = "OTEL_TRACES_SAMPLER"
50"""
51.. envvar:: OTEL_TRACES_SAMPLER
53The :envvar:`OTEL_TRACES_SAMPLER` environment variable sets the sampler to be used for traces.
54Sampling is a mechanism to control the noise introduced by OpenTelemetry by reducing the number
55of traces collected and sent to the backend
56Default: "parentbased_always_on"
57"""
59OTEL_TRACES_SAMPLER_ARG = "OTEL_TRACES_SAMPLER_ARG"
60"""
61.. envvar:: OTEL_TRACES_SAMPLER_ARG
63The :envvar:`OTEL_TRACES_SAMPLER_ARG` environment variable will only be used if OTEL_TRACES_SAMPLER is set.
64Each Sampler type defines its own expected input, if any.
65Invalid or unrecognized input is ignored,
66i.e. the SDK behaves as if OTEL_TRACES_SAMPLER_ARG is not set.
67"""
69OTEL_BSP_SCHEDULE_DELAY = "OTEL_BSP_SCHEDULE_DELAY"
70"""
71.. envvar:: OTEL_BSP_SCHEDULE_DELAY
73The :envvar:`OTEL_BSP_SCHEDULE_DELAY` represents the delay interval between two consecutive exports.
74Default: 5000
75"""
77OTEL_BSP_EXPORT_TIMEOUT = "OTEL_BSP_EXPORT_TIMEOUT"
78"""
79.. envvar:: OTEL_BSP_EXPORT_TIMEOUT
81The :envvar:`OTEL_BSP_EXPORT_TIMEOUT` represents the maximum allowed time to export data.
82Default: 30000
83"""
85OTEL_BSP_MAX_QUEUE_SIZE = "OTEL_BSP_MAX_QUEUE_SIZE"
86"""
87.. envvar:: OTEL_BSP_MAX_QUEUE_SIZE
89The :envvar:`OTEL_BSP_MAX_QUEUE_SIZE` represents the maximum queue size for the data export.
90Default: 2048
91"""
93OTEL_BSP_MAX_EXPORT_BATCH_SIZE = "OTEL_BSP_MAX_EXPORT_BATCH_SIZE"
94"""
95.. envvar:: OTEL_BSP_MAX_EXPORT_BATCH_SIZE
97The :envvar:`OTEL_BSP_MAX_EXPORT_BATCH_SIZE` represents the maximum batch size for the data export.
98Default: 512
99"""
101OTEL_ATTRIBUTE_COUNT_LIMIT = "OTEL_ATTRIBUTE_COUNT_LIMIT"
102"""
103.. envvar:: OTEL_ATTRIBUTE_COUNT_LIMIT
105The :envvar:`OTEL_ATTRIBUTE_COUNT_LIMIT` represents the maximum allowed attribute count for spans, events and links.
106This limit is overridden by model specific limits such as OTEL_SPAN_ATTRIBUTE_COUNT_LIMIT.
107Default: 128
108"""
110OTEL_ATTRIBUTE_VALUE_LENGTH_LIMIT = "OTEL_ATTRIBUTE_VALUE_LENGTH_LIMIT"
111"""
112.. envvar:: OTEL_ATTRIBUTE_VALUE_LENGTH_LIMIT
114The :envvar:`OTEL_ATTRIBUTE_VALUE_LENGTH_LIMIT` represents the maximum allowed attribute length.
115"""
117OTEL_EVENT_ATTRIBUTE_COUNT_LIMIT = "OTEL_EVENT_ATTRIBUTE_COUNT_LIMIT"
118"""
119.. envvar:: OTEL_EVENT_ATTRIBUTE_COUNT_LIMIT
121The :envvar:`OTEL_EVENT_ATTRIBUTE_COUNT_LIMIT` represents the maximum allowed event attribute count.
122Default: 128
123"""
125OTEL_LINK_ATTRIBUTE_COUNT_LIMIT = "OTEL_LINK_ATTRIBUTE_COUNT_LIMIT"
126"""
127.. envvar:: OTEL_LINK_ATTRIBUTE_COUNT_LIMIT
129The :envvar:`OTEL_LINK_ATTRIBUTE_COUNT_LIMIT` represents the maximum allowed link attribute count.
130Default: 128
131"""
133OTEL_SPAN_ATTRIBUTE_COUNT_LIMIT = "OTEL_SPAN_ATTRIBUTE_COUNT_LIMIT"
134"""
135.. envvar:: OTEL_SPAN_ATTRIBUTE_COUNT_LIMIT
137The :envvar:`OTEL_SPAN_ATTRIBUTE_COUNT_LIMIT` represents the maximum allowed span attribute count.
138Default: 128
139"""
141OTEL_SPAN_ATTRIBUTE_VALUE_LENGTH_LIMIT = (
142 "OTEL_SPAN_ATTRIBUTE_VALUE_LENGTH_LIMIT"
143)
144"""
145.. envvar:: OTEL_SPAN_ATTRIBUTE_VALUE_LENGTH_LIMIT
147The :envvar:`OTEL_SPAN_ATTRIBUTE_VALUE_LENGTH_LIMIT` represents the maximum allowed length
148span attribute values can have. This takes precedence over :envvar:`OTEL_ATTRIBUTE_VALUE_LENGTH_LIMIT`.
149"""
151OTEL_SPAN_EVENT_COUNT_LIMIT = "OTEL_SPAN_EVENT_COUNT_LIMIT"
152"""
153.. envvar:: OTEL_SPAN_EVENT_COUNT_LIMIT
155The :envvar:`OTEL_SPAN_EVENT_COUNT_LIMIT` represents the maximum allowed span event count.
156Default: 128
157"""
159OTEL_SPAN_LINK_COUNT_LIMIT = "OTEL_SPAN_LINK_COUNT_LIMIT"
160"""
161.. envvar:: OTEL_SPAN_LINK_COUNT_LIMIT
163The :envvar:`OTEL_SPAN_LINK_COUNT_LIMIT` represents the maximum allowed span link count.
164Default: 128
165"""
167OTEL_EXPORTER_JAEGER_AGENT_HOST = "OTEL_EXPORTER_JAEGER_AGENT_HOST"
168"""
169.. envvar:: OTEL_EXPORTER_JAEGER_AGENT_HOST
171The :envvar:`OTEL_EXPORTER_JAEGER_AGENT_HOST` represents the hostname for the Jaeger agent.
172Default: "localhost"
173"""
175OTEL_EXPORTER_JAEGER_AGENT_PORT = "OTEL_EXPORTER_JAEGER_AGENT_PORT"
176"""
177.. envvar:: OTEL_EXPORTER_JAEGER_AGENT_PORT
179The :envvar:`OTEL_EXPORTER_JAEGER_AGENT_PORT` represents the port for the Jaeger agent.
180Default: 6831
181"""
183OTEL_EXPORTER_JAEGER_ENDPOINT = "OTEL_EXPORTER_JAEGER_ENDPOINT"
184"""
185.. envvar:: OTEL_EXPORTER_JAEGER_ENDPOINT
187The :envvar:`OTEL_EXPORTER_JAEGER_ENDPOINT` represents the HTTP endpoint for Jaeger traces.
188Default: "http://localhost:14250"
189"""
191OTEL_EXPORTER_JAEGER_USER = "OTEL_EXPORTER_JAEGER_USER"
192"""
193.. envvar:: OTEL_EXPORTER_JAEGER_USER
195The :envvar:`OTEL_EXPORTER_JAEGER_USER` represents the username to be used for HTTP basic authentication.
196"""
198OTEL_EXPORTER_JAEGER_PASSWORD = "OTEL_EXPORTER_JAEGER_PASSWORD"
199"""
200.. envvar:: OTEL_EXPORTER_JAEGER_PASSWORD
202The :envvar:`OTEL_EXPORTER_JAEGER_PASSWORD` represents the password to be used for HTTP basic authentication.
203"""
205OTEL_EXPORTER_JAEGER_TIMEOUT = "OTEL_EXPORTER_JAEGER_TIMEOUT"
206"""
207.. envvar:: OTEL_EXPORTER_JAEGER_TIMEOUT
209Maximum time the Jaeger exporter will wait for each batch export.
210Default: 10
211"""
213OTEL_EXPORTER_ZIPKIN_ENDPOINT = "OTEL_EXPORTER_ZIPKIN_ENDPOINT"
214"""
215.. envvar:: OTEL_EXPORTER_ZIPKIN_ENDPOINT
217Zipkin collector endpoint to which the exporter will send data. This may
218include a path (e.g. ``http://example.com:9411/api/v2/spans``).
219"""
221OTEL_EXPORTER_ZIPKIN_TIMEOUT = "OTEL_EXPORTER_ZIPKIN_TIMEOUT"
222"""
223.. envvar:: OTEL_EXPORTER_ZIPKIN_TIMEOUT
225Maximum time (in seconds) the Zipkin exporter will wait for each batch export.
226Default: 10
227"""
229OTEL_EXPORTER_OTLP_PROTOCOL = "OTEL_EXPORTER_OTLP_PROTOCOL"
230"""
231.. envvar:: OTEL_EXPORTER_OTLP_PROTOCOL
233The :envvar:`OTEL_EXPORTER_OTLP_PROTOCOL` represents the the transport protocol for the
234OTLP exporter.
235"""
237OTEL_EXPORTER_OTLP_TRACES_PROTOCOL = "OTEL_EXPORTER_OTLP_TRACES_PROTOCOL"
238"""
239.. envvar:: OTEL_EXPORTER_OTLP_TRACES_PROTOCOL
241The :envvar:`OTEL_EXPORTER_OTLP_TRACES_PROTOCOL` represents the the transport protocol for spans.
242"""
244OTEL_EXPORTER_OTLP_METRICS_PROTOCOL = "OTEL_EXPORTER_OTLP_METRICS_PROTOCOL"
245"""
246.. envvar:: OTEL_EXPORTER_OTLP_METRICS_PROTOCOL
248The :envvar:`OTEL_EXPORTER_OTLP_TRACES_PROTOCOL` represents the the transport protocol for metrics.
249"""
251OTEL_EXPORTER_OTLP_LOGS_PROTOCOL = "OTEL_EXPORTER_OTLP_LOGS_PROTOCOL"
252"""
253.. envvar:: OTEL_EXPORTER_OTLP_LOGS_PROTOCOL
255The :envvar:`OTEL_EXPORTER_OTLP_TRACES_PROTOCOL` represents the the transport protocol for logs.
256"""
258OTEL_EXPORTER_OTLP_CERTIFICATE = "OTEL_EXPORTER_OTLP_CERTIFICATE"
259"""
260.. envvar:: OTEL_EXPORTER_OTLP_CERTIFICATE
262The :envvar:`OTEL_EXPORTER_OTLP_CERTIFICATE` stores the path to the certificate file for
263TLS credentials of gRPC client. Should only be used for a secure connection.
264"""
266OTEL_EXPORTER_OTLP_HEADERS = "OTEL_EXPORTER_OTLP_HEADERS"
267"""
268.. envvar:: OTEL_EXPORTER_OTLP_HEADERS
270The :envvar:`OTEL_EXPORTER_OTLP_HEADERS` contains the key-value pairs to be used as headers
271associated with gRPC or HTTP requests.
272"""
275OTEL_EXPORTER_OTLP_COMPRESSION = "OTEL_EXPORTER_OTLP_COMPRESSION"
276"""
277.. envvar:: OTEL_EXPORTER_OTLP_COMPRESSION
279Specifies a gRPC compression method to be used in the OTLP exporters.
280Possible values are:
282- ``gzip`` corresponding to `grpc.Compression.Gzip`.
283- ``deflate`` corresponding to `grpc.Compression.Deflate`.
285If no ``OTEL_EXPORTER_OTLP_*COMPRESSION`` environment variable is present or
286``compression`` argument passed to the exporter, the default
287`grpc.Compression.NoCompression` will be used. Additional details are
288available `in the specification
289<https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/exporter.md#opentelemetry-protocol-exporter>`__.
290"""
292OTEL_EXPORTER_OTLP_TIMEOUT = "OTEL_EXPORTER_OTLP_TIMEOUT"
293"""
294.. envvar:: OTEL_EXPORTER_OTLP_TIMEOUT
296The :envvar:`OTEL_EXPORTER_OTLP_TIMEOUT` is the maximum time the OTLP exporter will wait for each batch export.
297Default: 10
298"""
300OTEL_EXPORTER_OTLP_ENDPOINT = "OTEL_EXPORTER_OTLP_ENDPOINT"
301"""
302.. envvar:: OTEL_EXPORTER_OTLP_ENDPOINT
304The :envvar:`OTEL_EXPORTER_OTLP_ENDPOINT` target to which the exporter is going to send spans or metrics.
305The endpoint MUST be a valid URL host, and MAY contain a scheme (http or https), port and path.
306A scheme of https indicates a secure connection and takes precedence over the insecure configuration setting.
307Default: "http://localhost:4317"
308"""
310OTEL_EXPORTER_OTLP_INSECURE = "OTEL_EXPORTER_OTLP_INSECURE"
311"""
312.. envvar:: OTEL_EXPORTER_OTLP_INSECURE
314The :envvar:`OTEL_EXPORTER_OTLP_INSECURE` represents whether to enable client transport security for gRPC requests.
315A scheme of https takes precedence over this configuration setting.
316Default: False
317"""
319OTEL_EXPORTER_OTLP_TRACES_INSECURE = "OTEL_EXPORTER_OTLP_TRACES_INSECURE"
320"""
321.. envvar:: OTEL_EXPORTER_OTLP_TRACES_INSECURE
323The :envvar:`OTEL_EXPORTER_OTLP_TRACES_INSECURE` represents whether to enable client transport security
324for gRPC requests for spans. A scheme of https takes precedence over the this configuration setting.
325Default: False
326"""
329OTEL_EXPORTER_OTLP_TRACES_ENDPOINT = "OTEL_EXPORTER_OTLP_TRACES_ENDPOINT"
330"""
331.. envvar:: OTEL_EXPORTER_OTLP_TRACES_ENDPOINT
333The :envvar:`OTEL_EXPORTER_OTLP_TRACES_ENDPOINT` target to which the span exporter is going to send spans.
334The endpoint MUST be a valid URL host, and MAY contain a scheme (http or https), port and path.
335A scheme of https indicates a secure connection and takes precedence over this configuration setting.
336"""
338OTEL_EXPORTER_OTLP_METRICS_ENDPOINT = "OTEL_EXPORTER_OTLP_METRICS_ENDPOINT"
339"""
340.. envvar:: OTEL_EXPORTER_OTLP_METRICS_ENDPOINT
342The :envvar:`OTEL_EXPORTER_OTLP_METRICS_ENDPOINT` target to which the metrics exporter is going to send metrics.
343The endpoint MUST be a valid URL host, and MAY contain a scheme (http or https), port and path.
344A scheme of https indicates a secure connection and takes precedence over this configuration setting.
345"""
347OTEL_EXPORTER_OTLP_TRACES_CERTIFICATE = "OTEL_EXPORTER_OTLP_TRACES_CERTIFICATE"
348"""
349.. envvar:: OTEL_EXPORTER_OTLP_TRACES_CERTIFICATE
351The :envvar:`OTEL_EXPORTER_OTLP_TRACES_CERTIFICATE` stores the path to the certificate file for
352TLS credentials of gRPC client for traces. Should only be used for a secure connection for tracing.
353"""
355OTEL_EXPORTER_OTLP_METRICS_CERTIFICATE = (
356 "OTEL_EXPORTER_OTLP_METRICS_CERTIFICATE"
357)
358"""
359.. envvar:: OTEL_EXPORTER_OTLP_METRICS_CERTIFICATE
361The :envvar:`OTEL_EXPORTER_OTLP_METRICS_CERTIFICATE` stores the path to the certificate file for
362TLS credentials of gRPC client for metrics. Should only be used for a secure connection for exporting metrics.
363"""
365OTEL_EXPORTER_OTLP_TRACES_HEADERS = "OTEL_EXPORTER_OTLP_TRACES_HEADERS"
366"""
367.. envvar:: OTEL_EXPORTER_OTLP_TRACES_HEADERS
369The :envvar:`OTEL_EXPORTER_OTLP_TRACES_HEADERS` contains the key-value pairs to be used as headers for spans
370associated with gRPC or HTTP requests.
371"""
373OTEL_EXPORTER_OTLP_METRICS_HEADERS = "OTEL_EXPORTER_OTLP_METRICS_HEADERS"
374"""
375.. envvar:: OTEL_EXPORTER_OTLP_METRICS_HEADERS
377The :envvar:`OTEL_EXPORTER_OTLP_METRICS_HEADERS` contains the key-value pairs to be used as headers for metrics
378associated with gRPC or HTTP requests.
379"""
381OTEL_EXPORTER_OTLP_TRACES_COMPRESSION = "OTEL_EXPORTER_OTLP_TRACES_COMPRESSION"
382"""
383.. envvar:: OTEL_EXPORTER_OTLP_TRACES_COMPRESSION
385Same as :envvar:`OTEL_EXPORTER_OTLP_COMPRESSION` but only for the span
386exporter. If both are present, this takes higher precedence.
387"""
389OTEL_EXPORTER_OTLP_METRICS_COMPRESSION = (
390 "OTEL_EXPORTER_OTLP_METRICS_COMPRESSION"
391)
392"""
393.. envvar:: OTEL_EXPORTER_OTLP_METRICS_COMPRESSION
395Same as :envvar:`OTEL_EXPORTER_OTLP_COMPRESSION` but only for the metric
396exporter. If both are present, this takes higher precedence.
397"""
399OTEL_EXPORTER_OTLP_TRACES_TIMEOUT = "OTEL_EXPORTER_OTLP_TRACES_TIMEOUT"
400"""
401.. envvar:: OTEL_EXPORTER_OTLP_TRACES_TIMEOUT
403The :envvar:`OTEL_EXPORTER_OTLP_TRACES_TIMEOUT` is the maximum time the OTLP exporter will
404wait for each batch export for spans.
405"""
407OTEL_EXPORTER_OTLP_METRICS_TIMEOUT = "OTEL_EXPORTER_OTLP_METRICS_TIMEOUT"
408"""
409.. envvar:: OTEL_EXPORTER_OTLP_METRICS_TIMEOUT
411The :envvar:`OTEL_EXPORTER_OTLP_METRICS_TIMEOUT` is the maximum time the OTLP exporter will
412wait for each batch export for metrics.
413"""
415OTEL_EXPORTER_OTLP_METRICS_INSECURE = "OTEL_EXPORTER_OTLP_METRICS_INSECURE"
416"""
417.. envvar:: OTEL_EXPORTER_OTLP_METRICS_INSECURE
419The :envvar:`OTEL_EXPORTER_OTLP_METRICS_INSECURE` represents whether to enable client transport security
420for gRPC requests for metrics. A scheme of https takes precedence over the this configuration setting.
421Default: False
422"""
424OTEL_EXPORTER_OTLP_METRICS_ENDPOINT = "OTEL_EXPORTER_OTLP_METRICS_ENDPOINT"
425"""
426.. envvar:: OTEL_EXPORTER_OTLP_METRICS_ENDPOINT
428The :envvar:`OTEL_EXPORTER_OTLP_METRICS_ENDPOINT` target to which the metric exporter is going to send spans.
429The endpoint MUST be a valid URL host, and MAY contain a scheme (http or https), port and path.
430A scheme of https indicates a secure connection and takes precedence over this configuration setting.
431"""
433OTEL_EXPORTER_OTLP_METRICS_CERTIFICATE = (
434 "OTEL_EXPORTER_OTLP_METRICS_CERTIFICATE"
435)
436"""
437.. envvar:: OTEL_EXPORTER_OTLP_METRICS_CERTIFICATE
439The :envvar:`OTEL_EXPORTER_OTLP_METRICS_CERTIFICATE` stores the path to the certificate file for
440TLS credentials of gRPC client for traces. Should only be used for a secure connection for tracing.
441"""
443OTEL_EXPORTER_OTLP_METRICS_HEADERS = "OTEL_EXPORTER_OTLP_METRICS_HEADERS"
444"""
445.. envvar:: OTEL_EXPORTER_OTLP_METRICS_HEADERS
447The :envvar:`OTEL_EXPORTER_OTLP_METRICS_HEADERS` contains the key-value pairs to be used as headers for metrics
448associated with gRPC or HTTP requests.
449"""
451OTEL_EXPORTER_OTLP_METRICS_TIMEOUT = "OTEL_EXPORTER_OTLP_METRICS_TIMEOUT"
452"""
453.. envvar:: OTEL_EXPORTER_OTLP_METRICS_TIMEOUT
455The :envvar:`OTEL_EXPORTER_OTLP_METRICS_TIMEOUT` is the maximum time the OTLP exporter will
456wait for each batch export for metrics.
457"""
459OTEL_EXPORTER_OTLP_METRICS_COMPRESSION = (
460 "OTEL_EXPORTER_OTLP_METRICS_COMPRESSION"
461)
462"""
463.. envvar:: OTEL_EXPORTER_OTLP_METRICS_COMPRESSION
465Same as :envvar:`OTEL_EXPORTER_OTLP_COMPRESSION` but only for the metric
466exporter. If both are present, this takes higher precedence.
467"""
469OTEL_EXPORTER_JAEGER_CERTIFICATE = "OTEL_EXPORTER_JAEGER_CERTIFICATE"
470"""
471.. envvar:: OTEL_EXPORTER_JAEGER_CERTIFICATE
473The :envvar:`OTEL_EXPORTER_JAEGER_CERTIFICATE` stores the path to the certificate file for
474TLS credentials of gRPC client for Jaeger. Should only be used for a secure connection with Jaeger.
475"""
477OTEL_EXPORTER_JAEGER_AGENT_SPLIT_OVERSIZED_BATCHES = (
478 "OTEL_EXPORTER_JAEGER_AGENT_SPLIT_OVERSIZED_BATCHES"
479)
480"""
481.. envvar:: OTEL_EXPORTER_JAEGER_AGENT_SPLIT_OVERSIZED_BATCHES
483The :envvar:`OTEL_EXPORTER_JAEGER_AGENT_SPLIT_OVERSIZED_BATCHES` is a boolean flag to determine whether
484to split a large span batch to admire the udp packet size limit.
485"""
487OTEL_SERVICE_NAME = "OTEL_SERVICE_NAME"
488"""
489.. envvar:: OTEL_SERVICE_NAME
491Convenience environment variable for setting the service name resource attribute.
492The following two environment variables have the same effect
494.. code-block:: console
496 OTEL_SERVICE_NAME=my-python-service
498 OTEL_RESOURCE_ATTRIBUTES=service.name=my-python-service
501If both are set, :envvar:`OTEL_SERVICE_NAME` takes precedence.
502"""
505_OTEL_PYTHON_LOGGING_AUTO_INSTRUMENTATION_ENABLED = (
506 "OTEL_PYTHON_LOGGING_AUTO_INSTRUMENTATION_ENABLED"
507)
508"""
509.. envvar:: OTEL_PYTHON_LOGGING_AUTO_INSTRUMENTATION_ENABLED
511The :envvar:`OTEL_PYTHON_LOGGING_AUTO_INSTRUMENTATION_ENABLED` environment variable allows users to
512enable/disable the logging SDK auto instrumentation.
513Default: False
515Note: Logs SDK and its related settings are experimental.
516"""
519OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE = (
520 "OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE"
521)
522"""
523.. envvar:: OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE
525The :envvar:`OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE` environment
526variable allows users to set the default aggregation temporality policy to use
527on the basis of instrument kind. The valid (case-insensitive) values are:
529``CUMULATIVE``: Choose ``CUMULATIVE`` aggregation temporality for all instrument kinds.
530``DELTA``: Choose ``DELTA`` aggregation temporality for ``Counter``, ``Asynchronous Counter`` and ``Histogram``.
531Choose ``CUMULATIVE`` aggregation temporality for ``UpDownCounter`` and ``Asynchronous UpDownCounter``.
532"""
534OTEL_EXPORTER_JAEGER_GRPC_INSECURE = "OTEL_EXPORTER_JAEGER_GRPC_INSECURE"
535"""
536.. envvar:: OTEL_EXPORTER_JAEGER_GRPC_INSECURE
538The :envvar:`OTEL_EXPORTER_JAEGER_GRPC_INSECURE` is a boolean flag to True if collector has no encryption or authentication.
539"""
541OTEL_METRIC_EXPORT_INTERVAL = "OTEL_METRIC_EXPORT_INTERVAL"
542"""
543.. envvar:: OTEL_METRIC_EXPORT_INTERVAL
545The :envvar:`OTEL_METRIC_EXPORT_INTERVAL` is the time interval (in milliseconds) between the start of two export attempts.
546"""
548OTEL_METRIC_EXPORT_TIMEOUT = "OTEL_METRIC_EXPORT_TIMEOUT"
549"""
550.. envvar:: OTEL_METRIC_EXPORT_TIMEOUT
552The :envvar:`OTEL_METRIC_EXPORT_TIMEOUT` is the maximum allowed time (in milliseconds) to export data.
553"""
555OTEL_EXPORTER_OTLP_METRICS_CLIENT_KEY = "OTEL_EXPORTER_OTLP_METRICS_CLIENT_KEY"
556"""
557.. envvar:: OTEL_EXPORTER_OTLP_METRICS_CLIENT_KEY
559The :envvar:`OTEL_EXPORTER_OTLP_METRICS_CLIENT_KEY` is the clients private key to use in mTLS communication in PEM format.
560"""
562OTEL_METRICS_EXEMPLAR_FILTER = "OTEL_METRICS_EXEMPLAR_FILTER"
563"""
564.. envvar:: OTEL_METRICS_EXEMPLAR_FILTER
566The :envvar:`OTEL_METRICS_EXEMPLAR_FILTER` is the filter for which measurements can become Exemplars.
567"""
569_OTEL_EXPORTER_OTLP_METRICS_DEFAULT_HISTOGRAM_AGGREGATION = (
570 "OTEL_EXPORTER_OTLP_METRICS_DEFAULT_HISTOGRAM_AGGREGATION"
571)
572"""
573.. envvar:: OTEL_EXPORTER_OTLP_METRICS_DEFAULT_HISTOGRAM_AGGREGATION
575The :envvar:`OTEL_EXPORTER_OTLP_METRICS_DEFAULT_HISTOGRAM_AGGREGATION` is the default aggregation to use for histogram instruments.
576"""
578OTEL_EXPORTER_OTLP_METRICS_CLIENT_CERTIFICATE = (
579 "OTEL_EXPORTER_OTLP_METRICS_CLIENT_CERTIFICATE"
580)
581"""
582.. envvar:: OTEL_EXPORTER_OTLP_METRICS_CLIENT_CERTIFICATE
584The :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.
585"""