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

Enhance Documentation on Instrumentation Outcomes for HTTP Package #5042

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

Conversation

create2000
Copy link

Which problem is this PR solving?

The main documentation for the opentelemetry-instrumentation-http package did not adequately specify what metrics and telemetry would be produced by the instrumentation. This lack of information could lead to confusion among users, making it difficult for them to understand the capabilities and outputs of the package.

Fixes #2839

Type of change

  • Updated the README.md file to include detailed explanations of the metrics and telemetry generated by the instrumentation.

  • Provided examples and context to help users better understand the implications and usage of the generated data.

Please delete options that are not relevant.

  • This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

  • Documentation has been updated

@create2000 create2000 requested a review from a team as a code owner October 6, 2024 16:47
Copy link

linux-foundation-easycla bot commented Oct 6, 2024

CLA Signed

The committers listed above are authorized under a signed CLA.

Copy link
Member

@pichlermarc pichlermarc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's a new submodule org and a new git file, that I think got there by accident. Could you remove them?

@@ -48,7 +48,7 @@
"access": "public"
},
"devDependencies": {
"@opentelemetry/api": "1.9.0",
"@opentelemetry/api": "^1.9.0",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the changes to this file are unintentional.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

changes in this file should not be needed for a README.md update.

@create2000
Copy link
Author

Thank you @pichlermarc . I have done the corrections.

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.

Reliable documentation on generated telemetry
3 participants