opentelemetry-js icon indicating copy to clipboard operation
opentelemetry-js copied to clipboard

Enhance Documentation on Instrumentation Outcomes for HTTP Package

Open create2000 opened this issue 1 year ago • 2 comments
trafficstars

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 avatar Oct 06 '24 16:10 create2000

CLA Signed

The committers listed above are authorized under a signed CLA.

  • :white_check_mark: login: create2000 / name: Onah_Anthony (daaa9406c92ce39ab7898610de78aac8618f3a74, d8dd74c9581e46f307c39de66594f79311e9a3c4, 63617be642de0de908e70cd155cae2c0795edffc, 422f86d36beed03ca2d36daac08ab8ba70cab260, 445c69599eb7ad266e2dedc80f00ddccbad74ff1, 3103adfe357bb98d35d0ee69fce1f8d7085214b0, a6acf9ca25ab2bd9038be73b6d8238ddbe3c7c75, 92e2fee65005a05acba165fad3c9e03ca79b0a9f)

Thank you @pichlermarc . I have done the corrections.

create2000 avatar Oct 09 '24 15:10 create2000

This PR is stale because it has been open 60 days with no activity. Remove stale label or comment or this will be closed in 14 days.

github-actions[bot] avatar Dec 09 '24 06:12 github-actions[bot]

This PR was closed because it has been stale for 14 days with no activity.

github-actions[bot] avatar Jan 20 '25 06:01 github-actions[bot]