Files
nym/nym-statistics-api
Simon Wicky 6eb8f29235 Statistics API v2 (#6227)
* vpn client report v2

* report v2 support in nym-stats API

* version bump

* CI fix while we're at it

* more CI fix

* needed the dind after all

* PR comments
2025-11-25 13:16:31 +01:00
..
2025-11-25 13:16:31 +01:00
2025-11-25 13:16:31 +01:00
2025-11-25 13:16:31 +01:00
2025-11-25 13:16:31 +01:00
2025-05-28 10:23:11 +02:00

Nym-statistics-api

A simple API to collect and store statistics sent by nym-vpn-client.

Build instructions

The statistics API is backed by a PostgreSQL database so you'll need a PostgreSQL server running if you want to add migrations or add/modify SQL queries. I recommend https://postgresapp.com on MacOS, very easy to use. If you're on another OS, it's up to you.

Assuming your database is running at postgresql://user:password@host:port/database_name you'll likely need to run the following :

DATABASE_URL="postgresql://user:password@host:port/database_name"

# if you don't have an existing datase
sqlx database create --database-url $DATABASE_URL
sqlx migrate run --database-url $DATABASE_URL

# reset it if you messed with migrations while developping
sqlx database reset --database-url $DATABASE_URL

# or just run new migrations
sqlx migrate run --database-url $DATABASE_URL

# then prepare queries for offline build mode
cargo sqlx prepare --database-url $DATABASE_URL

This should allow cargo build without having any postgreSQL server running. Be sure to add the .sqlx directory to version control