Python — Containers & VMs

This guide covers Python applications running on ECS, EC2, Kubernetes, or any container/VM environment. For AWS Lambda, see the Python Lambda guide.

1. Install the OpenTelemetry SDK

pip install opentelemetry-distro 
pip install opentelemetry-exporter-otlp
pip install opentelemetry-instrumentation-system-metrics

2. Install Instrumentation Libraries

opentelemetry-bootstrap -a install

opentelemetry-bootstrap automatically detects your installed packages (Django, FastAPI, Boto3, etc.) and installs the matching instrumentation libraries.

3. Install the Resource Detector Package

Install the resource detector package for the platform your application is running on.

AWS
Kubernetes
Containers

pip install opentelemetry-sdk-extension-aws

pip install opentelemetry-resourcedetector-kubernetes

pip install opentelemetry-resourcedetector-container

4. Set Environment Variables

Add these environment variables to your service. Replace YOUR_TRACE0_ENV_API_KEY with the API key from your Trace0 environment.

Variable	Value
`OTEL_EXPORTER_OTLP_ENDPOINT`	`https://app.trace0hq.com/api`
`OTEL_EXPORTER_OTLP_HEADERS`	`X-API-KEY=YOUR_TRACE0_ENV_API_KEY`
`OTEL_EXPORTER_OTLP_PROTOCOL`	`http/protobuf`
`OTEL_PYTHON_LOG_CORRELATION`	`true`
`OTEL_PYTHON_LOG_CODE_ATTRIBUTES`	`true`

If your application is running on AWS, set the following additional environment variable for your deployment platform.

ECS
EKS
EC2
Elastic Beanstalk

Variable	Value
`OTEL_EXPERIMENTAL_RESOURCE_DETECTORS`	`env,host,os,process,aws_ecs`

Variable	Value
`OTEL_EXPERIMENTAL_RESOURCE_DETECTORS`	`env,host,os,process,aws_eks`

Variable	Value
`OTEL_EXPERIMENTAL_RESOURCE_DETECTORS`	`env,host,os,process,aws_ec2`

Variable	Value
`OTEL_EXPERIMENTAL_RESOURCE_DETECTORS`	`env,host,os,process,aws_beanstalk`

5. Kubernetes Setup

If your application runs on Kubernetes, including Amazon EKS, Google Kubernetes Engine or Azure Kubernetes Service, add the following environment variables to your container specification.

env:
  - name: K8S_POD_UID
    valueFrom:
      fieldRef:
        fieldPath: metadata.uid

  - name: K8S_POD_NAME
    valueFrom:
      fieldRef:
        fieldPath: metadata.name

  - name: K8S_NAMESPACE_NAME
    valueFrom:
      fieldRef:
        fieldPath: metadata.namespace

  - name: K8S_CONTAINER_NAME
    value: my-container-name

  - name: OTEL_RESOURCE_ATTRIBUTES
    value: k8s.pod.uid=$(K8S_POD_UID),k8s.pod.name=$(K8S_POD_NAME),k8s.namespace.name=$(K8S_NAMESPACE_NAME),k8s.container.name=$(K8S_CONTAINER_NAME)

6. Deploy Service

Deploy your service and watch traces, metrics, and logs appear in the Trace0 dashboard within seconds.

Example Service

See our Python FastAPI EC2 example app for a working service you can deploy to your AWS account.

Introduction

Getting Started

Platform

Agents

Setup Guides

Pricing

Security

FAQ

Python — Containers & VMs

1. Install the OpenTelemetry SDK

2. Install Instrumentation Libraries

3. Install the Resource Detector Package

4. Set Environment Variables

5. Kubernetes Setup

6. Deploy Service

Example Service

​1. Install the OpenTelemetry SDK

​2. Install Instrumentation Libraries

​3. Install the Resource Detector Package

​4. Set Environment Variables

​5. Kubernetes Setup

​6. Deploy Service

​Example Service

1. Install the OpenTelemetry SDK

2. Install Instrumentation Libraries

3. Install the Resource Detector Package

4. Set Environment Variables

5. Kubernetes Setup

6. Deploy Service

Example Service