diff --git a/docs/README.md b/docs/README.md index f25a6b6d2f..31bbb33766 100644 --- a/docs/README.md +++ b/docs/README.md @@ -128,7 +128,7 @@ sh ./otel-dotnet-auto-install.sh . $HOME/.otel-dotnet-auto/instrument.sh # Run your application with instrumentation -OTEL_SERVICE_NAME=myapp OTEL_RESOURCE_ATTRIBUTES=deployment.environment=staging,service.version=1.0.0 dotnet run +OTEL_SERVICE_NAME=myapp OTEL_RESOURCE_ATTRIBUTES=deployment.environment=staging,service.version=1.0.0 ./MyNetApp ``` [otel-dotnet-auto-install.sh](../otel-dotnet-auto-install.sh) script diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md index a506e9d07a..a946ce2c87 100644 --- a/docs/troubleshooting.md +++ b/docs/troubleshooting.md @@ -1,5 +1,13 @@ # Troubleshooting +## dotnet is crashing + +Instrumenting `dotnet` often results in a crash. +See [(#1744)](https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation/issues/1744). + +Therefore, we advise executing `dotnet build` before instrumenting the terminal session +or calling it in a separate terminal session. + ## Assembly version conflicts OpenTelemetry .NET NuGet packages and its dependencies