docs: add docs with differences from the APM Python agent #206
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 :) |
colleenmcginnis
left a comment
colleenmcginnis
left a comment
There was a problem hiding this comment.
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.
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.
I would prefer to get these from support / product people instead of github users though 😅
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]>
akhileshpok
left a comment
akhileshpok
left a comment
There was a problem hiding this comment.
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. |
docs/migrate-from-apm.md
Outdated
|
|
||
| ## Bold on autoinstrumentation | ||
|
|
||
| We have chosen to make autoinstrumentation as simple as possible so you can just focus on your code; we favored an experience that requires minimal changes to your application code. The upstream OpenTelemetry configuration has more options than the distribution requires. |
There was a problem hiding this comment.
What if the reader wants to know how to make use of the upstream configuration of what we consider not required? Do we want to add some instructions or a link to a page with instructions here?
There was a problem hiding this comment.
We list our configuration in the README (https://github.com/elastic/elastic-otel-python?tab=readme-ov-file#configuration), I can link it here.
Co-authored-by: Emily S <[email protected]>
5 participants
What does this pull request do?
Document some of the differences between the APM Python agent and EDOT.
Related issues
Closes #123