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.

Sign up for GitHub

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

flask: using string keys for wsgi environ values #366

Merged
merged 8 commits into from
Jan 20, 2020
Merged

flask: using string keys for wsgi environ values #366

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
c3c8a1d
flask: using string keys for wsgi environ values
toumorokoshi Jan 14, 2020
d5b2b2f
fixing lint errors
toumorokoshi Jan 15, 2020
72e20cf
addressing lint errors.
toumorokoshi Jan 15, 2020
4a0ec11
addressing lint errors.
toumorokoshi Jan 17, 2020
4853982
addressing lint errors
toumorokoshi Jan 17, 2020
fb1311c
fixing lint errors
toumorokoshi Jan 17, 2020
3979f40
addressing lint errors
toumorokoshi Jan 20, 2020
72872b4
addressing linting
toumorokoshi Jan 20, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions ext/opentelemetry-ext-flask/src/opentelemetry/ext/flask/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@

logger = logging.getLogger(__name__)

_ENVIRON_STARTTIME_KEY = object()
_ENVIRON_SPAN_KEY = object()
_ENVIRON_ACTIVATION_KEY = object()
_ENVIRON_STARTTIME_KEY = "opentelemetry-flask.starttime_key"
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
_ENVIRON_STARTTIME_KEY = "opentelemetry-flask.starttime_key"
_ENVIRON_STARTTIME_KEY = "opentelemetry-flask.starttime"

I think we don't need to add _key to the key.

_ENVIRON_SPAN_KEY = "opentelemetry-flask.span_key"
_ENVIRON_ACTIVATION_KEY = "opentelemetry-flask.activation_key"


def instrument_app(flask):
Expand Down
21 changes: 20 additions & 1 deletion ext/opentelemetry-ext-flask/tests/test_flask_integration.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@

import unittest

from flask import Flask
from flask import Flask, request
from werkzeug.test import Client
from werkzeug.wrappers import BaseResponse

Expand Down Expand Up @@ -57,6 +57,25 @@ def hello_endpoint(helloid):
otel_flask.instrument_app(self.app)
self.client = Client(self.app, BaseResponse)

def test_only_strings_in_environ(self):
"""
Some WSGI servers (such as Gunicorn) expect keys in the environ object
to be strings

OpenTelemetry should adhere to this convention.
"""
nonstring_keys = set()

def assert_environ():
for key in request.environ:
if not isinstance(key, str):
nonstring_keys.add(key)
return "hi"

self.app.route("/assert_environ")(assert_environ)
self.client.get("/assert_environ")
self.assertEqual(nonstring_keys, set())

def test_simple(self):
expected_attrs = expected_attributes(
{
Expand Down