-
Notifications
You must be signed in to change notification settings - Fork 1.2k
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
Document some quirks with Python otel operator based auto-instrumentation #5338
Changes from all commits
0a92a44
ff99703
17e1caa
4e841fd
dc35efe
ffb991b
24f6fa1
02e261e
1b750c3
3d183b2
302bfd0
763d24d
24c9f23
6d6d135
9ea9392
934b9fb
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
|
@@ -3,11 +3,26 @@ title: Using the OpenTelemetry Operator to Inject Auto-Instrumentation | |||||||||
linkTitle: Operator | ||||||||||
aliases: [/docs/languages/python/automatic/operator] | ||||||||||
weight: 30 | ||||||||||
cSpell:ignore: distro mkdir uninstrumented virtualenv | ||||||||||
cSpell:ignore: distro grpcio mkdir psutil uninstrumented virtualenv | ||||||||||
--- | ||||||||||
|
||||||||||
If you run your Python service in Kubernetes, you can take advantage of the | ||||||||||
[OpenTelemetry Operator](https://github.com/open-telemetry/opentelemetry-operator) | ||||||||||
to inject auto-instrumentation without having to modify each of your services | ||||||||||
directly. | ||||||||||
[See the OpenTelemetry Operator Auto-instrumentation docs for more details.](/docs/kubernetes/operator/automatic/) | ||||||||||
|
||||||||||
### Python-specific topics | ||||||||||
|
||||||||||
#### Libraries with binary wheels | ||||||||||
|
||||||||||
Some Python packages we instrument or need in our instrumentation libraries, | ||||||||||
might ship with some binary code. This is the case, for example, of `grpcio` and | ||||||||||
`psutil` (used in `opentelemetry-instrumentation-system-metrics`). | ||||||||||
|
||||||||||
The binary code is tied to a specific C library version (glibc or musl) and to a | ||||||||||
specific Python version. The | ||||||||||
[OpenTelemetry Operator](https://github.com/open-telemetry/opentelemetry-operator) | ||||||||||
provides images for a single Python version based on the glibc C library. If you | ||||||||||
want to use it you might need to build your own image operator Docker image for | ||||||||||
Python auto-instrumentation. | ||||||||||
Comment on lines
+27
to
+28
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. It's spelled auto-instrumentation in other places There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. If I remember correctly we have an issue for fixing that at once, I think it is fine to keep it that way |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Only psutil is used in the system metrics package, grpcio is used generally in the exporters or in its own instrumentation library.