Undercurrent Analytics

Registration and credentials

Registering

Enter your email at undercurrentanalytics.dev/#get-access to request access. We’ll then send you an email with an attached JSON credentials file.

What’s in the credentials file

The file is named undercurrent-analytics-<your name>.json and contains:

  • Project token: Non-secret string that identifies events sent by your app. Used to initialise the client library.
  • Query token: Secret. Lets your Grafana read your events, and only your events. Goes in the UNDERCURRENT_TOKEN environment variable when you start Grafana.
  • Query URL: The endpoint your Grafana queries. Already baked into the image, so you only need this if we ask you to change it.

It belongs in your app repo, but don’t check it into version control

The query token is secret. Move the file into your app repo and exclude it from version control:

mv ~/Downloads/undercurrent-analytics-*.json /path/to/your/app/repo
echo 'undercurrent-analytics-*.json' >> .gitignore
git add .gitignore && git commit -m "Ignore Undercurrent Analytics credentials file" .gitignore

Rotating and revoking

Ask us to revoke your query token if it leaks. Revocation is immediate: it stops every query made with that token, wherever it is running. You then paste the replacement into your docker run and restart the container.

There are no other credentials to manage. Your Grafana admin password is yours, set on your own machine, and we never see it.

← Back to undercurrentanalytics.dev