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 doc cleanup (#856) 

* minor doc cleanup

* revert to CRLF to minimize diff

* improve wording

* make docfx happy
This commit is contained in:
Reiley Yang 2020-07-20 17:20:36 -07:00 committed by GitHub
parent 47689cea36
commit a4284aca24
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 37 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
README.md
View File

@ -9,40 +9,31 @@ Status](https://github.com/open-telemetry/opentelemetry-dotnet/workflows/.NET%20
The .NET [OpenTelemetry](https://opentelemetry.io/) client.
## Installation
## Getting Started
This repository includes multiple installable packages. The `OpenTelemetry.Api`
package includes abstract classes and no-op implementations for the
[OpenTelemetry API
specification](https://github.com/open-telemetry/opentelemetry-specification).
This repository includes multiple installable components, available on
[NuGet](https://www.nuget.org/profiles/OpenTelemetry).
The `OpenTelemetry` package is the reference implementation of the API.
Each package has its individual `README.md` file, which covers the instruction
on how to install and how to get started. To find all the available components,
please take a look at the `src` folder.
Libraries that produce telemetry data should only depend on
`OpenTelemetry.Api`, and defer the choice of the SDK to the application
developer. Applications may depend on `OpenTelemetry` or another package that
implements the API.
Here are the most commonly used components:
**Please note** that this library is currently in _alpha_, and shouldn't
generally be used in production environments.
* [OpenTelemetry .NET API](./src/OpenTelemetry.Api/README.md)
* [OpenTelemetry .NET SDK](./docs/sdk-usage.md)
* [OpenTelemetry .NET Instrumentation](./docs/instrumentation.md)
The API and SDK packages are available on the following NuGet feeds:
Here are the exporters:
* [MyGet V2](https://www.myget.org/F/opentelemetry/api/v2)
* [MyGet V3](https://www.myget.org/F/opentelemetry/api/v3/index.json)
## Documentation
[OpenTelemetry .NET API](./src/OpenTelemetry.Api/README.md)
[OpenTelemetry .NET SDK](./docs/sdk-usage.md)
[OpenTelemetry .NET Instrumentation](./docs/instrumentation.md)
## Compatible Exporters
* [Console Exporter](./src/OpenTelemetry.Exporter.Console/README.md)
* [Jaeger Exporter](./src/OpenTelemetry.Exporter.Jaeger/README.md)
* [Prometheus Exporter](./src/OpenTelemetry.Exporter.Prometheus/README.md)
* [Zipkin Exporter](./src/OpenTelemetry.Exporter.Zipkin/README.md)
* [Jaeger Exporter](./src/OpenTelemetry.Exporter.Jaeger/README.md)
See the [OpenTelemetry registry](https://opentelemetry.io/registry/?s=net) for
a list of exporters available.
more exporters.
## Contributing

18
src/OpenTelemetry.Instrumentation.AspNet.Win/README.md
View File

@ -1,4 +1,15 @@
# ASP.NET Instrumentation
# ASP.NET Instrumentation for OpenTelemetry .NET
[![NuGet](https://img.shields.io/nuget/v/OpenTelemetry.Instrumentation.AspNet.svg)](https://www.nuget.org/packages/OpenTelemetry.Instrumentation.AspNet)
[![NuGet](https://img.shields.io/nuget/dt/OpenTelemetry.Instrumentation.AspNet.svg)](https://www.nuget.org/packages/OpenTelemetry.Instrumentation.AspNet)
## Installation
```shell
dotnet add package OpenTelemetry.Instrumentation.AspNet
```
## Configuration
Configuration with ASP.NET (Full .NET Framework) running in IIS or IIS Express
(if supported) to collect incoming request information.
@ -45,3 +56,8 @@ Configuration with ASP.NET (Full .NET Framework) running in IIS or IIS Express
}
}
```
## References
* [ASP.NET](https://dotnet.microsoft.com/apps/aspnet)
* [OpenTelemetry Project](https://opentelemetry.io/)

4
src/OpenTelemetry.Instrumentation.AspNetCore/README.md
View File

@ -1,4 +1,4 @@
# OpenTelemetry.Instrumentation.AspNetCore
# ASP.NET Core Instrumentation for OpenTelemetry .NET
[![NuGet](https://img.shields.io/nuget/v/OpenTelemetry.Instrumentation.AspNetCore.svg)](https://www.nuget.org/packages/OpenTelemetry.Instrumentation.AspNetCore)
[![NuGet](https://img.shields.io/nuget/dt/OpenTelemetry.Instrumentation.AspNetCore.svg)](https://www.nuget.org/packages/OpenTelemetry.Instrumentation.AspNetCore)
@ -11,4 +11,6 @@ dotnet add package OpenTelemetry.Instrumentation.AspNetCore
## References
* [Introduction to ASP.NET
Core](https://docs.microsoft.com/aspnet/core/introduction-to-aspnet-core)
* [OpenTelemetry Project](https://opentelemetry.io/)