diff --git a/stackpacks/open-telemetry/resources/configuration.md b/stackpacks/open-telemetry/resources/configuration.md index 37e534f..a38bd22 100644 --- a/stackpacks/open-telemetry/resources/configuration.md +++ b/stackpacks/open-telemetry/resources/configuration.md @@ -1,3 +1,23 @@ ## Installation -You can click on `Install` to install the Open Telemetry StackPack. Then follow the instructions here and in [the documentation](https://l.stackstate.com/open-telemetry-setup). to finish the Open Telemetry setup. +You can click on `Install` to install the Open Telemetry StackPack. Then follow the instructions here and in [the documentation](https://l.stackstate.com/open-telemetry-setup) to finish the Open Telemetry setup. + +When installing or upgrading the SUSE Observability Agent with Helm, enable Open Telemetry support with: + +```bash +--set otel=true +``` + +On Rancher-managed clusters, set: + +```bash +--set otel.integrations.rancherAgent=true +``` + +or + +```bash +--set otel.integrations.rancherAgent=false +``` + +Set `otel.integrations.rancherAgent=true` on Rancher-managed clusters to enrich emitted logs with Rancher Manager URL and Harvester cluster ID metadata. Keep it `false` on non-Rancher clusters (default). diff --git a/stackpacks/open-telemetry/resources/enabled.md b/stackpacks/open-telemetry/resources/enabled.md index 8317e75..b50b514 100644 --- a/stackpacks/open-telemetry/resources/enabled.md +++ b/stackpacks/open-telemetry/resources/enabled.md @@ -4,6 +4,24 @@ Instrument one or more applications with Open Telemetry SDKs to generate traces and metrics and install and configure the Open Telemetry collector to send data to SUSE Observability. See the [SUSE Observability Open Telemetry documentation](https://l.stackstate.com/open-telemetry-setup). +If you install or upgrade the SUSE Observability Agent with Helm, make sure Open Telemetry support is enabled: + +```bash +--set otel=true +``` + +On Rancher-managed clusters, set: + +```bash +--set otel.integrations.rancherAgent=true +``` + +On non-Rancher clusters, keep the default: + +```bash +--set otel.integrations.rancherAgent=false +``` + To send data to SUSE Observability a service token is needed. - \ No newline at end of file + diff --git a/stackpacks/open-telemetry/stackpack.yaml b/stackpacks/open-telemetry/stackpack.yaml index a7f6778..1a0e778 100644 --- a/stackpacks/open-telemetry/stackpack.yaml +++ b/stackpacks/open-telemetry/stackpack.yaml @@ -1,5 +1,5 @@ name: "open-telemetry" -version: "0.1.2" +version: "0.1.3" schemaVersion: "2.0" displayName: "Open Telemetry" categories: [ "Open Telemetry" ]