Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Django: Capture custom request/response headers #1024

Conversation

sanketmehta28
Copy link
Member

Description

This PR https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/http.md for django framework

Fixes #913

Type of change

Please delete options that are not relevant.

  • New feature (non-breaking change which adds functionality)
  • This change requires a documentation update

How Has This Been Tested?

Added unit tests separately for request and response headers for ASGI and WSGI applications. Also tested it manually by capturing the request and response headers from a instrumented django app for both ASGI and WSGI application

Same test cases for both ASGI/WSGI application

  • Test A: check for request header which is set in OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SERVER_REQUEST env variable, is present in the span as attribute
  • Test B: check for request header which is NOT set in OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SERVER_REQUEST env variable, is NOT present in the span as attribute
  • Test C: check for response header which is set in OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SERVER_RESPONSE env variable, is present in the span as attribute
  • Test D: check for response header which is NOT set in OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SERVER_RESPONSE env variable, is NOT present in the span as attribute

Does This PR Require a Core Repo Change?

  • No.

Checklist:

See contributing.md for styleguide, changelog guidelines, and more.

  • Followed the style guidelines of this project
  • Changelogs have been updated
  • Unit tests have been added
  • Documentation has been updated

@sanketmehta28 sanketmehta28 requested a review from a team March 31, 2022 13:28
@srikanthccv
Copy link
Member

Please update the title

@sanketmehta28 sanketmehta28 changed the title Code changes for https://github.com/open-telemetry/opentelemetry-pyth… Django: Capture custom request/response headers Mar 31, 2022
@sanketmehta28
Copy link
Member Author

Please update the title

done

@sanketmehta28
Copy link
Member Author

Hi @open-telemetry/python-approvers : please do review this PR

CHANGELOG.md Show resolved Hide resolved
@@ -271,12 +291,27 @@ def process_response(self, request, response):
if activation and span:
if is_asgi_request:
set_status_code(span, response.status_code)
if span.is_recording() and span.kind == SpanKind.SERVER:
# asgi_getter inside asgi_collect_custom_response_attributes
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't believe you have to explain this reasoning behind this, so I would remove the comments.

@lzchen lzchen merged commit b1e94d6 into open-telemetry:main Apr 5, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Django: Capture request/response headers as span attributes
3 participants