Skip to content

Django app on K8s crashes when auto-instrumented via the opentelemetry-operator without explicitly setting the PYTHONPATH and DJANGO_SETTINGS_MODULE #2495

@srprash

Description

@srprash

Describe your environment Describe any aspect of your environment relevant to the problem, including your Python version, platform, version numbers of installed dependencies, information about your cloud hosting provider, etc. If you're reporting a problem with a specific version of a library in this repo, please check whether the problem has been fixed on main.

  • Python version: 3.11
  • Platform: Kubernetes
  • Installed dependencies:
    • Django~=5.0.4
    • requests==2.31.0
  • Hosting: hosting locally on minikube, but same issue when hosted on AWS EKS

Steps to reproduce
Sample app code is here: https://github.com/srprash/otel-python-k8s-samples/tree/main/django

  1. Install Docker and Minikube, and run both.
  2. Run eval $(minikube docker-env) so that minikube can use the docker images from local repository.
  3. Build the application docker image using docker build -t django-app .
  4. Deploy the application to minikube using kubectl apply -f k8s/deployment.yaml and kubectl apply -f k8s/service.yaml
  5. Enable port-forwarding kubectl port-forward svc/django-service 8000
  6. Make a request to the application on http://127.0.0.1:8000/outgoing-http-call endpoint

What is the expected behavior?
What did you expect to see?

  • The application should run without an issues and produce a server span for the incoming request and a client span for the outgoing http request

What is the actual behavior?
What did you see instead?

  • The application fails to start with the error:
    Defaulted container "django-app" out of: django-app, opentelemetry-auto-instrumentation-python (init)
    CommandError: You must set settings.ALLOWED_HOSTS if DEBUG is False.
    
  • When I uncomment these lines (that is, explicitly set the PYTHONPATH and DJANGO_SETTINGS_MODULE), only then the application works correctly and is instrumented.

Additional context

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't working

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions