This is a sample app to demonstrate how to instrument Python Django uWSGI app with Datadog, Elastic, New Relic and OpenTelemetry. It contains source code for the Django app which interacts with various services like Redis, MySQL, etc. to demonstrate tracing for these services. This repository has a docker compose file to set up all these services conveniently.
The code is organized into multiple branches. The main branch has the Django app without any instrumentation. Other branches then build upon the main branch to add specific instrumentations as below:
| Branch | Instrumentation | Code changes for instrumentation |
|---|---|---|
| main | None | - |
| datadog | Datadog | main...datadog |
| elastic | Elastic | main...elastic |
| newrelic | New Relic | main...newrelic |
| otel | OpenTelemetry | main...otel |
Clone this repository and go to the project directory. Then run the following commands
python3 -m venv .
source ./bin/activate
pip install -r requirements.txt
docker compose up --build
# Run the following command in a separate terminal to apply the database migrations.
# This is only needed during first-time setup. Repeat executions are harmless though.
source ./bin/activate
python manage.py migrate
Django app will now be available at http://localhost:8000/apis/.
The app has various API endpoints to demonstrate integrations with Redis, MySQL, etc. Check out apis/views.py for the list of API endpoints.
Please feel free to raise PR for any enhancements - additional service integrations, library version updates, documentation updates, etc.