From faf2c4d92a9fdcdd63ed2cd665f4999615b242c3 Mon Sep 17 00:00:00 2001 From: Bram Schuur Date: Thu, 1 Oct 2026 10:17:05 +0200 Subject: [PATCH] fix(open-telemetry): replace invalid otel=true agent flag Co-Authored-By: Claude Opus 5.5 (1M context) --- .../open-telemetry/resources/configuration.md | 21 +++++++++---------- .../open-telemetry/resources/enabled.md | 16 ++++---------- stackpacks/open-telemetry/stackpack.yaml | 2 +- 3 files changed, 15 insertions(+), 24 deletions(-) diff --git a/stackpacks/open-telemetry/resources/configuration.md b/stackpacks/open-telemetry/resources/configuration.md index a38bd22..91dc4f8 100644 --- a/stackpacks/open-telemetry/resources/configuration.md +++ b/stackpacks/open-telemetry/resources/configuration.md @@ -2,22 +2,21 @@ 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: +The SUSE Observability Agent's Open Telemetry components are disabled by default. To receive traces and metrics pushed over OTLP from application SDKs, enable the agent's telemetry gateway when installing or upgrading the agent with Helm: -```bash ---set otel=true -``` - -On Rancher-managed clusters, set: - -```bash ---set otel.integrations.rancherAgent=true +```yaml +otel: + enabled: true + telemetryGateway: + enabled: true ``` or ```bash ---set otel.integrations.rancherAgent=false +--set otel.enabled=true --set otel.telemetryGateway.enabled=true ``` -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). +Then point your SDKs at the telemetry gateway service, as described in the [telemetry gateway documentation](https://documentation.suse.com/cloudnative/suse-observability/latest/en/setup/otel/telemetry-gateway.html). + +On Rancher-managed clusters, also set `--set otel.integrations.rancherAgent=true` to enrich emitted logs with Rancher Manager URL and Harvester cluster ID metadata. Keep the default, `false`, on non-Rancher clusters. diff --git a/stackpacks/open-telemetry/resources/enabled.md b/stackpacks/open-telemetry/resources/enabled.md index b50b514..c5153f7 100644 --- a/stackpacks/open-telemetry/resources/enabled.md +++ b/stackpacks/open-telemetry/resources/enabled.md @@ -4,23 +4,15 @@ 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: +To send SDK telemetry through the SUSE Observability Agent, enable its telemetry gateway when installing or upgrading the agent with Helm. The agent's Open Telemetry components are disabled by default: ```bash ---set otel=true +--set otel.enabled=true --set otel.telemetryGateway.enabled=true ``` -On Rancher-managed clusters, set: +Then point your SDKs at the telemetry gateway service, as described in the [telemetry gateway documentation](https://documentation.suse.com/cloudnative/suse-observability/latest/en/setup/otel/telemetry-gateway.html). -```bash ---set otel.integrations.rancherAgent=true -``` - -On non-Rancher clusters, keep the default: - -```bash ---set otel.integrations.rancherAgent=false -``` +On Rancher-managed clusters, also set `--set otel.integrations.rancherAgent=true`. Keep the default, `false`, on non-Rancher clusters. To send data to SUSE Observability a service token is needed. diff --git a/stackpacks/open-telemetry/stackpack.yaml b/stackpacks/open-telemetry/stackpack.yaml index 5be5b50..43859e5 100644 --- a/stackpacks/open-telemetry/stackpack.yaml +++ b/stackpacks/open-telemetry/stackpack.yaml @@ -1,5 +1,5 @@ name: "open-telemetry" -version: "0.1.4" +version: "0.1.5" schemaVersion: "2.0" displayName: "Open Telemetry" categories: [ "Open Telemetry" ]