Skip to content

v3.2.0

Compare
Choose a tag to compare
@Blaumaus Blaumaus released this 11 Aug 14:25
· 3233 commits to main since this release

What changed:

🔥 Major updates

  • Added support for project views and e-commerce integration (treating custom event metadata as numbers). (#238, #248, #251)
  • Added pageview tags (metadata) support (#239)

🙂 Minor changes

  • Migrated from clickhouse to @clickhouse/client library. This change allows us to implement near instant analytics data collection (before there was an up to 1 minute delay). (#246)
  • Added DEBUG_MODE option, which when set to true will print more logs from Clickhouse.

🔧 Fixes

  • Projects endpoint was not accessible as v1/project.
  • API keys did not work on v1/project endpoint.

Upgrading to Swetrix v3.2.0 (from v3.1.0)

Important

You will need to perform a database migration. Please make sure you read these instructions through to the end to make sure you've updated properly and to avoid losing any data.

Warning

Please make sure you always back up your data! Especially before migrating, to prevent data loss if something goes wrong.

In order to upgrade to Swetrix v3.2.0, you will need to perform the following actions:

1. Shut down your Swetrix docker container

In the self-hosting folder where your docker-compose.yml file is located, run the docker compose down command.

2. Update your docker-compose.yml file

  1. For swetrix image, update the following:
  • Change swetrix/swetrix-fe:v3.1.0 to swetrix/swetrix-fe:v3.2.0.
  1. For swetrix-api image, update the following:
  • Change swetrix/swetrix-api:v3.1.0 to swetrix/swetrix-api:v3.2.0.

3. Start up your docker container

Run the docker compose up -d command. This will pull up the Swetrix v3.2.0 release.

If you open your dashboard now, it will not work properly. This is expected as you still need to do a data migration to synchronise the new code with the database tables.

4. Run data migrations

In your selfhosting folder, you will need to run the following commands:

docker compose exec swetrix-api node migrations/clickhouse/2024_06_22.js
docker compose exec swetrix-api node migrations/clickhouse/selfhosted_2024_08_10.js

It will perform the migrations one at a time. If you don't see any Query ERROR messages written to your console, this indicates that the migrations went well and Swetrix v3.2.0 is ready to use.

You should not run these scripts more than once.

5. Enjoy our latest Swetrix release :)

Let us know if you find any bugs or have any feedback for us. Our work would not be possible without your support, and we hope you will love this release!

Full Changelog: v3.1.0...v3.2.0