An all-in-one package for python projects used to enable OpenTelemetry auto-instrumentation.
Includes all supported propagators and auto-instrumentation plugins.
Following command will installation the package with all instrumented packages.
pip install sumologic-opentelemetry[all]pip install sumologic-opentelemetryInstrumented packages needs to be installed per application. Command bellow executed in the root directory of your Python application will install corresponding instrumented packages used by the application.
opentelemetry-bootstrap --action=installThis package installs all officially supported auto-instrumentation packages as well as commonly used propagators and exporters:
Following list of instrumented packages is optional, but recommended for easy installation:
- opentelemetry-instrumentation-aws-lambda
- opentelemetry-instrumentation-dbapi
- opentelemetry-instrumentation-logging
- opentelemetry-instrumentation-sqlite3
- opentelemetry-instrumentation-urllib
- opentelemetry-instrumentation-wsgi
- opentelemetry-instrumentation-aiohttp-client
- opentelemetry-instrumentation-aiopg
- opentelemetry-instrumentation-asgi
- opentelemetry-instrumentation-asyncpg
- opentelemetry-instrumentation-boto
- opentelemetry-instrumentation-botocore
- opentelemetry-instrumentation-celery
- opentelemetry-instrumentation-django
- opentelemetry-instrumentation-elasticsearch
- opentelemetry-instrumentation-falcon
- opentelemetry-instrumentation-fastapi
- opentelemetry-instrumentation-flask
- opentelemetry-instrumentation-grpc
- opentelemetry-instrumentation-httpx
- opentelemetry-instrumentation-jinja2
- opentelemetry-instrumentation-kafka-python
- opentelemetry-instrumentation-mysql
- opentelemetry-instrumentation-pika
- opentelemetry-instrumentation-psycopg2
- opentelemetry-instrumentation-pymemcache
- opentelemetry-instrumentation-pymongo
- opentelemetry-instrumentation-pymysql
- opentelemetry-instrumentation-pyramid
- opentelemetry-instrumentation-redis
- opentelemetry-instrumentation-requests
- opentelemetry-instrumentation-sklearn
- opentelemetry-instrumentation-sqlalchemy
- opentelemetry-instrumentation-starlette
- opentelemetry-instrumentation-tornado
- opentelemetry-instrumentation-urllib3
Following propagators are installed as a dependency.
- opentelemetry-exporter-otlp-proto-http
- opentelemetry-propagator-jaeger
- opentelemetry-propagator-b3
- opentelemetry-propagator-aws-xray
- opentelemetry-propagator-ot-trace
Execute the following command. The command will also print the opentelemetry config used.
sumologic-opentelemetry-instrument python3 SCRIPT_NAME.py
The wrapper command checks for the following basic OpenTelemetry env variables that are required for the collected data to be useful within Sumo Logic:
OTEL_PROPAGATORSOTEL_TRACES_EXPORTEROTEL_SERVICE_NAMEOTEL_EXPORTER_OTLP_ENDPOINTOTEL_RESOURCE_ATTRIBUTES
By default, all propgators are enabled (OTEL_PROPAGATORS=tracecontext,baggage,b3,b3multi,jaeger,xray,ottrace).
By default, exported is set to OTLP HTTP (OTEL_TRACES_EXPORTER=otlp_proto_http).
By default, service name will not be set OTEL_SERVICE_NAME=.
Overwrite the env var with a string value representing service business logic, such as "FinanceServiceCall".
This will appear as a tracing service name in Sumo Logic.
By default, endpoint is not set (OTEL_EXPORTER_OTLP_ENDPOINT=). Represents the endpoint where telemetry data will be sent.
Change to appropriate endpoint, for example OTEL_EXPORTER_OTLP_ENDPOINT=http://collection-sumologic-otelcol.sumologic:55681
By default, resource attributes are not set (OTEL_RESOURCE_ATTRIBUTES=).
Is used to configure the application name (i.e. OTEL_RESOURCE_ATTRIBUTES=application=APPLICATION_NAME).
The application name will appear as a tracing application name in Sumo Logic.
Additional attributes can be added here as comma separated key=value pairs.