Add README for Metrics #4528
Merged
Add README for Metrics #4528
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
reyang
reviewed
May 30, 2023
cijothomas
reviewed
May 30, 2023
cijothomas
reviewed
May 30, 2023
reyang
reviewed
May 30, 2023
reyang
reviewed
May 30, 2023
cijothomas
reviewed
May 30, 2023
reyang
reviewed
May 30, 2023
reyang
reviewed
May 30, 2023
cijothomas
reviewed
May 30, 2023
cijothomas
reviewed
May 30, 2023
cijothomas
reviewed
May 30, 2023
cijothomas
approved these changes
May 30, 2023
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## main #4528 +/- ##
==========================================
- Coverage 85.13% 85.11% -0.03%
==========================================
Files 318 318
Lines 12620 12620
==========================================
- Hits 10744 10741 -3
- Misses 1876 1879 +3 |
cijothomas
reviewed
May 31, 2023
| - Instruments SHOULD only be created once and reused throughout the application | ||
| lifetime. This | ||
| [example](../../docs/metrics/getting-started-console/Program.cs) shows how an | ||
| instrument is created a `static` field and then used in the application. You |
There was a problem hiding this comment.
Suggested change
| instrument is created a `static` field and then used in the application. You | |
| instrument is created and stored in a `static` field and then used in the application. You |
cijothomas
reviewed
May 31, 2023
| instrument is created a `static` field and then used in the application. You | ||
| could also look at this ASP .NET Core | ||
| [example](../../examples/AspNetCore/Program.cs) which shows a more Dependency | ||
| Injection friendly way of doing this by extracting the `Meter` and an |
There was a problem hiding this comment.
which shows a more Dependency Injection friendly way of doing this. -> I think this much is sufficient, to avoid too much details here.
reyang
reviewed
May 31, 2023
| a single MeterProvider is built at application startup, and is disposed of at | ||
| application shutdown. For an ASP.NET Core application, use `AddOpenTelemetry` | ||
| and `WithMetrics` methods from the `OpenTelemetry.Extensions.Hosting` package | ||
| to correctly setup `MeterProvider`. Here's a [sample ASP .NET Core |
There was a problem hiding this comment.
sample -> example
ASP .NET -> ASP.NET
reyang
reviewed
May 31, 2023
| and `WithMetrics` methods from the `OpenTelemetry.Extensions.Hosting` package | ||
| to correctly setup `MeterProvider`. Here's a [sample ASP .NET Core | ||
| app](../../examples/AspNetCore/Program.cs) for reference. For simpler | ||
| applications such as Console apps, refer to this |
There was a problem hiding this comment.
Suggested change
| applications such as Console apps, refer to this | |
| applications such as console apps, refer to this |
cijothomas
reviewed
May 31, 2023
| [doc](../../docs/metrics/customizing-the-sdk/README.md#changing-maximum-metricpoints-per-metricstream) | ||
| for more information. The SDK would not process any newer unique key-value | ||
| combination that it encounters, once this limit is reached. | ||
| - MeterProvider is disposed. You need to ensure that the `MeterProvider` |
There was a problem hiding this comment.
Suggested change
| - MeterProvider is disposed. You need to ensure that the `MeterProvider` | |
| - MeterProvider is disposed incorrectly/earlier than desired. You need to ensure that the `MeterProvider` |
cijothomas
reviewed
May 31, 2023
| to correctly setup `MeterProvider`. Here's a [sample ASP .NET Core | ||
| app](../../examples/AspNetCore/Program.cs) for reference. For simpler | ||
| applications such as Console apps, refer to this | ||
| [example](../../docs/metrics/getting-started-console/Program.cs). |
There was a problem hiding this comment.
also show asp.net example from controib repo.
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.
Changes