From 97c6d9c0c408029609fe37fcc96e39b1b0585997 Mon Sep 17 00:00:00 2001 From: Promise Fru Date: Fri, 20 Nov 2026 14:53:38 +0100 Subject: [PATCH] build(observability): pin SigNoz v0.151.0 and document upgrades Signed-off-by: Promise Fru --- docs/operating/observability.md | 29 ++++++++++++++++++---- observability/signoz/casting.yaml.template | 4 +++ scripts/setup-observability.sh | 3 ++- 3 files changed, 30 insertions(+), 6 deletions(-) diff --git a/docs/operating/observability.md b/docs/operating/observability.md index a0d73f6..692cf3f 100644 --- a/docs/operating/observability.md +++ b/docs/operating/observability.md @@ -34,9 +34,6 @@ sudo ./scripts/setup-observability.sh Set retention in the SigNoz UI, under Settings > Workspace > Retention Controls. -> [!IMPORTANT] -> `casting.yaml` is generated only once. To change a running install, edit `observability/signoz/casting.yaml` and run `foundryctl cast -f observability/signoz/casting.yaml` again. It recreates only the `signoz` container; Postgres and ClickHouse keep their data. - ## Uptime Kuma monitors Open Uptime Kuma through its domain, or through an SSH tunnel at : @@ -123,14 +120,36 @@ sudo ./manage.sh restart To turn it off, blank `OTEL_EXPORTER_OTLP_ENDPOINT` and restart. +## Changing the SigNoz configuration + +`observability/signoz/casting.yaml` is generated only once, so updating the Publisher doesn't change a running SigNoz install. To change it, edit `casting.yaml`, then apply it from the install directory: + +```bash +sudo foundryctl cast -f observability/signoz/casting.yaml +sudo docker compose \ + -f pours/deployment/compose.yaml \ + -f observability/signoz/docker-compose.override.yml \ + up -d --force-recreate +``` + +`cast` alone starts the containers without the override's memory limits and hardening. `--force-recreate` also reloads the config files `cast` rewrote, which Compose doesn't detect. Postgres and ClickHouse keep their data. + +## Upgrading SigNoz + +1. Check the [upgrade path](https://signoz.io/upgrade-path/) for versions you must upgrade through first, and read the migration notes for each release you cross. +2. Back up the metastore: `sudo sh -c 'docker exec relaysms-publisher-signoz-metastore-postgres-0 pg_dump -U signoz signoz > /root/signoz-metastore-$(date +%F).sql'`. +3. Install the foundryctl version that `scripts/setup-observability.sh` sets in `FOUNDRY_VERSION`: `curl -fsSL https://signoz.io/foundry.sh | sudo FOUNDRY_VERSION= FOUNDRY_INSTALL_DIR=/usr/local/bin bash`. +4. Copy the `image:` lines under `signoz` and `ingester` from `observability/signoz/casting.yaml.template` into `casting.yaml`, adding them if they're missing. +5. Apply it as in [Changing the SigNoz configuration](#changing-the-signoz-configuration), then check the version under Settings. + ## Setting up by hand ### SigNoz -Needs Docker Engine with the Compose plugin. Set `` to 12 or more characters, with upper and lower case, a number and a symbol. +Needs Docker Engine with the Compose plugin. Set `` to the `FOUNDRY_VERSION` in `scripts/setup-observability.sh`, and `` to 12 or more characters, with upper and lower case, a number and a symbol. ```bash -curl -fsSL https://signoz.io/foundry.sh | FOUNDRY_INSTALL_DIR=/usr/local/bin bash +curl -fsSL https://signoz.io/foundry.sh | sudo FOUNDRY_VERSION= FOUNDRY_INSTALL_DIR=/usr/local/bin bash sed \ -e "s/__POSTGRES_DB__/signoz/" -e "s/__POSTGRES_USER__/signoz/" \ diff --git a/observability/signoz/casting.yaml.template b/observability/signoz/casting.yaml.template index 219989d..ffd1a97 100644 --- a/observability/signoz/casting.yaml.template +++ b/observability/signoz/casting.yaml.template @@ -23,8 +23,11 @@ spec: POSTGRES_PASSWORD: __POSTGRES_PASSWORD__ telemetrykeeper: kind: clickhousekeeper + # Keep the ingester on the collector release that matches this SigNoz + # release. Foundry runs the schema migrator from the ingester image. signoz: spec: + image: signoz/signoz:v0.151.0 env: SIGNOZ_ALERTMANAGER_SIGNOZ_GLOBAL_SMTP__SMARTHOST: "__SMTP_SMARTHOST__" SIGNOZ_ALERTMANAGER_SIGNOZ_GLOBAL_SMTP__AUTH__USERNAME: "__SMTP_USERNAME__" @@ -33,6 +36,7 @@ spec: SIGNOZ_ALERTMANAGER_SIGNOZ_EXTERNAL__URL: "__SIGNOZ_EXTERNAL_URL__" ingester: spec: + image: signoz/signoz-otel-collector:v0.144.16 config: data: # Points the collector's opamp client at the SigNoz backend. diff --git a/scripts/setup-observability.sh b/scripts/setup-observability.sh index a23b4b5..a5ecaa5 100755 --- a/scripts/setup-observability.sh +++ b/scripts/setup-observability.sh @@ -25,6 +25,7 @@ SIGNOZ_SMTP_PORT="587" SIGNOZ_SMTP_USERNAME="" SIGNOZ_SMTP_PASSWORD="" SIGNOZ_SMTP_FROM="" +FOUNDRY_VERSION="v0.5.0" usage() { cat <<'EOF' @@ -240,7 +241,7 @@ main() { if ! command -v foundryctl &>/dev/null; then log "Installing foundryctl" - curl -fsSL https://signoz.io/foundry.sh | FOUNDRY_INSTALL_DIR=/usr/local/bin bash + curl -fsSL https://signoz.io/foundry.sh | FOUNDRY_VERSION="$FOUNDRY_VERSION" FOUNDRY_INSTALL_DIR=/usr/local/bin bash fi signoz_external_url="http://localhost:$SIGNOZ_PORT"