-
Notifications
You must be signed in to change notification settings - Fork 4
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
docs: add docs with differences from the APM Python agent #206
base: main
Are you sure you want to change the base?
Conversation
Co-authored-by: Emily S <[email protected]>
Co-authored-by: Emily S <[email protected]>
Co-authored-by: Emily S <[email protected]>
Co-authored-by: Emily S <[email protected]>
Co-authored-by: Emily S <[email protected]>
@akhileshpok Would appreciate a review of this from your point of view. Maybe we are overpromising :) |
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.
I left some suggestions below. Feel free to take them or leave them as you see fit!
|
||
### Missing instrumentations | ||
|
||
Not all instrumentations we have in Elastic APM Python Agent have an OpenTelemetry counterpart. But we may port them if they are requested by users. |
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.
Can we be more specific about how to request additional instrumentations? Maybe opening an issue using the feature request template?
Not all instrumentations we have in Elastic APM Python Agent have an OpenTelemetry counterpart. But we may port them if they are requested by users. | |
Not all instrumentations we have in the Elastic APM Python agent have an OpenTelemetry counterpart. If you would like to see a specific instrumentation ported to OpenTelemetry, submit a [feature request](https://github.com/elastic/elastic-otel-python/issues/new?template=Feature_request.md). |
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.
I would prefer to get these from support / product people instead of github users though 😅
- pymssql | ||
- Sanic | ||
- zlib | ||
|
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.
At the moment of writing these docs
Since we're suggesting these docs may become out of date, can we also point them somewhere to see the latest list of libraries with an OpenTelemetry instrumentation? Maybe https://github.com/open-telemetry/opentelemetry-python-contrib/tree/main/instrumentation#readme? Or is there somewhere in the code in this repo?
For the latest list of supported OpenTelemetry instrumentations, visit the [OpenTelemetry Python Contrib repo](https://github.com/open-telemetry/opentelemetry-python-contrib/tree/main/instrumentation#readme). | |
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.
I see the issue but we may decide to not ship some of them or ship some instrumentations that are not available there. So I prefer to don't link it.
Co-authored-by: Colleen McGinnis <[email protected]>
Co-authored-by: Colleen McGinnis <[email protected]>
Co-authored-by: Colleen McGinnis <[email protected]>
Co-authored-by: Colleen McGinnis <[email protected]>
Co-authored-by: Colleen McGinnis <[email protected]>
Co-authored-by: Colleen McGinnis <[email protected]>
Co-authored-by: Colleen McGinnis <[email protected]>
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.
Are there any other features that are only supported in the classic Python Agent, e.g., compressed spans? We should list any feature that is only supported in the classic Python Agent in this doc as well. Thanks
Updated the document with missing integration with structured logging, span compression and breakdown metrics. |
What does this pull request do?
Document some of the differences between the APM Python agent and EDOT.
Related issues
Closes #123