Add basic docs for Metrics api and sdk #2452
Conversation
|
|
||
| See [Program.cs](./Program.cs) for complete example. | ||
|
|
||
| **Note** |
|
|
||
| ### Basic metric usage | ||
|
|
||
| 1. Install the `System.Diagnostics.DiagnosticSource` package version |
There was a problem hiding this comment.
Is this going to be the only way to instrument applications, or is it still possible to include the OpenTelemetry.Api package?
There was a problem hiding this comment.
the only way. There are no plans to add shim/wrapper around this in the API package.
There was a problem hiding this comment.
So that means that if I want to add metrics to my library, I need to take a dep on the DiagnosticSource package and not OTel? I can see why since this is "built-in", but I feel it would be also good to have a wrapper. For example, people coming from other languages have to learn, yet this new thing which is not so obvious. 🤔
There was a problem hiding this comment.
If you take a dependency on Otel.API, then it automatically brings in DS package.
This is the same model we use for tracing (and logging) as well.
We added wrapper for tracing, because the Activity API had lot of naming differences (because Activity existed before OTel came into existence.), and many folks felt the need for a wrapper.
Metric API in .NET was built ground up, closely following OTel spec, so there are not many differences, warranting the cost of maintaining another wrapper. Having said that, if there is any strong reason to have a wrapper - please create an issue and we can discuss more.
|
Thanks @joaopgrassi @pirgeo @utpilla for reviews! I have resolved all comments. If I can get another review, that'd be great before merge! |
|
Merging to make progress .. Happy to take any additional comments in follow ups! |
To be expanded with more contents later.