Skip to content
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

Open
wants to merge 17 commits into
base: main
Choose a base branch
from

Conversation

xrmx
Copy link
Member

@xrmx xrmx commented Dec 5, 2024

What does this pull request do?

Document some of the differences between the APM Python agent and EDOT.

Related issues

Closes #123

@xrmx xrmx requested a review from estolfo December 5, 2024 11:24
docs/migrate-from-apm.md Outdated Show resolved Hide resolved
docs/migrate-from-apm.md Outdated Show resolved Hide resolved
docs/migrate-from-apm.md Outdated Show resolved Hide resolved
docs/migrate-from-apm.md Outdated Show resolved Hide resolved
docs/migrate-from-apm.md Outdated Show resolved Hide resolved
docs/migrate-from-apm.md Outdated Show resolved Hide resolved
docs/migrate-from-apm.md Outdated Show resolved Hide resolved
docs/migrate-from-apm.md Outdated Show resolved Hide resolved
@xrmx
Copy link
Member Author

xrmx commented Dec 9, 2024

@akhileshpok Would appreciate a review of this from your point of view. Maybe we are overpromising :)

docs/migrate-from-apm.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Copy link
Contributor

@colleenmcginnis colleenmcginnis left a 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!

docs/migrate-from-apm.md Outdated Show resolved Hide resolved
docs/migrate-from-apm.md Outdated Show resolved Hide resolved
docs/migrate-from-apm.md Outdated Show resolved Hide resolved
docs/migrate-from-apm.md Outdated Show resolved Hide resolved
docs/migrate-from-apm.md Outdated Show resolved Hide resolved
docs/migrate-from-apm.md Outdated Show resolved Hide resolved
docs/migrate-from-apm.md Outdated Show resolved Hide resolved

### 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.
Copy link
Contributor

@colleenmcginnis colleenmcginnis Dec 10, 2024

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?

Suggested change
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).

Copy link
Member Author

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

Copy link
Contributor

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?

Suggested change
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).

Copy link
Member Author

@xrmx xrmx Dec 11, 2024

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.

xrmx and others added 7 commits December 11, 2024 12:05
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]>
Copy link

@akhileshpok akhileshpok left a 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

@xrmx
Copy link
Member Author

xrmx commented Jan 17, 2025

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.

@xrmx xrmx requested a review from estolfo January 17, 2025 14:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

migration plan and guide from classic agent
4 participants