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

[HttpClient & Asp.Net Core] Update Readme.md #5168

Merged
merged 13 commits into from
Dec 14, 2023

Conversation

vishweshbankwar
Copy link
Member

Fixes #
Design discussion issue #

Changes

Please provide a brief description of the changes here.

Merge requirement checklist

  • CONTRIBUTING guidelines followed (nullable enabled, static analysis, etc.)
  • Unit tests added/updated
  • Appropriate CHANGELOG.md files updated for non-trivial changes
  • Changes in public API reviewed (if applicable)

@vishweshbankwar vishweshbankwar changed the title [HttpClient & Asp.Net Core] Update readme's [HttpClient & Asp.Net Core] Update Readme.md Dec 13, 2023
@vishweshbankwar vishweshbankwar marked this pull request as ready for review December 13, 2023 21:59
@vishweshbankwar vishweshbankwar requested a review from a team December 13, 2023 21:59
[v1.23](https://github.com/open-telemetry/semantic-conventions/tree/v1.23.0/docs/http)
of http semantic conventions.

Following list of attributes are added by default on activity. See
Copy link
Member

Choose a reason for hiding this comment

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

split it under tracing, metrics heading separately to make it easy to follow.

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 moved it under traces and metrics below. Please check if that will be more clear.


gRPC instrumentation can be enabled by setting
`OTEL_DOTNET_EXPERIMENTAL_ASPNETCORE_ENABLE_GRPC_INSTRUMENTATION` flag to
`True`. The flag can be set as an environment variable or via IConfiguration as
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: Use the same casing throughout the doc. The code snippet below uses true.

@@ -66,6 +61,26 @@ public void ConfigureServices(IServiceCollection services)
}
```

Following list of attributes are added by default on activity. See
Copy link
Contributor

@utpilla utpilla Dec 14, 2023

Choose a reason for hiding this comment

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

A lot of these attributes are only added when they are available. For example, error.type, user_agent.original etc.

Suggested change
Following list of attributes are added by default on activity. See
When available, the following list of attributes are added by default on activity. See

@@ -65,6 +57,22 @@ public class Program
}
```

Following list of attributes are added by default on activity. See
Copy link
Contributor

Choose a reason for hiding this comment

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

@utpilla utpilla merged commit 4842364 into open-telemetry:main Dec 14, 2023
42 checks passed
@utpilla
Copy link
Contributor

utpilla commented Dec 14, 2023

@vishweshbankwar Left some suggestions that could be addressed in a follow-up PR.

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.

4 participants