Skip to content
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.

Sign up for GitHub

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

Minor updates to macOS instructions #2481

Merged
merged 3 commits into from
Apr 19, 2023
Merged

Minor updates to macOS instructions #2481

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b2a3257
Minor updates to macOS instructions
pjanotti Apr 19, 2023
3b7d78b
Merge branch 'main' into review-macos-instructions
Kielek Apr 19, 2023
2ab043f
Merge branch 'main' into review-macos-instructions
nrcventura Apr 19, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 11 additions & 3 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,10 @@ See [config.md#instrumented-libraries-and-frameworks](config.md#instrumented-lib

## Get started

> **Note**
> ARM architectures are not supported yet,
> see [#2181](https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation/issues/2181).

### Considerations on scope

Instrumenting [`self-contained`](https://learn.microsoft.com/en-us/dotnet/core/deploying/#publish-self-contained)
Expand Down Expand Up @@ -133,6 +137,10 @@ When running your application, make sure to:

You can install OpenTelemetry .NET Automatic Instrumentation
and instrument your .NET application using the provided Shell scripts.

> **Note**
> On macOS [`coreutils`](https://formulae.brew.sh/formula/coreutils) is required.

Example usage:

```sh
Expand All @@ -142,6 +150,9 @@ curl -sSfL https://raw.githubusercontent.com/open-telemetry/opentelemetry-dotnet
# Install core files
sh ./otel-dotnet-auto-install.sh

# Enable execution for the instrumentation script
chmod +x $HOME/.otel-dotnet-auto/instrument.sh

# Setup the instrumentation for the current shell session
. $HOME/.otel-dotnet-auto/instrument.sh

Expand All @@ -168,9 +179,6 @@ uses environment variables as parameters:
| `OTEL_DOTNET_AUTO_HOME` | Location where binaries are to be installed | No | `$HOME/.otel-dotnet-auto` |
| `OS_TYPE` | Possible values: `linux-glibc`, `linux-musl`, `macos`, `windows` | No | *Calculated* |

> **Note**
> On macOS [`coreutils`](https://formulae.brew.sh/formula/coreutils) is required.

### PowerShell module (Windows)

On Windows, you should install OpenTelemetry .NET Automatic Instrumentation
Expand Down