Upgrade to v0.55 from earlier versions

This setup assumes you've installed SigNoz version >=0.53 && <v0.55 and have kept it running for at least 15 days (the default retention period).

If you changed the default retention period, please make the adjustments outlined in the following step before upgrading to v0.55.

You can remove these flags after the system has run for the duration specified in your retention settings.

Please update the clickhouse queries in dashboards and alerts by following the guide here.

Config to Keep Using Old Table

For Docker

• In your docker-compose.yaml, add the following:

  query-service:
    command:
      [
        "-config=/root/config/prometheus.yml",
        "--use-logs-new-schema=false"
      ]
  

• In your otel-collector-config.yaml, add the following:

  exporters:
    clickhouselogsexporter:
      use_new_schema: false
  

For Kubernetes

• In your override-values.yaml, add the following:

  queryService:
    additionalArgs:
      - --use-logs-new-schema=false
  otelCollector:
    config:
      exporters:
        clickhouselogsexporter:
          use_new_schema: false
  

Migrating the Existing Materialized Columns and TTL Settings

After upgrading to SigNoz version v0.55 i.e. SigNoz chart version v0.53.1, you need to run the migration script to copy the TTL settings and materialized columns from the old table.

Migration changes include:

• materialized columns from the old table to the new table
• TTL settings from the old table to the new table

Steps to Run Migration Script

First Upgrade to v0.55

Follow the platform specific instructions to upgrade to 0.55 and above.

• Docker Standalone
• Kubernetes

For Docker

docker run --name signoz-migrate-55 --network clickhouse-setup_default \
  -it -d signoz/migrate:0.55 -host=clickhouse -port=9000

Steps to check logs:

docker logs -f signoz-migrate-55

In case of failure and have to run again, make sure to cleanup the container before running the migration script again.

docker stop signoz-migrate-55

docker rm signoz-migrate-55

For Kubernetes

RELEASE=my-release
NAMESPACE=platform
ADMIN_PASSWORD=$(
  kubectl -n $NAMESPACE get clickhouseinstallations.clickhouse.altinity.com $RELEASE-clickhouse \
  -o jsonpath --template '{.spec.configuration.users.admin/password}'
)

kubectl -n $NAMESPACE run -i -t signoz-migrate-55 --image=signoz/migrate:0.55 --restart='Never' \
  -- -host=$RELEASE-clickhouse -port=9000 -userName=admin -password=$ADMIN_PASSWORD

Steps to check logs:

kubectl -n $NAMESPACE logs -f signoz-migrate-55

In case of failure and have to run again, make sure to cleanup the pod before running the migration script again.

kubectl -n $NAMESPACE delete pod signoz-migrate-55

In case of Upgrade Failure

If you face any issue, reach out to us at Slack.

Command-Line Interface (CLI) Flags

There are some custom flags which can be enabled based on different use-cases. All the flags below are optional.

Flags:

• -port : Specify port of clickhouse. default=9000
• -host : Specify host of clickhouse. default=127.0.0.1
• -userName : Specify user name of clickhouse. default=default
• -password : Specify password of clickhouse. default=""