From a5e5ed8705e46d63102fb3026df6c891a3ea61fd Mon Sep 17 00:00:00 2001 From: Cijo Thomas Date: Wed, 9 Nov 2022 13:05:52 -0500 Subject: [PATCH] Minor doc fixes across all components (#3879) --- .vscode/settings.json | 2 ++ README.md | 6 ++-- src/OpenTelemetry.Api/README.md | 31 +++++++------------ src/OpenTelemetry.Exporter.ZPages/README.md | 2 +- .../README.md | 2 +- .../README.md | 2 +- .../README.md | 2 +- .../README.md | 2 +- .../README.md | 2 +- src/OpenTelemetry.Shims.OpenTracing/README.md | 2 +- 10 files changed, 25 insertions(+), 28 deletions(-) diff --git a/.vscode/settings.json b/.vscode/settings.json index 803118863..b94b3d367 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -2,6 +2,7 @@ "cSpell.words": [ "appsettings", "asax", + "bankwar", "cijo", "cncf", "codebases", @@ -50,6 +51,7 @@ "unencrypted", "unvalidated", "utkarsh", + "vishwesh", "xunit", "zipkin", "zpages" diff --git a/README.md b/README.md index 5ef0b03e1..d08395c84 100644 --- a/README.md +++ b/README.md @@ -70,8 +70,10 @@ libraries](https://github.com/open-telemetry/opentelemetry-specification/blob/ma * [Prometheus AspNetCore](./src/OpenTelemetry.Exporter.Prometheus.AspNetCore/README.md) * [Zipkin](./src/OpenTelemetry.Exporter.Zipkin/README.md) -See the [OpenTelemetry registry](https://opentelemetry.io/registry/?s=net) for -more exporters. +See the [OpenTelemetry registry](https://opentelemetry.io/registry/?s=net) and +[OpenTelemetry .NET Contrib +repo](https://github.com/open-telemetry/opentelemetry-dotnet-contrib) for more +components. ## Extensibility diff --git a/src/OpenTelemetry.Api/README.md b/src/OpenTelemetry.Api/README.md index 26da26442..7148cbf89 100644 --- a/src/OpenTelemetry.Api/README.md +++ b/src/OpenTelemetry.Api/README.md @@ -137,7 +137,7 @@ Processors/Exporters see the same data. The recommended way of instrumenting is by using the [.NET Activity API](#instrumenting-a-libraryapplication-with-net-activity-api). Users are 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 [OpenTelemetry.API](https://www.nuget.org/packages/opentelemetry.api) is required only for the following scenarios: @@ -160,7 +160,7 @@ required only for the following scenarios: [Context propagation](#context-propagation) section. 3. You want to leverage - [Baggage](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/baggage/api.md) + [Baggage](#baggage-api) 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 here as well. -1. Install the `System.Diagnostics.DiagnosticSource` package version `5.0.1` or - above to your application or library. +1. Install the latest stable `System.Diagnostics.DiagnosticSource` to your + application or library. - ```xml - - - + ```shell + dotnet add package System.Diagnostics.DiagnosticSource ``` 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 OpenTelemetry project, as the Metrics API is incorporated directly into the .NET 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 metrics by simply using the `System.Diagnostics.DiagnosticSource` package. This package can be used in applications targeting any of the officially supported @@ -474,13 +469,11 @@ Windows-based .NET implementation). ### Basic metric usage -1. Install the `System.Diagnostics.DiagnosticSource` package version `6.0.0` or - above to your application or library. +1. Install the latest stable version of `System.Diagnostics.DiagnosticSource` to + your application or library. - ```xml - - - + ```shell + dotnet add package System.Diagnostics.DiagnosticSource ``` 2. Create a `Meter`, providing the name and version of the library/application @@ -520,7 +513,7 @@ describes more kinds of instruments. ### Instrument types -// TODO - add all instruments. +See [this](../../docs/metrics/learning-more-instruments/README.md). ## Troubleshooting diff --git a/src/OpenTelemetry.Exporter.ZPages/README.md b/src/OpenTelemetry.Exporter.ZPages/README.md index 3f9c2ee0b..28d497165 100644 --- a/src/OpenTelemetry.Exporter.ZPages/README.md +++ b/src/OpenTelemetry.Exporter.ZPages/README.md @@ -6,7 +6,7 @@ ## Installation ```shell -dotnet add package OpenTelemetry.Exporter.ZPages +dotnet add package --prerelease OpenTelemetry.Exporter.ZPages ``` ## Configuration diff --git a/src/OpenTelemetry.Extensions.Hosting/README.md b/src/OpenTelemetry.Extensions.Hosting/README.md index a1c834195..86d61283e 100644 --- a/src/OpenTelemetry.Extensions.Hosting/README.md +++ b/src/OpenTelemetry.Extensions.Hosting/README.md @@ -6,7 +6,7 @@ ## Installation ```shell -dotnet add package OpenTelemetry.Extensions.Hosting +dotnet add package --prerelease OpenTelemetry.Extensions.Hosting ``` ## Usage diff --git a/src/OpenTelemetry.Instrumentation.AspNetCore/README.md b/src/OpenTelemetry.Instrumentation.AspNetCore/README.md index d27566f04..a58018396 100644 --- a/src/OpenTelemetry.Instrumentation.AspNetCore/README.md +++ b/src/OpenTelemetry.Instrumentation.AspNetCore/README.md @@ -31,7 +31,7 @@ Add a reference to the package. Also, add any other instrumentations & exporters you will need. ```shell -dotnet add package OpenTelemetry.Instrumentation.AspNetCore +dotnet add package --prerelease OpenTelemetry.Instrumentation.AspNetCore ``` ### Step 2: Enable ASP.NET Core Instrumentation at application startup diff --git a/src/OpenTelemetry.Instrumentation.GrpcNetClient/README.md b/src/OpenTelemetry.Instrumentation.GrpcNetClient/README.md index 462f54393..9f39c155a 100644 --- a/src/OpenTelemetry.Instrumentation.GrpcNetClient/README.md +++ b/src/OpenTelemetry.Instrumentation.GrpcNetClient/README.md @@ -32,7 +32,7 @@ Add a reference to the package. Also, add any other instrumentations & exporters you will need. ```shell -dotnet add package OpenTelemetry.Instrumentation.GrpcNetClient +dotnet add package --prerelease OpenTelemetry.Instrumentation.GrpcNetClient ``` ### Step 2: Enable Grpc.Net.Client Instrumentation at application startup diff --git a/src/OpenTelemetry.Instrumentation.Http/README.md b/src/OpenTelemetry.Instrumentation.Http/README.md index d7375f467..361358417 100644 --- a/src/OpenTelemetry.Instrumentation.Http/README.md +++ b/src/OpenTelemetry.Instrumentation.Http/README.md @@ -33,7 +33,7 @@ Add a reference to the package. Also, add any other instrumentations & exporters you will need. ```shell -dotnet add package OpenTelemetry.Instrumentation.Http +dotnet add package --prerelease OpenTelemetry.Instrumentation.Http ``` ### Step 2: Enable HTTP Instrumentation at application startup diff --git a/src/OpenTelemetry.Instrumentation.SqlClient/README.md b/src/OpenTelemetry.Instrumentation.SqlClient/README.md index 7999dfe91..e91b59ef0 100644 --- a/src/OpenTelemetry.Instrumentation.SqlClient/README.md +++ b/src/OpenTelemetry.Instrumentation.SqlClient/README.md @@ -30,7 +30,7 @@ Add a reference to the package. Also, add any other instrumentations & exporters you will need. ```shell -dotnet add package OpenTelemetry.Instrumentation.SqlClient +dotnet add package --prerelease OpenTelemetry.Instrumentation.SqlClient ``` ### Step 2: Enable SqlClient Instrumentation at application startup diff --git a/src/OpenTelemetry.Shims.OpenTracing/README.md b/src/OpenTelemetry.Shims.OpenTracing/README.md index 7ed1e58cd..8c3fb6db3 100644 --- a/src/OpenTelemetry.Shims.OpenTracing/README.md +++ b/src/OpenTelemetry.Shims.OpenTracing/README.md @@ -13,7 +13,7 @@ OpenTracing Tracer providing a compatible shim on top of the OpenTelemetry API. ## Installation ```shell -dotnet add package OpenTelemetry.Shims.OpenTracing +dotnet add package --prerelease OpenTelemetry.Shims.OpenTracing ``` See