ext/requests: Add instrumentor #597

mauriciovasquezbernal · 2020-04-17T20:31:25Z

Implement the BaseInstrumentor interface to make this library compatible with the opentelemetry-auto-instr command.

There is an issue about getting the span when the global tracer provider hasn't been configured, this should be changed in the future once we extend the opentelemetry-auto-instr command to also configure the SDK.

Implement Instrumentor interface to allow user enabling instrumentation in the library and to work with autoinstrumentation.

Set span status from http status code.

codeboten

This is looking great. I tested it with opentelemetry-auto-instrumentation and got some traces with the following code

from opentelemetry import trace
from opentelemetry.sdk.trace.export import (
    ConsoleSpanExporter,
    SimpleExportSpanProcessor,
)

import requests

trace.get_tracer_provider().add_span_processor(
    SimpleExportSpanProcessor(ConsoleSpanExporter())
)

url = f"https://wikipedia.org"
try:
    res = requests.get(url)
    print(f"Request to {url}, got {len(res.content)} bytes")
except Exception as e:
    print(f"Request to {url} failed {e}")

codeboten · 2020-04-21T16:10:53Z

docs/examples/http/client.py

@@ -28,15 +28,18 @@

 # The preferred tracer implementation must be set, as the opentelemetry-api
 # defines the interface with a no-op implementation.
+# It must be done before instrumenting any library.


Will this change once the instrumentor interface supports configuration?

In this particular example all the calls to instrument() omit the tracer_provider parameter, it means the current configured is used. If there is not any configured, and OPENTELEMETRY_PYTHON_TRACER_PROVIDER is not set, a default no-op will be used.

I think the common approach we should suggest in the examples is.

trace.set_tracer_provider(TracerProvider()) (We don't want to mess up with env variables in the examples)

instrument the libraries

configure the span processor and exporters

use of the instrumented framework.

codeboten · 2020-04-23T15:51:56Z

ext/opentelemetry-ext-http-requests/src/opentelemetry/ext/http_requests/__init__.py

-    opentelemetry.ext.http_requests.enable(TracerProvider())
-    response = requests.get(url='https://www.example.org/')
+    # You can optionally pass a custom TracerProvider to RequestInstrumentor.instrument()
+    opentelemetry.ext.http_requests.RequestInstrumentor.instrument()


should this example show how to pass a TracerProvider?

I don't think so. Passing a TracerProvider is an advanced use case, we don't expect it to be common.

how about the example with the kwarg as none: instrument(tracer_prover=None). If I saw that comment, I would have no idea what the argument name is for passing my own TracerProvider.

I think this documentation should be as simple as possible and the documentation about the parameters of such function should be on the generated documentation, that we don't know how to do right now: https://github.com/open-telemetry/opentelemetry-python/issues/617.

codeboten · 2020-04-23T15:53:11Z

ext/opentelemetry-ext-http-requests/src/opentelemetry/ext/http_requests/__init__.py

+        _tracer = None
+
+
+def _http_status_to_canonical_code(code: int, allow_redirect: bool = True):


should we follow up and move this somewhere up the packages? this is duplicated in 4-5 places now.

I hesitate to suggest the api package, which is the only common dependency. Or maybe an opentelemetry-instrumentor-utils?

I think we should move that to a new package in the future, I'd like to avoid doing that on this PR as I want this to be in asap. By the way, I opened an issue to initiate the discussion about that #610, I think an utils package for instrumentors is the best idea.

codeboten · 2020-04-23T15:54:06Z

ext/opentelemetry-ext-http-requests/src/opentelemetry/ext/http_requests/__init__.py

@@ -103,12 +110,12 @@ def instrumented_request(self, method, url, *args, **kwargs):

            span.set_attribute("http.status_code", result.status_code)
            span.set_attribute("http.status_text", result.reason)
+            span.set_status(
+                Status(_http_status_to_canonical_code(result.status_code))


did you want to pass an argument for allow_redirect here?

I took the code from

opentelemetry-python/ext/opentelemetry-ext-wsgi/src/opentelemetry/ext/wsgi/__init__.py

Line 90 in 7cb57c7

def http_status_to_canonical_code(code: int, allow_redirect: bool = True):

, I'm not sure if I should set the flag here.

Looking at that code, it only applies to the 399 status code, which is unassigned. @Oberon00 any insight into the rationalle for the parameter, and the 399 status code? Looks like you were one of the authors of that commit.

codeboten · 2020-04-23T15:54:41Z

ext/opentelemetry-ext-http-requests/tests/test_requests_integration.py

@@ -29,23 +30,25 @@ class TestRequestsIntegration(TestBase):

    def setUp(self):
        super().setUp()
-        opentelemetry.ext.http_requests.enable(self.tracer_provider)
+        http_requests.RequestsInstrumentor().instrument()


should this be passing in the tracer_provider?

TestBase is doing trace.set_tracer_provider(cls.tracer_provider), so it's the same.

mauriciovasquezbernal · 2020-04-24T14:17:18Z

@codeboten just as a reference, the example you provided requires OPENTELEMETRY_PYTHON_TRACER_PROVIDER=sdk_tracer_provider to be set in order to work.

toumorokoshi · 2020-04-26T04:28:15Z

ext/opentelemetry-ext-http-requests/src/opentelemetry/ext/http_requests/__init__.py

-    opentelemetry.ext.http_requests.enable(TracerProvider())
-    response = requests.get(url='https://www.example.org/')
+    # You can optionally pass a custom TracerProvider to RequestInstrumentor.instrument()
+    opentelemetry.ext.http_requests.RequestInstrumentor.instrument()


how about the example with the kwarg as none: instrument(tracer_prover=None). If I saw that comment, I would have no idea what the argument name is for passing my own TracerProvider.

toumorokoshi · 2020-04-26T04:32:06Z

ext/opentelemetry-ext-http-requests/src/opentelemetry/ext/http_requests/__init__.py

@@ -103,12 +110,12 @@ def instrumented_request(self, method, url, *args, **kwargs):

            span.set_attribute("http.status_code", result.status_code)
            span.set_attribute("http.status_text", result.reason)
+            span.set_status(
+                Status(_http_status_to_canonical_code(result.status_code))


Looking at that code, it only applies to the 399 status code, which is unassigned. @Oberon00 any insight into the rationalle for the parameter, and the 399 status code? Looks like you were one of the authors of that commit.

toumorokoshi · 2020-04-26T04:34:00Z

ext/opentelemetry-ext-http-requests/src/opentelemetry/ext/http_requests/__init__.py

+        _tracer = None
+
+
+def _http_status_to_canonical_code(code: int, allow_redirect: bool = True):


should we follow up and move this somewhere up the packages? this is duplicated in 4-5 places now.

I hesitate to suggest the api package, which is the only common dependency. Or maybe an opentelemetry-instrumentor-utils?

ext/opentelemetry-ext-http-requests/tests/test_requests_integration.py

docs/examples/opentelemetry-example-app/src/opentelemetry_example_app/flask_example.py

ext/opentelemetry-ext-http-requests/src/opentelemetry/ext/http_requests/__init__.py

lzchen

LGTM! Just a few non-blocking questions/comments. Good work!

* chore(plugin-https): sync https tests with http * chore: use Http instead typeof http * chore: review finding, improve https detection * chore: fix node 8 * chore: fix path to test files

mauriciovasquezbernal added ext instrumentation Related to the instrumentation of third party libraries or frameworks labels Apr 20, 2020

mauriciovasquezbernal marked this pull request as ready for review April 20, 2020 13:05

mauriciovasquezbernal requested a review from a team April 20, 2020 13:05

mauriciovasquezbernal mentioned this pull request Apr 21, 2020

ext: Expect tracer provider instead of tracer in integrations #602

Merged

mauriciovasquezbernal added the needs reviewers PRs with this label are ready for review and needs people to review to move forward. label Apr 23, 2020

mauriciovasquezbernal added 3 commits April 23, 2020 07:14

ext/requests: Implement instrumentor interface

dceb5c0

Implement Instrumentor interface to allow user enabling instrumentation in the library and to work with autoinstrumentation.

ext/requests: Set span status

35cd548

Set span status from http status code.

ext/requests: Implement some more tests

16d9d1f

codeboten approved these changes Apr 23, 2020

View reviewed changes

Remove workaround when tracer provider is not configured

13950d0

mauriciovasquezbernal changed the title ~~ext/requests: Implement BaseInstrumentor interface~~ ext/requests: Add instrumentor Apr 24, 2020

update changelog

60d53d5

toumorokoshi approved these changes Apr 26, 2020

View reviewed changes

lzchen reviewed Apr 27, 2020

View reviewed changes

docs/examples/opentelemetry-example-app/src/opentelemetry_example_app/flask_example.py Show resolved Hide resolved

lzchen reviewed Apr 27, 2020

View reviewed changes

ext/opentelemetry-ext-http-requests/src/opentelemetry/ext/http_requests/__init__.py Show resolved Hide resolved

lzchen reviewed Apr 27, 2020

View reviewed changes

ext/opentelemetry-ext-http-requests/src/opentelemetry/ext/http_requests/__init__.py Show resolved Hide resolved

lzchen reviewed Apr 27, 2020

View reviewed changes

ext/opentelemetry-ext-http-requests/src/opentelemetry/ext/http_requests/__init__.py Show resolved Hide resolved

lzchen approved these changes Apr 27, 2020

View reviewed changes

mauriciovasquezbernal and others added 6 commits April 27, 2020 10:07

add comment about tracer provider

584f99d

update link to semantic conventions

7b7c9aa

Merge branch 'master' into mauricio/requests-instrumentor

e1cb642

Merge branch 'master' into mauricio/requests-instrumentor

9f07b61

Merge branch 'master' into mauricio/requests-instrumentor

a84c687

Merge branch 'master' into mauricio/requests-instrumentor

f6383a8

toumorokoshi merged commit 8e3ed35 into open-telemetry:master Apr 27, 2020

mauriciovasquezbernal mentioned this pull request Apr 29, 2020

Add instrumentor for Requests open-telemetry/opentelemetry-python-contrib#14

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ext/requests: Add instrumentor #597

ext/requests: Add instrumentor #597

mauriciovasquezbernal commented Apr 17, 2020

codeboten left a comment

codeboten Apr 21, 2020

mauriciovasquezbernal Apr 23, 2020

codeboten Apr 23, 2020

mauriciovasquezbernal Apr 23, 2020

toumorokoshi Apr 26, 2020

mauriciovasquezbernal Apr 27, 2020

codeboten Apr 23, 2020

toumorokoshi Apr 26, 2020

mauriciovasquezbernal Apr 27, 2020

codeboten Apr 23, 2020

mauriciovasquezbernal Apr 23, 2020

toumorokoshi Apr 26, 2020

codeboten Apr 23, 2020

mauriciovasquezbernal Apr 23, 2020

mauriciovasquezbernal commented Apr 24, 2020

toumorokoshi Apr 26, 2020

toumorokoshi Apr 26, 2020

toumorokoshi Apr 26, 2020

lzchen left a comment

		_tracer = None


		def _http_status_to_canonical_code(code: int, allow_redirect: bool = True):

ext/requests: Add instrumentor #597

ext/requests: Add instrumentor #597

Conversation

mauriciovasquezbernal commented Apr 17, 2020

codeboten left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mauriciovasquezbernal commented Apr 24, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lzchen left a comment

Choose a reason for hiding this comment