Skip to content

Commit

Permalink
MeterProvider doc improvement and minor link fixes (#2975)
Browse files Browse the repository at this point in the history
* MeterProvider doc improvement and minor link fixes

* commas
  • Loading branch information
cijothomas authored Mar 5, 2022
1 parent ffffe5c commit c1d49df
Show file tree
Hide file tree
Showing 9 changed files with 16 additions and 9 deletions.
9 changes: 8 additions & 1 deletion docs/metrics/getting-started/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,11 +54,18 @@ instance named "MyCompany.MyProduct.MyLibrary" and then creates a
instrument from it. This counter is used to report several metric measurements.

An OpenTelemetry
[MeterProvider](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/api.md#meterprovider)
[MeterProvider](#meterprovider)
is configured to subscribe to instruments from the Meter
`MyCompany.MyProduct.MyLibrary`, and aggregate the measurements in-memory. The
pre-aggregated metrics are exported to a `ConsoleExporter`.

## MeterProvider

As shown in the above program, a valid `MeterProvider` must be configured and
built to collect metrics with OpenTelemetry .NET SDK. `MeterProvider` holds all
the configuration for metrics like `Meter` names, readers, etc. and is highly
[customizable](../customizing-the-sdk/README.md#meterprovider-configuration).

## OpenTelemetry .NET special note

Metrics in OpenTelemetry .NET is a somewhat unique implementation of the
Expand Down
2 changes: 1 addition & 1 deletion docs/trace/getting-started/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ is configured to subscribe to the activities from the source

As shown in the above program, a valid `TracerProvider` must be configured and
built to collect traces with OpenTelemetry .NET SDK. `TracerProvider` holds all
the configuration for tracing like samplers, processors, etc, and is highly
the configuration for tracing like samplers, processors, etc. and is highly
[customizable](../../../src/OpenTelemetry/README.md#tracing-configuration).

## OpenTelemetry .NET and relation with .NET Activity API
Expand Down
2 changes: 1 addition & 1 deletion src/OpenTelemetry.Api/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -509,7 +509,7 @@ This component uses an
[EventSource](https://docs.microsoft.com/dotnet/api/system.diagnostics.tracing.eventsource)
with the name "OpenTelemetry-Api" for its internal logging.
Please refer to [SDK
troubleshooting](../opentelemetry/README.md#troubleshooting) for instructions on
troubleshooting](../OpenTelemetry/README.md#troubleshooting) for instructions on
seeing these internal logs.

## References
Expand Down
2 changes: 1 addition & 1 deletion src/OpenTelemetry.Exporter.Jaeger/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ export requests.
This component uses an
[EventSource](https://docs.microsoft.com/dotnet/api/system.diagnostics.tracing.eventsource)
with the name "OpenTelemetry-Exporter-Jaeger" for its internal logging. Please
refer to [SDK troubleshooting](../opentelemetry/README.md#troubleshooting) for
refer to [SDK troubleshooting](../OpenTelemetry/README.md#troubleshooting) for
instructions on seeing these internal logs.

## References
Expand Down
2 changes: 1 addition & 1 deletion src/OpenTelemetry.Exporter.OpenTelemetryProtocol/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ This component uses an
[EventSource](https://docs.microsoft.com/dotnet/api/system.diagnostics.tracing.eventsource)
with the name "OpenTelemetry-Exporter-OpenTelemetryProtocol" for its internal
logging. Please refer to [SDK
troubleshooting](../opentelemetry/README.md#troubleshooting) for instructions on
troubleshooting](../OpenTelemetry/README.md#troubleshooting) for instructions on
seeing these internal logs.

## References
Expand Down
2 changes: 1 addition & 1 deletion src/OpenTelemetry.Exporter.Prometheus/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ This component uses an
[EventSource](https://docs.microsoft.com/dotnet/api/system.diagnostics.tracing.eventsource)
with the name "OpenTelemetry-Exporter-Prometheus" for its internal logging.
Please refer to [SDK
troubleshooting](../opentelemetry/README.md#troubleshooting) for instructions on
troubleshooting](../OpenTelemetry/README.md#troubleshooting) for instructions on
seeing these internal logs.

## References
Expand Down
2 changes: 1 addition & 1 deletion src/OpenTelemetry.Exporter.Zipkin/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ export requests.
This component uses an
[EventSource](https://docs.microsoft.com/dotnet/api/system.diagnostics.tracing.eventsource)
with the name "OpenTelemetry-Exporter-Zipkin" for its internal logging. Please
refer to [SDK troubleshooting](../opentelemetry/README.md#troubleshooting) for
refer to [SDK troubleshooting](../OpenTelemetry/README.md#troubleshooting) for
instructions on seeing these internal logs.

## References
Expand Down
2 changes: 1 addition & 1 deletion src/OpenTelemetry.Instrumentation.AspNetCore/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@ This component uses an
[EventSource](https://docs.microsoft.com/dotnet/api/system.diagnostics.tracing.eventsource)
with the name "OpenTelemetry-Instrumentation-AspNetCore" for its internal
logging. Please refer to [SDK
troubleshooting](../opentelemetry/README.md#troubleshooting) for instructions on
troubleshooting](../OpenTelemetry/README.md#troubleshooting) for instructions on
seeing these internal logs.

## References
Expand Down
2 changes: 1 addition & 1 deletion src/OpenTelemetry.Instrumentation.Http/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -227,7 +227,7 @@ This component uses an
[EventSource](https://docs.microsoft.com/dotnet/api/system.diagnostics.tracing.eventsource)
with the name "OpenTelemetry-Instrumentation-Http" for its internal logging.
Please refer to [SDK
troubleshooting](../opentelemetry/README.md#troubleshooting) for instructions on
troubleshooting](../OpenTelemetry/README.md#troubleshooting) for instructions on
seeing these internal logs.

## References
Expand Down

0 comments on commit c1d49df

Please sign in to comment.