opentelemetry-python
opentelemetry-python copied to clipboard
open-telemetry
Please add examples of basic usage to the README
Similar to https://github.com/opentracing/opentracing-python#inbound-request
@yurishkuro Are you referring to basic usage of OpenTracing or OpenTelemetry in general?
OpenTelemetry. I looked through readthedocs, and did not find a consistent cookbook of doing the most common instrumentation steps.
The docs for instrumentation libraries exists here. Is there something missing that you would like to see?
That's not what I am after, I am asking for the docs on how to use the API to instrument something (something that is not in the list in your link).
@yurishkuro Just confirming you're looking for documentation that would help instrumentation library authors write their instrumentation libraries for common use-cases?
Yes, as well as regular users who want to instrument their code directly. I had people reaching out asking about how to do that and I could not find documentation to point them to.
Again, this is the OpenTracing version of similar documentation: https://github.com/opentracing/opentracing-python#usage
👍 It's hard to follow
Some stuff exists for manual instrumentation on opentelemetry.io,
- https://opentelemetry.io/docs/instrumentation/python/cookbook/#manually-setting-span-context (source
content/en/docs/instrumentation/python/cookbook.md#manually-setting-span-context) - https://opentelemetry.io/docs/instrumentation/python/manual/ (source
content/en/docs/instrumentation/python/manual.md)
There are some sporadic examples in readthedocs like https://opentelemetry-python.readthedocs.io/en/latest/api/propagate.html on how to extract/inject.
