Skip to content

Commit

Permalink
Remove unsupported environment variables from configuration page (#5560)
Browse files Browse the repository at this point in the history
Co-authored-by: opentelemetrybot <[email protected]>
Co-authored-by: Piotr Kiełkowicz <[email protected]>
  • Loading branch information
3 people authored Nov 8, 2024
1 parent 5b80dbb commit a3c6582
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 25 deletions.
11 changes: 6 additions & 5 deletions content/en/docs/zero-code/net/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -281,12 +281,13 @@ libraries. For a complete list, see [Instrumentations](./instrumentations).

## Troubleshooting

To see the telemetry from your application directly on the standard output, set
the following environment variables to `true` before launching your application:
To see the telemetry from your application directly on the standard output, add
`console` to the following environment variables value before launching your
application:

- `OTEL_DOTNET_AUTO_LOGS_CONSOLE_EXPORTER_ENABLED`
- `OTEL_DOTNET_AUTO_METRICS_CONSOLE_EXPORTER_ENABLED`
- `OTEL_DOTNET_AUTO_TRACES_CONSOLE_EXPORTER_ENABLED`
- `OTEL_TRACES_EXPORTER`
- `OTEL_METRICS_EXPORTER`
- `OTEL_LOGS_EXPORTER`

For general troubleshooting steps and solutions to specific issues, see
[Troubleshooting](./troubleshooting).
Expand Down
13 changes: 5 additions & 8 deletions content/en/docs/zero-code/net/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -378,11 +378,8 @@ path of the current user's
[temporary folder](https://docs.microsoft.com/en-us/dotnet/api/System.IO.Path.GetTempPath?view=net-6.0)
instead.

| Environment variable | Description | Default value | Status |
| --------------------------------------------------- | ----------------------------------------------------------------------- | ---------------------------------------- | --------------------------------------------------------- |
| `OTEL_DOTNET_AUTO_LOG_DIRECTORY` | Directory of the .NET Tracer logs. | _See the previous note on default paths_ | [Experimental](/docs/specs/otel/versioning-and-stability) |
| `OTEL_LOG_LEVEL` | SDK log level. (supported values: `none`,`error`,`warn`,`info`,`debug`) | `info` | [Stable](/docs/specs/otel/versioning-and-stability) |
| `OTEL_DOTNET_AUTO_TRACES_CONSOLE_EXPORTER_ENABLED` | Whether the traces console exporter is enabled or not. | `false` | [Deprecated](/docs/specs/otel/versioning-and-stability) |
| `OTEL_DOTNET_AUTO_METRICS_CONSOLE_EXPORTER_ENABLED` | Whether the metrics console exporter is enabled or not. | `false` | [Deprecated](/docs/specs/otel/versioning-and-stability) |
| `OTEL_DOTNET_AUTO_LOGS_CONSOLE_EXPORTER_ENABLED` | Whether the logs console exporter is enabled or not. | `false` | [Deprecated](/docs/specs/otel/versioning-and-stability) |
| `OTEL_DOTNET_AUTO_LOGS_INCLUDE_FORMATTED_MESSAGE` | Whether the log state should be formatted. | `false` | [Experimental](/docs/specs/otel/versioning-and-stability) |
| Environment variable | Description | Default value | Status |
| ------------------------------------------------- | ----------------------------------------------------------------------- | ---------------------------------------- | --------------------------------------------------------- |
| `OTEL_DOTNET_AUTO_LOG_DIRECTORY` | Directory of the .NET Tracer logs. | _See the previous note on default paths_ | [Experimental](/docs/specs/otel/versioning-and-stability) |
| `OTEL_LOG_LEVEL` | SDK log level. (supported values: `none`,`error`,`warn`,`info`,`debug`) | `info` | [Stable](/docs/specs/otel/versioning-and-stability) |
| `OTEL_DOTNET_AUTO_LOGS_INCLUDE_FORMATTED_MESSAGE` | Whether the log state should be formatted. | `false` | [Experimental](/docs/specs/otel/versioning-and-stability) |
18 changes: 6 additions & 12 deletions content/en/docs/zero-code/net/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -158,25 +158,19 @@ or PowerShell scripts.
{{< tabpane text=true >}} {{% tab Unix-shell %}}

```sh
export OTEL_TRACES_EXPORTER=none \
OTEL_METRICS_EXPORTER=none \
OTEL_LOGS_EXPORTER=none \
OTEL_DOTNET_AUTO_TRACES_CONSOLE_EXPORTER_ENABLED=true \
OTEL_DOTNET_AUTO_METRICS_CONSOLE_EXPORTER_ENABLED=true \
OTEL_DOTNET_AUTO_LOGS_CONSOLE_EXPORTER_ENABLED=true
export OTEL_TRACES_EXPORTER=console \
OTEL_METRICS_EXPORTER=console \
OTEL_LOGS_EXPORTER=console
OTEL_SERVICE_NAME=RollDiceService
. $HOME/.otel-dotnet-auto/instrument.sh
```

{{% /tab %}} {{% tab PowerShell - Windows %}}

```powershell
$env:OTEL_TRACES_EXPORTER="none"
$env:OTEL_METRICS_EXPORTER="none"
$env:OTEL_LOGS_EXPORTER="none"
$env:OTEL_DOTNET_AUTO_TRACES_CONSOLE_EXPORTER_ENABLED="true"
$env:OTEL_DOTNET_AUTO_METRICS_CONSOLE_EXPORTER_ENABLED="true"
$env:OTEL_DOTNET_AUTO_LOGS_CONSOLE_EXPORTER_ENABLED="true"
$env:OTEL_TRACES_EXPORTER="console"
$env:OTEL_METRICS_EXPORTER="console"
$env:OTEL_LOGS_EXPORTER="console"
Register-OpenTelemetryForCurrentSession -OTelServiceName "RollDiceService"
```

Expand Down

0 comments on commit a3c6582

Please sign in to comment.