open-telemetry
/
opentelemetry-dotnet
mirror of https://github.com/open-telemetry/opentelemetry-dotnet.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Minor metric doc fixes (#2715)

This commit is contained in:
Cijo Thomas 2021-11-30 14:25:29 -08:00 committed by GitHub
parent 7fff1cb44a
commit c573a8f42b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 25 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
docs/metrics/customizing-the-sdk/README.md
View File

@ -229,7 +229,6 @@ By default, the boundaries used for a Histogram are [`{ 0, 5, 10, 25, 50, 75, 10
Views can be used to provide custom boundaries for a Histogram. The measurements
are then aggregated using the custom boundaries provided instead of the the
default boundaries. This requires the use of `ExplicitBucketHistogramConfiguration`.
[Monday 08:36 PM] Reiley Yang
<!-- markdownlint-disable MD013 -->
```csharp
@ -269,7 +268,7 @@ default boundaries. This requires the use of `ExplicitBucketHistogramConfigurati
```
**NOTE:** The SDK currently does not support any changes to `Aggregation` type
for Views.
by using Views.
See [Program.cs](./Program.cs) for a complete example.
@ -321,7 +320,24 @@ this moment.
### MetricReader
// TODO
[MetricReader](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk.md#metricreader)
allows collecting the pre-aggregated metrics from the SDK. They are typically
paired with a
[MetricExporter](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk.md#metricexporter)
which does the actual export of metrics.
Though `MetricReader` can be added by using the `AddReader` method on
`MeterProviderBuilder`, most users use the extension methods on
`MeterProviderBuilder` offered by exporter libraries, which adds the correct
`MetricReader`, that is configured to export metrics to the exporter.
Refer to the individual exporter docs to learn how to use them:
* [Console](../../../src/OpenTelemetry.Exporter.Console/README.md)
* [In-memory](../../../src/OpenTelemetry.Exporter.InMemory/README.md)
* [OTLP](../../../src/OpenTelemetry.Exporter.OpenTelemetryProtocol/README.md)
(OpenTelemetry Protocol)
* [Prometheus](../../../src/OpenTelemetry.Exporter.Prometheus/README.md)
### Resource

12
src/OpenTelemetry.Exporter.Console/README.md
View File

@ -4,7 +4,7 @@
[![NuGet](https://img.shields.io/nuget/dt/OpenTelemetry.Exporter.Console.svg)](https://www.nuget.org/packages/OpenTelemetry.Exporter.Console)
The console exporter prints data to the Console window.
ConsoleExporter supports exporting both traces and logs.
ConsoleExporter supports exporting logs, metrics and traces.
**Note:** this exporter is intended to be used during learning how telemetry
data are created and exported. It is not recommended for any production
@ -16,12 +16,12 @@ environment.
dotnet add package OpenTelemetry.Exporter.Console
```
See the
[`TestConsoleExporter.cs`](../../examples/Console/TestConsoleExporter.cs) for an
example of how to use the exporter for exporting traces.
See the individual "getting started" examples depending on the signal being
used:
See the [Program](../../docs/logs/getting-started/Program.cs) for
an example of how to use the exporter for exporting logs.
* [Logs](../../docs/logs/getting-started/Program.cs)
* [Metrics](../../docs/metrics/getting-started/Program.cs)
* [Traces](../../docs/trace/getting-started/Program.cs)
## References