Enhance Documentation on Instrumentation Outcomes for HTTP Package #5042
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
JacksonWeber
reviewed
Oct 7, 2024
…documentation git push origin improve-docs
pichlermarc
reviewed
Oct 8, 2024
| | `net.peer.name` | The DNS name or IP address of the remote client | | ||
| | `net.peer.port` | The port of the remote peer | | ||
| | `peer.service` | The name of the remote service | | ||
| | `service.name` | Name of the service that generated the span | |
There was a problem hiding this comment.
I don't think we set service name in this instrumentation - that's a resource attribute.
| | `net.peer.ip` | The IP address of the remote client | | ||
| | `net.peer.name` | The DNS name or IP address of the remote client | | ||
| | `net.peer.port` | The port of the remote peer | | ||
| | `peer.service` | The name of the remote service | |
There was a problem hiding this comment.
I don't think peer.service is set by our instrumentation.
| @@ -44,6 +43,7 @@ registerInstrumentations({ | |||
| instrumentations: [new HttpInstrumentation()], | |||
| }); | |||
|
|
|||
|
|
|||
|
|
||
| ## Installation | ||
|
|
||
| ```bash | ||
| npm install --save @opentelemetry/instrumentation-http | ||
| ``` | ||
|
|
|
|
||
| ``` |
| @@ -48,7 +48,7 @@ | |||
| "access": "public" | |||
| }, | |||
| "devDependencies": { | |||
| "@opentelemetry/api": "1.9.0", | |||
| "@opentelemetry/api": "^1.9.0", | |||
There was a problem hiding this comment.
I think the changes to this file are unintentional.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
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