Minor doc fixes across all components (#3879)

This commit is contained in:
Cijo Thomas 2022-11-09 13:05:52 -05:00 committed by GitHub
parent d9e08386bb
commit a5e5ed8705
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
10 changed files with 25 additions and 28 deletions

View File

@ -2,6 +2,7 @@
"cSpell.words": [ "cSpell.words": [
"appsettings", "appsettings",
"asax", "asax",
"bankwar",
"cijo", "cijo",
"cncf", "cncf",
"codebases", "codebases",
@ -50,6 +51,7 @@
"unencrypted", "unencrypted",
"unvalidated", "unvalidated",
"utkarsh", "utkarsh",
"vishwesh",
"xunit", "xunit",
"zipkin", "zipkin",
"zpages" "zpages"

View File

@ -70,8 +70,10 @@ libraries](https://github.com/open-telemetry/opentelemetry-specification/blob/ma
* [Prometheus AspNetCore](./src/OpenTelemetry.Exporter.Prometheus.AspNetCore/README.md) * [Prometheus AspNetCore](./src/OpenTelemetry.Exporter.Prometheus.AspNetCore/README.md)
* [Zipkin](./src/OpenTelemetry.Exporter.Zipkin/README.md) * [Zipkin](./src/OpenTelemetry.Exporter.Zipkin/README.md)
See the [OpenTelemetry registry](https://opentelemetry.io/registry/?s=net) for See the [OpenTelemetry registry](https://opentelemetry.io/registry/?s=net) and
more exporters. [OpenTelemetry .NET Contrib
repo](https://github.com/open-telemetry/opentelemetry-dotnet-contrib) for more
components.
## Extensibility ## Extensibility

View File

@ -137,7 +137,7 @@ Processors/Exporters see the same data.
The recommended way of instrumenting is by using the [.NET Activity The recommended way of instrumenting is by using the [.NET Activity
API](#instrumenting-a-libraryapplication-with-net-activity-api). Users are API](#instrumenting-a-libraryapplication-with-net-activity-api). Users are
required to just take dependency on the required to just take dependency on the
[DiagnosticSource](https://www.nuget.org/packages/System.Diagnostics.DiagnosticSource/5.0.0). [DiagnosticSource](https://www.nuget.org/packages/System.Diagnostics.DiagnosticSource).
Adding dependency to Adding dependency to
[OpenTelemetry.API](https://www.nuget.org/packages/opentelemetry.api) is [OpenTelemetry.API](https://www.nuget.org/packages/opentelemetry.api) is
required only for the following scenarios: required only for the following scenarios:
@ -160,7 +160,7 @@ required only for the following scenarios:
[Context propagation](#context-propagation) section. [Context propagation](#context-propagation) section.
3. You want to leverage 3. You want to leverage
[Baggage](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/baggage/api.md) [Baggage](#baggage-api)
API. API.
## Instrumenting a library/application with .NET Activity API ## Instrumenting a library/application with .NET Activity API
@ -172,16 +172,11 @@ is the .NET `Activity` API. Guidance for instrumenting using this API is
documented fully in the TBD(dotnet activity user guide link), but is described documented fully in the TBD(dotnet activity user guide link), but is described
here as well. here as well.
1. Install the `System.Diagnostics.DiagnosticSource` package version `5.0.1` or 1. Install the latest stable `System.Diagnostics.DiagnosticSource` to your
above to your application or library. application or library.
```xml ```shell
<ItemGroup> dotnet add package System.Diagnostics.DiagnosticSource
<PackageReference
Include="System.Diagnostics.DiagnosticSource"
Version="5.0.1"
/>
</ItemGroup>
``` ```
2. Create an `ActivitySource`, providing the name and version of the 2. Create an `ActivitySource`, providing the name and version of the
@ -462,7 +457,7 @@ context.
Metrics in OpenTelemetry .NET are a somewhat unique implementation of the Metrics in OpenTelemetry .NET are a somewhat unique implementation of the
OpenTelemetry project, as the Metrics API is incorporated directly into the .NET OpenTelemetry project, as the Metrics API is incorporated directly into the .NET
runtime itself, as part of the runtime itself, as part of the
[`System.Diagnostics.DiagnosticSource`](https://www.nuget.org/packages/System.Diagnostics.DiagnosticSource/6.0.0) [`System.Diagnostics.DiagnosticSource`](https://www.nuget.org/packages/System.Diagnostics.DiagnosticSource)
package. This means, users can instrument their applications/libraries to emit package. This means, users can instrument their applications/libraries to emit
metrics by simply using the `System.Diagnostics.DiagnosticSource` package. This metrics by simply using the `System.Diagnostics.DiagnosticSource` package. This
package can be used in applications targeting any of the officially supported package can be used in applications targeting any of the officially supported
@ -474,13 +469,11 @@ Windows-based .NET implementation).
### Basic metric usage ### Basic metric usage
1. Install the `System.Diagnostics.DiagnosticSource` package version `6.0.0` or 1. Install the latest stable version of `System.Diagnostics.DiagnosticSource` to
above to your application or library. your application or library.
```xml ```shell
<ItemGroup> dotnet add package System.Diagnostics.DiagnosticSource
<PackageReference Include="System.Diagnostics.DiagnosticSource" Version="6.0.0" />
</ItemGroup>
``` ```
2. Create a `Meter`, providing the name and version of the library/application 2. Create a `Meter`, providing the name and version of the library/application
@ -520,7 +513,7 @@ describes more kinds of instruments.
### Instrument types ### Instrument types
// TODO - add all instruments. See [this](../../docs/metrics/learning-more-instruments/README.md).
## Troubleshooting ## Troubleshooting

View File

@ -6,7 +6,7 @@
## Installation ## Installation
```shell ```shell
dotnet add package OpenTelemetry.Exporter.ZPages dotnet add package --prerelease OpenTelemetry.Exporter.ZPages
``` ```
## Configuration ## Configuration

View File

@ -6,7 +6,7 @@
## Installation ## Installation
```shell ```shell
dotnet add package OpenTelemetry.Extensions.Hosting dotnet add package --prerelease OpenTelemetry.Extensions.Hosting
``` ```
## Usage ## Usage

View File

@ -31,7 +31,7 @@ Add a reference to the
package. Also, add any other instrumentations & exporters you will need. package. Also, add any other instrumentations & exporters you will need.
```shell ```shell
dotnet add package OpenTelemetry.Instrumentation.AspNetCore dotnet add package --prerelease OpenTelemetry.Instrumentation.AspNetCore
``` ```
### Step 2: Enable ASP.NET Core Instrumentation at application startup ### Step 2: Enable ASP.NET Core Instrumentation at application startup

View File

@ -32,7 +32,7 @@ Add a reference to the
package. Also, add any other instrumentations & exporters you will need. package. Also, add any other instrumentations & exporters you will need.
```shell ```shell
dotnet add package OpenTelemetry.Instrumentation.GrpcNetClient dotnet add package --prerelease OpenTelemetry.Instrumentation.GrpcNetClient
``` ```
### Step 2: Enable Grpc.Net.Client Instrumentation at application startup ### Step 2: Enable Grpc.Net.Client Instrumentation at application startup

View File

@ -33,7 +33,7 @@ Add a reference to the
package. Also, add any other instrumentations & exporters you will need. package. Also, add any other instrumentations & exporters you will need.
```shell ```shell
dotnet add package OpenTelemetry.Instrumentation.Http dotnet add package --prerelease OpenTelemetry.Instrumentation.Http
``` ```
### Step 2: Enable HTTP Instrumentation at application startup ### Step 2: Enable HTTP Instrumentation at application startup

View File

@ -30,7 +30,7 @@ Add a reference to the
package. Also, add any other instrumentations & exporters you will need. package. Also, add any other instrumentations & exporters you will need.
```shell ```shell
dotnet add package OpenTelemetry.Instrumentation.SqlClient dotnet add package --prerelease OpenTelemetry.Instrumentation.SqlClient
``` ```
### Step 2: Enable SqlClient Instrumentation at application startup ### Step 2: Enable SqlClient Instrumentation at application startup

View File

@ -13,7 +13,7 @@ OpenTracing Tracer providing a compatible shim on top of the OpenTelemetry API.
## Installation ## Installation
```shell ```shell
dotnet add package OpenTelemetry.Shims.OpenTracing dotnet add package --prerelease OpenTelemetry.Shims.OpenTracing
``` ```
See See