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

Jump to bottom

starlette instrumentation #777

Merged
merged 25 commits into from
Jun 15, 2020
Merged

starlette instrumentation #777

merged 25 commits into from
Jun 15, 2020

Conversation

toumorokoshi
Copy link
Member

Addresses part of #710.

@toumorokoshi toumorokoshi requested a review from a team June 4, 2020 16:37
@toumorokoshi toumorokoshi changed the title Have a basic starlette instrumentation working. [WIP] Have a basic starlette instrumentation working. Jun 4, 2020
@toumorokoshi toumorokoshi changed the title [WIP] Have a basic starlette instrumentation working. [WIP] starlette instrumentation. Jun 5, 2020
@toumorokoshi toumorokoshi changed the title [WIP] starlette instrumentation. [WIP] starlette instrumentation Jun 5, 2020
toumorokoshi and others added 16 commits June 8, 2020 20:45
@toumorokoshi
fix typo
537029e
@toumorokoshi
Merge branch 'master' into feature/starlette-instrumentation
3bc1aec
@toumorokoshi
Fleshing out instrumentor interface.
e89c37d
@toumorokoshi
more changes.
26464db
@toumorokoshi
tox: rename instrumentation to instrumentation-base
1300812 
tox does exact match on fields delimited by a dash. Thus,
any instrumentation that includes "instrumentation" in the name
would collide with testing of the "opentelemetry-instrumentation"
package.

Renaming the tox environment resolves the issue.
@toumorokoshi
fixing lint
16c9921
@toumorokoshi
Merge remote-tracking branch 'source/master' into feature/starlette-i…
56330ec 
…nstrumentation
@toumorokoshi
Adding entry point for starlette instrumentation
342d3b6
@toumorokoshi
removing unused middleware
6f7e875
@lzchen @toumorokoshi
Add SumObserver and UpDownSumObserver instruments (open-telemetry#789)
1e6e5d8
@lzchen @toumorokoshi
Add start_pipeline to MeterProvider in SDK, atexit moved to MeterProv…
bee354a 
…ider (open-telemetry#791)
@toumorokoshi
chore: Add majorgreys to approvers (open-telemetry#802)
37af971
@toumorokoshi
some refactoring to use opentelemetry-instrumentation
fea75c7
@toumorokoshi
Adding documentation, more unit tests
8c129a3
@toumorokoshi
Merge remote-tracking branch 'source/master' into feature/starlette-i…
5488878 
…nstrumentation
@toumorokoshi
Fixing linting
0a6222a
@toumorokoshi toumorokoshi changed the title [WIP] starlette instrumentation starlette instrumentation Jun 11, 2020
cnnradams
cnnradams suggested changes Jun 11, 2020
View reviewed changes
Copy link
Member

@cnnradams cnnradams left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Looks good overall, a few nits + questions I'm not sure about. There is some formatting stuff that isn't really relevant to starlette, but it looks good to me so 🤷

ext/opentelemetry-instrumentation-starlette/CHANGELOG.md Outdated Show resolved Hide resolved
ext/opentelemetry-instrumentation-starlette/setup.cfg Outdated Show resolved Hide resolved
ext/opentelemetry-ext-asgi/src/opentelemetry/ext/asgi/__init__.py Outdated Show resolved Hide resolved
ext/opentelemetry-instrumentation-starlette/tests/test_starlette_instrumentation.py Show resolved Hide resolved
ext/opentelemetry-instrumentation-starlette/tests/test_starlette_instrumentation.py Outdated Show resolved Hide resolved
...ntelemetry-instrumentation-starlette/src/opentelemetry/instrumentation/starlette/__init__.py Show resolved Hide resolved
@toumorokoshi toumorokoshi mentioned this pull request Jun 12, 2020
Closed
@toumorokoshi
addressing feedback
871ee6e 
removing remaining asgi references.
@toumorokoshi
More fixes
1b85bd4
cnnradams
cnnradams approved these changes Jun 12, 2020
View reviewed changes
Copy link
Member

@cnnradams cnnradams left a comment

Choose a reason for hiding this comment

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

LGTM

codeboten
codeboten suggested changes Jun 15, 2020
View reviewed changes
Copy link
Contributor

@codeboten codeboten left a comment

Choose a reason for hiding this comment

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

Looks pretty good! Just a couple of nits. The request for changes is on the typo in the tox file.

ext/opentelemetry-ext-asgi/setup.cfg Outdated Show resolved Hide resolved
ext/opentelemetry-instrumentation-starlette/setup.cfg Outdated Show resolved Hide resolved
tox.ini Outdated Show resolved Hide resolved
...ntelemetry-instrumentation-starlette/src/opentelemetry/instrumentation/starlette/__init__.py Show resolved Hide resolved
lzchen
lzchen reviewed Jun 15, 2020
View reviewed changes
tox.ini Outdated Show resolved Hide resolved
lzchen
lzchen reviewed Jun 15, 2020
View reviewed changes
tox.ini Outdated Show resolved Hide resolved
lzchen
lzchen reviewed Jun 15, 2020
View reviewed changes
...ntelemetry-instrumentation-starlette/src/opentelemetry/instrumentation/starlette/__init__.py
"""
if not getattr(app, "is_instrumented_by_opentelemetry", False):
app.add_middleware(
OpenTelemetryMiddleware,
Copy link
Contributor

Choose a reason for hiding this comment

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

Just out of curiosity, are we creating a starlette instrumentation (even though we can use asgi) for the same reason we have a flask instrumentation (when we could have recommended wsgi)?

Copy link
Member Author

@toumorokoshi toumorokoshi Jun 15, 2020 •
edited
Loading

Choose a reason for hiding this comment

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

Kind of. We need a language-specific instrumentation no matter what, to add the "http.route" span attribute (there is no generic way to express route either wsgi or asgi).

Flask has an extended reason: to avoid calling updateName. However, I finally have an OTEP drafted that I believe will eliminate the deferred updateName requirement: open-telemetry/oteps#115. At that point we can extend wsgi to create the flask instrumentation, in a very similar way to how this instrumentation works.

@toumorokoshi @lzchen
Apply suggestions from code review
a9dbb29 
Co-authored-by: alrex <aboten@lightstep.com>
Co-authored-by: Leighton Chen <lechen@microsoft.com>
codeboten
codeboten approved these changes Jun 15, 2020
View reviewed changes
Copy link
Contributor

@codeboten codeboten left a comment

Choose a reason for hiding this comment

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

👍

@toumorokoshi toumorokoshi merged commit 39fa078 into open-telemetry:master Jun 15, 2020
@toumorokoshi toumorokoshi deleted the feature/starlette-instrumentation branch June 15, 2020 21:00
@lzchen lzchen mentioned this pull request Jun 22, 2020
Closed
@hawkaa
Copy link
Contributor

hawkaa commented Jun 23, 2020

Looks really good, excited to try!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lzchen lzchen lzchen approved these changes

@cnnradams cnnradams cnnradams approved these changes

@codeboten codeboten codeboten approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@toumorokoshi @hawkaa @codeboten @cnnradams @lzchen