Update instrumentation readme to indicate pre-release status (#3264)
This commit is contained in:
parent
72fcbf3201
commit
9e827ece64
|
|
@ -6,7 +6,19 @@
|
|||
This is an [Instrumentation
|
||||
Library](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/glossary.md#instrumentation-library),
|
||||
which instruments [ASP.NET](https://docs.microsoft.com/aspnet/overview) and
|
||||
collect telemetry about incoming web requests.
|
||||
collect metrics and traces about incoming web requests.
|
||||
|
||||
**Note: This component is based on the OpenTelemetry semantic conventions for
|
||||
[metrics](https://github.com/open-telemetry/opentelemetry-specification/tree/main/specification/metrics/semantic_conventions)
|
||||
and
|
||||
[traces](https://github.com/open-telemetry/opentelemetry-specification/tree/main/specification/trace/semantic_conventions).
|
||||
These conventions are
|
||||
[Experimental](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/document-status.md),
|
||||
and hence, this package is a [pre-release](../../VERSIONING.md#pre-releases).
|
||||
Until a [stable
|
||||
version](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/telemetry-stability.md)
|
||||
is released, there can be breaking changes. You can track the progress from
|
||||
[milestones](https://github.com/open-telemetry/opentelemetry-dotnet/milestone/23).**
|
||||
|
||||
## Steps to enable OpenTelemetry.Instrumentation.AspNet
|
||||
|
||||
|
|
|
|||
|
|
@ -5,7 +5,17 @@
|
|||
|
||||
This is an [Instrumentation Library](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/glossary.md#instrumentation-library)
|
||||
which instruments [Grpc.Net.Client](https://www.nuget.org/packages/Grpc.Net.Client)
|
||||
and collects telemetry about outgoing gRPC requests.
|
||||
and collects traces about outgoing gRPC requests.
|
||||
|
||||
**Note: This component is based on the OpenTelemetry semantic conventions for
|
||||
[traces](https://github.com/open-telemetry/opentelemetry-specification/tree/main/specification/trace/semantic_conventions).
|
||||
These conventions are
|
||||
[Experimental](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/document-status.md),
|
||||
and hence, this package is a [pre-release](../../VERSIONING.md#pre-releases).
|
||||
Until a [stable
|
||||
version](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/telemetry-stability.md)
|
||||
is released, there can be breaking changes. You can track the progress from
|
||||
[milestones](https://github.com/open-telemetry/opentelemetry-dotnet/milestone/23).**
|
||||
|
||||
## Supported .NET Versions
|
||||
|
||||
|
|
|
|||
|
|
@ -9,7 +9,19 @@ which instruments
|
|||
[System.Net.Http.HttpClient](https://docs.microsoft.com/dotnet/api/system.net.http.httpclient)
|
||||
and
|
||||
[System.Net.HttpWebRequest](https://docs.microsoft.com/dotnet/api/system.net.httpwebrequest)
|
||||
and collects telemetry about outgoing HTTP requests.
|
||||
and collects metrics and traces about outgoing HTTP requests.
|
||||
|
||||
**Note: This component is based on the OpenTelemetry semantic conventions for
|
||||
[metrics](https://github.com/open-telemetry/opentelemetry-specification/tree/main/specification/metrics/semantic_conventions)
|
||||
and
|
||||
[traces](https://github.com/open-telemetry/opentelemetry-specification/tree/main/specification/trace/semantic_conventions).
|
||||
These conventions are
|
||||
[Experimental](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/document-status.md),
|
||||
and hence, this package is a [pre-release](../../VERSIONING.md#pre-releases).
|
||||
Until a [stable
|
||||
version](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/telemetry-stability.md)
|
||||
is released, there can be breaking changes. You can track the progress from
|
||||
[milestones](https://github.com/open-telemetry/opentelemetry-dotnet/milestone/23).**
|
||||
|
||||
## Steps to enable OpenTelemetry.Instrumentation.Http
|
||||
|
||||
|
|
|
|||
|
|
@ -9,7 +9,17 @@ which instruments
|
|||
[Microsoft.Data.SqlClient](https://www.nuget.org/packages/Microsoft.Data.SqlClient)
|
||||
and
|
||||
[System.Data.SqlClient](https://www.nuget.org/packages/System.Data.SqlClient)
|
||||
and collects telemetry about database operations.
|
||||
and collects traces about database operations.
|
||||
|
||||
**Note: This component is based on the OpenTelemetry semantic conventions for
|
||||
[traces](https://github.com/open-telemetry/opentelemetry-specification/tree/main/specification/trace/semantic_conventions).
|
||||
These conventions are
|
||||
[Experimental](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/document-status.md),
|
||||
and hence, this package is a [pre-release](../../VERSIONING.md#pre-releases).
|
||||
Until a [stable
|
||||
version](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/telemetry-stability.md)
|
||||
is released, there can be breaking changes. You can track the progress from
|
||||
[milestones](https://github.com/open-telemetry/opentelemetry-dotnet/milestone/23).**
|
||||
|
||||
## Steps to enable OpenTelemetry.Instrumentation.SqlClient
|
||||
|
||||
|
|
|
|||
|
|
@ -7,7 +7,17 @@ This is an
|
|||
[Instrumentation Library](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/glossary.md#instrumentation-library),
|
||||
which instruments
|
||||
[StackExchange.Redis](https://www.nuget.org/packages/StackExchange.Redis/)
|
||||
and collects telemetry about outgoing calls to Redis.
|
||||
and collects traces about outgoing calls to Redis.
|
||||
|
||||
**Note: This component is based on the OpenTelemetry semantic conventions for
|
||||
[traces](https://github.com/open-telemetry/opentelemetry-specification/tree/main/specification/trace/semantic_conventions).
|
||||
These conventions are
|
||||
[Experimental](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/document-status.md),
|
||||
and hence, this package is a [pre-release](../../VERSIONING.md#pre-releases).
|
||||
Until a [stable
|
||||
version](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/telemetry-stability.md)
|
||||
is released, there can be breaking changes. You can track the progress from
|
||||
[milestones](https://github.com/open-telemetry/opentelemetry-dotnet/milestone/23).**
|
||||
|
||||
## Steps to enable OpenTelemetry.Instrumentation.StackExchangeRedis
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue