diff --git a/src/OpenTelemetry.Api/README.md b/src/OpenTelemetry.Api/README.md index 4396cbbab31..0ca21546101 100644 --- a/src/OpenTelemetry.Api/README.md +++ b/src/OpenTelemetry.Api/README.md @@ -19,6 +19,7 @@ * [Setting Status](#setting-status) * [Instrumenting a library/application with OpenTelemetry.API Shim](#instrumenting-using-opentelemetryapi-shim) +* [Troubleshooting](#troubleshooting) * [References](#references) ## Installation @@ -502,6 +503,15 @@ describes more kinds of instruments. // TODO - add all instruments. +## Troubleshooting + +This component uses an +[EventSource](https://docs.microsoft.com/dotnet/api/system.diagnostics.tracing.eventsource) +with the name "OpenTelemetry-Api" for its internal logging. +Please refer to [SDK +troubleshooting](../opentelemetry/README.md#troubleshooting) for instructions on +seeing these internal logs. + ## References * [OpenTelemetry Project](https://opentelemetry.io/) diff --git a/src/OpenTelemetry.Exporter.Jaeger/README.md b/src/OpenTelemetry.Exporter.Jaeger/README.md index 522e8bb262f..57c9ba4f476 100644 --- a/src/OpenTelemetry.Exporter.Jaeger/README.md +++ b/src/OpenTelemetry.Exporter.Jaeger/README.md @@ -123,6 +123,14 @@ services.AddHttpClient( Note: The single instance returned by `HttpClientFactory` is reused by all export requests. +## Troubleshooting + +This component uses an +[EventSource](https://docs.microsoft.com/dotnet/api/system.diagnostics.tracing.eventsource) +with the name "OpenTelemetry-Exporter-Jaeger" for its internal logging. Please +refer to [SDK troubleshooting](../opentelemetry/README.md#troubleshooting) for +instructions on seeing these internal logs. + ## References * [Jaeger](https://www.jaegertracing.io) diff --git a/src/OpenTelemetry.Exporter.Prometheus/README.md b/src/OpenTelemetry.Exporter.Prometheus/README.md index 7ef3106ff16..4f49f14f4ed 100644 --- a/src/OpenTelemetry.Exporter.Prometheus/README.md +++ b/src/OpenTelemetry.Exporter.Prometheus/README.md @@ -103,6 +103,15 @@ cache duration time period will receive the same previously generated response. The default value is `10000` (10 seconds). Set to `0` to disable response caching. +## Troubleshooting + +This component uses an +[EventSource](https://docs.microsoft.com/dotnet/api/system.diagnostics.tracing.eventsource) +with the name "OpenTelemetry-Exporter-Prometheus" for its internal logging. +Please refer to [SDK +troubleshooting](../opentelemetry/README.md#troubleshooting) for instructions on +seeing these internal logs. + ## References * [OpenTelemetry Project](https://opentelemetry.io/) diff --git a/src/OpenTelemetry.Exporter.Zipkin/README.md b/src/OpenTelemetry.Exporter.Zipkin/README.md index ba7775805f4..8834e8f14b0 100644 --- a/src/OpenTelemetry.Exporter.Zipkin/README.md +++ b/src/OpenTelemetry.Exporter.Zipkin/README.md @@ -107,6 +107,14 @@ services.AddHttpClient( Note: The single instance returned by `HttpClientFactory` is reused by all export requests. +## Troubleshooting + +This component uses an +[EventSource](https://docs.microsoft.com/dotnet/api/system.diagnostics.tracing.eventsource) +with the name "OpenTelemetry-Exporter-Zipkin" for its internal logging. Please +refer to [SDK troubleshooting](../opentelemetry/README.md#troubleshooting) for +instructions on seeing these internal logs. + ## References * [OpenTelemetry Project](https://opentelemetry.io/) diff --git a/src/OpenTelemetry.Instrumentation.AspNetCore/README.md b/src/OpenTelemetry.Instrumentation.AspNetCore/README.md index 91fab9f38b8..abd247b4a4b 100644 --- a/src/OpenTelemetry.Instrumentation.AspNetCore/README.md +++ b/src/OpenTelemetry.Instrumentation.AspNetCore/README.md @@ -153,6 +153,15 @@ This instrumentation automatically sets Activity Status to Error if an unhandled exception is thrown. Additionally, `RecordException` feature may be turned on, to store the exception to the Activity itself as ActivityEvent. +## Troubleshooting + +This component uses an +[EventSource](https://docs.microsoft.com/dotnet/api/system.diagnostics.tracing.eventsource) +with the name "OpenTelemetry-Instrumentation-AspNetCore" for its internal +logging. Please refer to [SDK +troubleshooting](../opentelemetry/README.md#troubleshooting) for instructions on +seeing these internal logs. + ## References * [Introduction to ASP.NET diff --git a/src/OpenTelemetry.Instrumentation.Http/README.md b/src/OpenTelemetry.Instrumentation.Http/README.md index 302f631cb04..2593701fd12 100644 --- a/src/OpenTelemetry.Instrumentation.Http/README.md +++ b/src/OpenTelemetry.Instrumentation.Http/README.md @@ -221,6 +221,15 @@ This instrumentation automatically sets Activity Status to Error if the Http StatusCode is >= 400. Additionally, `RecordException` feature may be turned on, to store the exception to the Activity itself as ActivityEvent. +## Troubleshooting + +This component uses an +[EventSource](https://docs.microsoft.com/dotnet/api/system.diagnostics.tracing.eventsource) +with the name "OpenTelemetry-Instrumentation-Http" for its internal logging. +Please refer to [SDK +troubleshooting](../opentelemetry/README.md#troubleshooting) for instructions on +seeing these internal logs. + ## References * [OpenTelemetry Project](https://opentelemetry.io/)