Document some quirks with Python otel operator based auto-instrumenta…

…tion (#5338) Co-authored-by: Fabrizio Ferri-Benedetti <[email protected]> Co-authored-by: Tiffany Hrabusa <[email protected]>
open-telemetry · Oct 15, 2024 · 71833a5 · 71833a5
1 parent 7ab2f7f
commit 71833a5
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 2 deletions.
diff --git a/content/en/docs/kubernetes/operator/automatic.md b/content/en/docs/kubernetes/operator/automatic.md
@@ -428,9 +428,16 @@ spec:
           instrumentation>
 ```
 
+See the
+[Python agent configuration docs](/docs/zero-code/python/configuration/#disabling-specific-instrumentations)
+for more details.
+
 #### Learn more {#python-learn-more}
 
-[See the Python agent Configuration docs for more details.](/docs/zero-code/python/configuration/#disabling-specific-instrumentations)
+For Python-specific quirks, see
+[Python OpenTelemetry Operator docs](/docs/zero-code/python/operator/#python-specific-topics)
+and the
+[Python agent configuration docs](/docs/zero-code/python/configuration/).
 
 ### Go
 

diff --git a/content/en/docs/zero-code/python/operator.md b/content/en/docs/zero-code/python/operator.md
@@ -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.