-
Notifications
You must be signed in to change notification settings - Fork 93
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Refine setup and configuration docs #2082
Conversation
@ramanjaneyagupta PTAL and feel free to provide any feedback |
docs/README.md
Outdated
# Get current installation location | ||
Get-OpenTelemetryInstallDirectory | ||
# Run your application with instrumentation | ||
dotnet run |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I will explicitly call out the current issues with dotnet
CLI and suggest to create a shell to run the instrumented version. Basically: build and run dotnet
CLI on shell 1 then set up the environment for automatic instrumentation on shell 2. A warning icon, plus, a link to the bug seems worthwhile at the moment.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I will address it in a separate PR.
@theletterf PTAL. Lots of docs changes |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@pellared for the time being we need to ensure that the instrumentation environment variables are not set in the same context/shell in which dotnet
CLI is being used. There are too many setting combinations and most of them lead to different problems. So explicitly call that out and recommend running the executable directly in a separate context/shell to get instrumentation going.
docs/README.md
Outdated
# Get current installation location | ||
Get-OpenTelemetryInstallDirectory | ||
# Run your application with instrumentation | ||
dotnet run |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I will explicitly call out the current issues with dotnet
CLI and suggest to create a shell to run the instrumented version. Basically: build and run dotnet
CLI on shell 1 then set up the environment for automatic instrumentation on shell 2. A warning icon, plus, a link to the bug seems worthwhile at the moment.
Co-authored-by: Fabrizio Ferri-Benedetti <[email protected]> Co-authored-by: Robert Pająk <[email protected]>
Why
Fixes #2071
Towards #2076
What