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

Few doc fixes (#4186)

This commit is contained in:
Cijo Thomas 2023-02-15 01:58:30 +05:30 committed by GitHub
parent 69d015eb70
commit a878ca3eea
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 12 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.vscode/settings.json vendored
View File

@ -9,6 +9,7 @@
"codecov", "codecov",
"contoso", "contoso",
"cref", "cref",
"Gantt",
"grafana", "grafana",
"ilogger", "ilogger",
"inheritdoc", "inheritdoc",

6
README.md
View File

@ -80,6 +80,12 @@ See the [OpenTelemetry registry](https://opentelemetry.io/registry/?s=net) and
repo](https://github.com/open-telemetry/opentelemetry-dotnet-contrib) for more repo](https://github.com/open-telemetry/opentelemetry-dotnet-contrib) for more
components. components.
## Troubleshooting
See [Troubleshooting](./src/OpenTelemetry/README.md#troubleshooting).
Additionally check readme file for the individual components for any additional
troubleshooting information.
## Extensibility ## Extensibility
OpenTelemetry .NET is designed to be extensible. Here are the most common OpenTelemetry .NET is designed to be extensible. Here are the most common

9
VERSIONING.md
View File

@ -35,6 +35,10 @@ Zipkin exporter has a bug fix and is released as 1.0.1, then all other core
components are also released as 1.0.1, even if there is no code change in other components are also released as 1.0.1, even if there is no code change in other
components. components.
Starting with 1.4.0,
[OpenTelemetry.Extensions.Hosting](./src/OpenTelemetry.Extensions.Hosting/README.md)
will also be versioned and released together as a core component.
## Pre-releases ## Pre-releases
Pre-release packages are denoted by appending identifiers such as -Alpha, -Beta, Pre-release packages are denoted by appending identifiers such as -Alpha, -Beta,
@ -75,10 +79,7 @@ of separate packages.
OpenTelemetry .NET relies on .NET runtime to provide several instrumentation OpenTelemetry .NET relies on .NET runtime to provide several instrumentation
APIs. Currently, `System.Diagnostics.DiagnosticSource` and APIs. Currently, `System.Diagnostics.DiagnosticSource` and
`Microsoft.Extensions.Logging.Abstractions` are the packages from .NET runtime `Microsoft.Extensions.Logging.Abstractions` are the packages from .NET runtime
this repository is dependent on. In the future, APIs for Metrics, Propagators this repository is dependent on.
etc. will also come from .NET runtime itself. Depending on whether .NET runtime
choses to use same package or separate package for these, users may be required
to install separate packages for instrumenting.
### Packaging non-stable signals ### Packaging non-stable signals