usage: opentelemetry-instrument [-h] [--attribute_count_limit ATTRIBUTE_COUNT_LIMIT]
[--attribute_value_length_limit ATTRIBUTE_VALUE_LENGTH_LIMIT]
[--blrp_export_timeout BLRP_EXPORT_TIMEOUT]
[--blrp_max_export_batch_size BLRP_MAX_EXPORT_BATCH_SIZE]
[--blrp_max_queue_size BLRP_MAX_QUEUE_SIZE]
[--blrp_schedule_delay BLRP_SCHEDULE_DELAY]
[--bsp_export_timeout BSP_EXPORT_TIMEOUT]
[--bsp_max_export_batch_size BSP_MAX_EXPORT_BATCH_SIZE]
[--bsp_max_queue_size BSP_MAX_QUEUE_SIZE]
[--bsp_schedule_delay BSP_SCHEDULE_DELAY]
[--config_file CONFIG_FILE]
[--event_attribute_count_limit EVENT_ATTRIBUTE_COUNT_LIMIT]
[--experimental_resource_detectors EXPERIMENTAL_RESOURCE_DETECTORS]
[--exporter_otlp_certificate EXPORTER_OTLP_CERTIFICATE]
[--exporter_otlp_client_certificate EXPORTER_OTLP_CLIENT_CERTIFICATE]
[--exporter_otlp_client_key EXPORTER_OTLP_CLIENT_KEY]
[--exporter_otlp_compression EXPORTER_OTLP_COMPRESSION]
[--exporter_otlp_endpoint EXPORTER_OTLP_ENDPOINT]
[--exporter_otlp_headers EXPORTER_OTLP_HEADERS]
[--exporter_otlp_insecure EXPORTER_OTLP_INSECURE]
[--exporter_otlp_logs_certificate EXPORTER_OTLP_LOGS_CERTIFICATE]
[--exporter_otlp_logs_client_certificate EXPORTER_OTLP_LOGS_CLIENT_CERTIFICATE]
[--exporter_otlp_logs_client_key EXPORTER_OTLP_LOGS_CLIENT_KEY]
[--exporter_otlp_logs_compression EXPORTER_OTLP_LOGS_COMPRESSION]
[--exporter_otlp_logs_endpoint EXPORTER_OTLP_LOGS_ENDPOINT]
[--exporter_otlp_logs_headers EXPORTER_OTLP_LOGS_HEADERS]
[--exporter_otlp_logs_insecure EXPORTER_OTLP_LOGS_INSECURE]
[--exporter_otlp_logs_protocol EXPORTER_OTLP_LOGS_PROTOCOL]
[--exporter_otlp_logs_timeout EXPORTER_OTLP_LOGS_TIMEOUT]
[--exporter_otlp_metrics_certificate EXPORTER_OTLP_METRICS_CERTIFICATE]
[--exporter_otlp_metrics_client_certificate EXPORTER_OTLP_METRICS_CLIENT_CERTIFICATE]
[--exporter_otlp_metrics_client_key EXPORTER_OTLP_METRICS_CLIENT_KEY]
[--exporter_otlp_metrics_compression EXPORTER_OTLP_METRICS_COMPRESSION]
[--exporter_otlp_metrics_default_histogram_aggregation EXPORTER_OTLP_METRICS_DEFAULT_HISTOGRAM_AGGREGATION]
[--exporter_otlp_metrics_endpoint EXPORTER_OTLP_METRICS_ENDPOINT]
[--exporter_otlp_metrics_headers EXPORTER_OTLP_METRICS_HEADERS]
[--exporter_otlp_metrics_insecure EXPORTER_OTLP_METRICS_INSECURE]
[--exporter_otlp_metrics_protocol EXPORTER_OTLP_METRICS_PROTOCOL]
[--exporter_otlp_metrics_temporality_preference EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE]
[--exporter_otlp_metrics_timeout EXPORTER_OTLP_METRICS_TIMEOUT]
[--exporter_otlp_protocol EXPORTER_OTLP_PROTOCOL]
[--exporter_otlp_timeout EXPORTER_OTLP_TIMEOUT]
[--exporter_otlp_traces_certificate EXPORTER_OTLP_TRACES_CERTIFICATE]
[--exporter_otlp_traces_client_certificate EXPORTER_OTLP_TRACES_CLIENT_CERTIFICATE]
[--exporter_otlp_traces_client_key EXPORTER_OTLP_TRACES_CLIENT_KEY]
[--exporter_otlp_traces_compression EXPORTER_OTLP_TRACES_COMPRESSION]
[--exporter_otlp_traces_endpoint EXPORTER_OTLP_TRACES_ENDPOINT]
[--exporter_otlp_traces_headers EXPORTER_OTLP_TRACES_HEADERS]
[--exporter_otlp_traces_insecure EXPORTER_OTLP_TRACES_INSECURE]
[--exporter_otlp_traces_protocol EXPORTER_OTLP_TRACES_PROTOCOL]
[--exporter_otlp_traces_timeout EXPORTER_OTLP_TRACES_TIMEOUT]
[--exporter_prometheus_host EXPORTER_PROMETHEUS_HOST]
[--exporter_prometheus_port EXPORTER_PROMETHEUS_PORT]
[--exporter_zipkin_endpoint EXPORTER_ZIPKIN_ENDPOINT]
[--exporter_zipkin_timeout EXPORTER_ZIPKIN_TIMEOUT]
[--link_attribute_count_limit LINK_ATTRIBUTE_COUNT_LIMIT]
[--logrecord_attribute_count_limit LOGRECORD_ATTRIBUTE_COUNT_LIMIT]
[--logrecord_attribute_value_length_limit LOGRECORD_ATTRIBUTE_VALUE_LENGTH_LIMIT]
[--log_level LOG_LEVEL]
[--metrics_exemplar_filter METRICS_EXEMPLAR_FILTER]
[--metric_export_interval METRIC_EXPORT_INTERVAL]
[--metric_export_timeout METRIC_EXPORT_TIMEOUT]
[--logger_configurator LOGGER_CONFIGURATOR]
[--meter_configurator METER_CONFIGURATOR]
[--sdk_internal_metrics_enabled SDK_INTERNAL_METRICS_ENABLED]
[--tracer_configurator TRACER_CONFIGURATOR]
[--resource_attributes RESOURCE_ATTRIBUTES]
[--sdk_disabled SDK_DISABLED] [--service_name SERVICE_NAME]
[--span_attribute_count_limit SPAN_ATTRIBUTE_COUNT_LIMIT]
[--span_attribute_value_length_limit SPAN_ATTRIBUTE_VALUE_LENGTH_LIMIT]
[--span_event_count_limit SPAN_EVENT_COUNT_LIMIT]
[--span_link_count_limit SPAN_LINK_COUNT_LIMIT]
[--traces_sampler TRACES_SAMPLER]
[--traces_sampler_arg TRACES_SAMPLER_ARG]
[--auto_instrumentation_experimental_gevent_patch AUTO_INSTRUMENTATION_EXPERIMENTAL_GEVENT_PATCH]
[--configurator CONFIGURATOR]
[--disabled_instrumentations DISABLED_INSTRUMENTATIONS]
[--distro DISTRO]
[--semconv_stability_opt_in SEMCONV_STABILITY_OPT_IN]
[--exporter_gcp_trace_project_id EXPORTER_GCP_TRACE_PROJECT_ID]
[--exporter_gcp_trace_resource_regex EXPORTER_GCP_TRACE_RESOURCE_REGEX]
[--logs_exporter LOGS_EXPORTER]
[--metrics_exporter METRICS_EXPORTER] [--propagators PROPAGATORS]
[--context CONTEXT] [--id_generator ID_GENERATOR]
[--meter_provider METER_PROVIDER]
[--tracer_provider TRACER_PROVIDER]
[--traces_exporter TRACES_EXPORTER] [--version]
command ...
opentelemetry-instrument automatically instruments a Python program and its dependencies and then
runs the program.
positional arguments:
command Your Python application.
command_args Arguments for your application.
options:
-h, --help show this help message and exit
--attribute_count_limit ATTRIBUTE_COUNT_LIMIT
--attribute_value_length_limit ATTRIBUTE_VALUE_LENGTH_LIMIT
--blrp_export_timeout BLRP_EXPORT_TIMEOUT
--blrp_max_export_batch_size BLRP_MAX_EXPORT_BATCH_SIZE
--blrp_max_queue_size BLRP_MAX_QUEUE_SIZE
--blrp_schedule_delay BLRP_SCHEDULE_DELAY
--bsp_export_timeout BSP_EXPORT_TIMEOUT
--bsp_max_export_batch_size BSP_MAX_EXPORT_BATCH_SIZE
--bsp_max_queue_size BSP_MAX_QUEUE_SIZE
--bsp_schedule_delay BSP_SCHEDULE_DELAY
--config_file CONFIG_FILE
--event_attribute_count_limit EVENT_ATTRIBUTE_COUNT_LIMIT
--experimental_resource_detectors EXPERIMENTAL_RESOURCE_DETECTORS
--exporter_otlp_certificate EXPORTER_OTLP_CERTIFICATE
--exporter_otlp_client_certificate EXPORTER_OTLP_CLIENT_CERTIFICATE
--exporter_otlp_client_key EXPORTER_OTLP_CLIENT_KEY
--exporter_otlp_compression EXPORTER_OTLP_COMPRESSION
--exporter_otlp_endpoint EXPORTER_OTLP_ENDPOINT
--exporter_otlp_headers EXPORTER_OTLP_HEADERS
--exporter_otlp_insecure EXPORTER_OTLP_INSECURE
--exporter_otlp_logs_certificate EXPORTER_OTLP_LOGS_CERTIFICATE
--exporter_otlp_logs_client_certificate EXPORTER_OTLP_LOGS_CLIENT_CERTIFICATE
--exporter_otlp_logs_client_key EXPORTER_OTLP_LOGS_CLIENT_KEY
--exporter_otlp_logs_compression EXPORTER_OTLP_LOGS_COMPRESSION
--exporter_otlp_logs_endpoint EXPORTER_OTLP_LOGS_ENDPOINT
--exporter_otlp_logs_headers EXPORTER_OTLP_LOGS_HEADERS
--exporter_otlp_logs_insecure EXPORTER_OTLP_LOGS_INSECURE
--exporter_otlp_logs_protocol EXPORTER_OTLP_LOGS_PROTOCOL
--exporter_otlp_logs_timeout EXPORTER_OTLP_LOGS_TIMEOUT
--exporter_otlp_metrics_certificate EXPORTER_OTLP_METRICS_CERTIFICATE
--exporter_otlp_metrics_client_certificate EXPORTER_OTLP_METRICS_CLIENT_CERTIFICATE
--exporter_otlp_metrics_client_key EXPORTER_OTLP_METRICS_CLIENT_KEY
--exporter_otlp_metrics_compression EXPORTER_OTLP_METRICS_COMPRESSION
--exporter_otlp_metrics_default_histogram_aggregation EXPORTER_OTLP_METRICS_DEFAULT_HISTOGRAM_AGGREGATION
--exporter_otlp_metrics_endpoint EXPORTER_OTLP_METRICS_ENDPOINT
--exporter_otlp_metrics_headers EXPORTER_OTLP_METRICS_HEADERS
--exporter_otlp_metrics_insecure EXPORTER_OTLP_METRICS_INSECURE
--exporter_otlp_metrics_protocol EXPORTER_OTLP_METRICS_PROTOCOL
--exporter_otlp_metrics_temporality_preference EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE
--exporter_otlp_metrics_timeout EXPORTER_OTLP_METRICS_TIMEOUT
--exporter_otlp_protocol EXPORTER_OTLP_PROTOCOL
--exporter_otlp_timeout EXPORTER_OTLP_TIMEOUT
--exporter_otlp_traces_certificate EXPORTER_OTLP_TRACES_CERTIFICATE
--exporter_otlp_traces_client_certificate EXPORTER_OTLP_TRACES_CLIENT_CERTIFICATE
--exporter_otlp_traces_client_key EXPORTER_OTLP_TRACES_CLIENT_KEY
--exporter_otlp_traces_compression EXPORTER_OTLP_TRACES_COMPRESSION
--exporter_otlp_traces_endpoint EXPORTER_OTLP_TRACES_ENDPOINT
--exporter_otlp_traces_headers EXPORTER_OTLP_TRACES_HEADERS
--exporter_otlp_traces_insecure EXPORTER_OTLP_TRACES_INSECURE
--exporter_otlp_traces_protocol EXPORTER_OTLP_TRACES_PROTOCOL
--exporter_otlp_traces_timeout EXPORTER_OTLP_TRACES_TIMEOUT
--exporter_prometheus_host EXPORTER_PROMETHEUS_HOST
--exporter_prometheus_port EXPORTER_PROMETHEUS_PORT
--exporter_zipkin_endpoint EXPORTER_ZIPKIN_ENDPOINT
--exporter_zipkin_timeout EXPORTER_ZIPKIN_TIMEOUT
--link_attribute_count_limit LINK_ATTRIBUTE_COUNT_LIMIT
--logrecord_attribute_count_limit LOGRECORD_ATTRIBUTE_COUNT_LIMIT
--logrecord_attribute_value_length_limit LOGRECORD_ATTRIBUTE_VALUE_LENGTH_LIMIT
--log_level LOG_LEVEL
--metrics_exemplar_filter METRICS_EXEMPLAR_FILTER
--metric_export_interval METRIC_EXPORT_INTERVAL
--metric_export_timeout METRIC_EXPORT_TIMEOUT
--logger_configurator LOGGER_CONFIGURATOR
--meter_configurator METER_CONFIGURATOR
--sdk_internal_metrics_enabled SDK_INTERNAL_METRICS_ENABLED
--tracer_configurator TRACER_CONFIGURATOR
--resource_attributes RESOURCE_ATTRIBUTES
--sdk_disabled SDK_DISABLED
--service_name SERVICE_NAME
--span_attribute_count_limit SPAN_ATTRIBUTE_COUNT_LIMIT
--span_attribute_value_length_limit SPAN_ATTRIBUTE_VALUE_LENGTH_LIMIT
--span_event_count_limit SPAN_EVENT_COUNT_LIMIT
--span_link_count_limit SPAN_LINK_COUNT_LIMIT
--traces_sampler TRACES_SAMPLER
--traces_sampler_arg TRACES_SAMPLER_ARG
--auto_instrumentation_experimental_gevent_patch AUTO_INSTRUMENTATION_EXPERIMENTAL_GEVENT_PATCH
--configurator CONFIGURATOR
--disabled_instrumentations DISABLED_INSTRUMENTATIONS
--distro DISTRO
--semconv_stability_opt_in SEMCONV_STABILITY_OPT_IN
--exporter_gcp_trace_project_id EXPORTER_GCP_TRACE_PROJECT_ID
--exporter_gcp_trace_resource_regex EXPORTER_GCP_TRACE_RESOURCE_REGEX
--logs_exporter LOGS_EXPORTER
--metrics_exporter METRICS_EXPORTER
--propagators PROPAGATORS
--context CONTEXT
--id_generator ID_GENERATOR
--meter_provider METER_PROVIDER
--tracer_provider TRACER_PROVIDER
--traces_exporter TRACES_EXPORTER
--version print version information
Optional arguments (except for --help and --version) for opentelemetry-instrument directly
correspond with OpenTelemetry environment variables. The corresponding optional argument is formed
by removing the OTEL_ or OTEL_PYTHON_ prefix from the environment variable and lower casing the
rest. For example, the optional argument --attribute_value_length_limit corresponds with the
environment variable OTEL_ATTRIBUTE_VALUE_LENGTH_LIMIT. These optional arguments will override the
current value of the corresponding environment variable during the execution of the command.
Options (92)
| Option | Description | Source |
|---|---|---|
-h, --help | show this help message and exit | help |
--attribute_count_limit ATTRIBUTE_COUNT_LIMIT | help | |
--attribute_value_length_limit ATTRIBUTE_VALUE_LENGTH_LIMIT | help | |
--blrp_export_timeout BLRP_EXPORT_TIMEOUT | help | |
--blrp_max_export_batch_size BLRP_MAX_EXPORT_BATCH_SIZE | help | |
--blrp_max_queue_size BLRP_MAX_QUEUE_SIZE | help | |
--blrp_schedule_delay BLRP_SCHEDULE_DELAY | help | |
--bsp_export_timeout BSP_EXPORT_TIMEOUT | help | |
--bsp_max_export_batch_size BSP_MAX_EXPORT_BATCH_SIZE | help | |
--bsp_max_queue_size BSP_MAX_QUEUE_SIZE | help | |
--bsp_schedule_delay BSP_SCHEDULE_DELAY | help | |
--config_file CONFIG_FILE | help | |
--event_attribute_count_limit EVENT_ATTRIBUTE_COUNT_LIMIT | help | |
--experimental_resource_detectors EXPERIMENTAL_RESOURCE_DETECTORS | help | |
--exporter_otlp_certificate EXPORTER_OTLP_CERTIFICATE | help | |
--exporter_otlp_client_certificate EXPORTER_OTLP_CLIENT_CERTIFICATE | help | |
--exporter_otlp_client_key EXPORTER_OTLP_CLIENT_KEY | help | |
--exporter_otlp_compression EXPORTER_OTLP_COMPRESSION | help | |
--exporter_otlp_endpoint EXPORTER_OTLP_ENDPOINT | help | |
--exporter_otlp_headers EXPORTER_OTLP_HEADERS | help | |
--exporter_otlp_insecure EXPORTER_OTLP_INSECURE | help | |
--exporter_otlp_logs_certificate EXPORTER_OTLP_LOGS_CERTIFICATE | help | |
--exporter_otlp_logs_client_certificate EXPORTER_OTLP_LOGS_CLIENT_CERTIFICATE | help | |
--exporter_otlp_logs_client_key EXPORTER_OTLP_LOGS_CLIENT_KEY | help | |
--exporter_otlp_logs_compression EXPORTER_OTLP_LOGS_COMPRESSION | help | |
--exporter_otlp_logs_endpoint EXPORTER_OTLP_LOGS_ENDPOINT | help | |
--exporter_otlp_logs_headers EXPORTER_OTLP_LOGS_HEADERS | help | |
--exporter_otlp_logs_insecure EXPORTER_OTLP_LOGS_INSECURE | help | |
--exporter_otlp_logs_protocol EXPORTER_OTLP_LOGS_PROTOCOL | help | |
--exporter_otlp_logs_timeout EXPORTER_OTLP_LOGS_TIMEOUT | help | |
--exporter_otlp_metrics_certificate EXPORTER_OTLP_METRICS_CERTIFICATE | help | |
--exporter_otlp_metrics_client_certificate EXPORTER_OTLP_METRICS_CLIENT_CERTIFICATE | help | |
--exporter_otlp_metrics_client_key EXPORTER_OTLP_METRICS_CLIENT_KEY | help | |
--exporter_otlp_metrics_compression EXPORTER_OTLP_METRICS_COMPRESSION | help | |
--exporter_otlp_metrics_default_histogram_aggregation | help | |
--exporter_otlp_metrics_endpoint EXPORTER_OTLP_METRICS_ENDPOINT | help | |
--exporter_otlp_metrics_headers EXPORTER_OTLP_METRICS_HEADERS | help | |
--exporter_otlp_metrics_insecure EXPORTER_OTLP_METRICS_INSECURE | help | |
--exporter_otlp_metrics_protocol EXPORTER_OTLP_METRICS_PROTOCOL | help | |
--exporter_otlp_metrics_temporality_preference | help | |
--exporter_otlp_metrics_timeout EXPORTER_OTLP_METRICS_TIMEOUT | help | |
--exporter_otlp_protocol EXPORTER_OTLP_PROTOCOL | help | |
--exporter_otlp_timeout EXPORTER_OTLP_TIMEOUT | help | |
--exporter_otlp_traces_certificate EXPORTER_OTLP_TRACES_CERTIFICATE | help | |
--exporter_otlp_traces_client_certificate EXPORTER_OTLP_TRACES_CLIENT_CERTIFICATE | help | |
--exporter_otlp_traces_client_key EXPORTER_OTLP_TRACES_CLIENT_KEY | help | |
--exporter_otlp_traces_compression EXPORTER_OTLP_TRACES_COMPRESSION | help | |
--exporter_otlp_traces_endpoint EXPORTER_OTLP_TRACES_ENDPOINT | help | |
--exporter_otlp_traces_headers EXPORTER_OTLP_TRACES_HEADERS | help | |
--exporter_otlp_traces_insecure EXPORTER_OTLP_TRACES_INSECURE | help | |
--exporter_otlp_traces_protocol EXPORTER_OTLP_TRACES_PROTOCOL | help | |
--exporter_otlp_traces_timeout EXPORTER_OTLP_TRACES_TIMEOUT | help | |
--exporter_prometheus_host EXPORTER_PROMETHEUS_HOST | help | |
--exporter_prometheus_port EXPORTER_PROMETHEUS_PORT | help | |
--exporter_zipkin_endpoint EXPORTER_ZIPKIN_ENDPOINT | help | |
--exporter_zipkin_timeout EXPORTER_ZIPKIN_TIMEOUT | help | |
--link_attribute_count_limit LINK_ATTRIBUTE_COUNT_LIMIT | help | |
--logrecord_attribute_count_limit LOGRECORD_ATTRIBUTE_COUNT_LIMIT | help | |
--logrecord_attribute_value_length_limit LOGRECORD_ATTRIBUTE_VALUE_LENGTH_LIMIT | help | |
--log_level LOG_LEVEL | help | |
--metrics_exemplar_filter METRICS_EXEMPLAR_FILTER | help | |
--metric_export_interval METRIC_EXPORT_INTERVAL | help | |
--metric_export_timeout METRIC_EXPORT_TIMEOUT | help | |
--logger_configurator LOGGER_CONFIGURATOR | help | |
--meter_configurator METER_CONFIGURATOR | help | |
--sdk_internal_metrics_enabled SDK_INTERNAL_METRICS_ENABLED | help | |
--tracer_configurator TRACER_CONFIGURATOR | help | |
--resource_attributes RESOURCE_ATTRIBUTES | help | |
--sdk_disabled SDK_DISABLED | help | |
--service_name SERVICE_NAME | help | |
--span_attribute_count_limit SPAN_ATTRIBUTE_COUNT_LIMIT | help | |
--span_attribute_value_length_limit SPAN_ATTRIBUTE_VALUE_LENGTH_LIMIT | help | |
--span_event_count_limit SPAN_EVENT_COUNT_LIMIT | help | |
--span_link_count_limit SPAN_LINK_COUNT_LIMIT | help | |
--traces_sampler TRACES_SAMPLER | help | |
--traces_sampler_arg TRACES_SAMPLER_ARG | help | |
--auto_instrumentation_experimental_gevent_patch | help | |
--configurator CONFIGURATOR | help | |
--disabled_instrumentations DISABLED_INSTRUMENTATIONS | help | |
--distro DISTRO | help | |
--semconv_stability_opt_in SEMCONV_STABILITY_OPT_IN | help | |
--exporter_gcp_trace_project_id EXPORTER_GCP_TRACE_PROJECT_ID | help | |
--exporter_gcp_trace_resource_regex EXPORTER_GCP_TRACE_RESOURCE_REGEX | help | |
--logs_exporter LOGS_EXPORTER | help | |
--metrics_exporter METRICS_EXPORTER | help | |
--propagators PROPAGATORS | help | |
--context CONTEXT | help | |
--id_generator ID_GENERATOR | help | |
--meter_provider METER_PROVIDER | help | |
--tracer_provider TRACER_PROVIDER | help | |
--traces_exporter TRACES_EXPORTER | help | |
--version | print version information | help |