Skip to content

Latest commit

 

History

History
81 lines (55 loc) · 2.6 KB

README.md

File metadata and controls

81 lines (55 loc) · 2.6 KB
Raw

Statistics

Full stack that provides all the tools to store and visualize custom usage statistics using docker

Install

git clone https://github.com/robertsLando/metrics-stack.git
cd metrics-stack
docker-compose up

Update

git pull
docker-compose down && docker-compose up --build

docker-compose up --build is needed to force re-build of backend apis container

Credentials

Set up the MongoDB Charts credentials with:

docker exec -it \
  $(docker container ls --filter name=charts_ -q) \
  charts-cli add-user --first-name "<First>" --last-name "<Last>" \
  --email "<[email protected]>" --password "<Password>" \
  --role "<UserAdmin|User>"

Example creating a default admin user:

docker exec -it \
  $(docker container ls --filter name=charts_ -q) \
  charts-cli add-user --first-name "Admin" --last-name "MongoDB" \
  --email "[email protected]" --password "mongodb" \
  --role "UserAdmin"

Proxy

When behind a reverse proxy, you have to enable the proxy option in config/app.js. Make sure that your reverse proxy is configured correctly, or the rate limiter can be circumvented. Details can be found at: http://expressjs.com/en/guide/behind-proxies.html

Backend

Uses an Express server to provide apis to store statistics to MongoDB. The only thing that needs to be configured are the database name, the collections with their unique fields and (optionally) your apis validators. Unique fields are necessary to identify a document uniquely in the DB, validators are required to validate body, headers, query of api requests. This can be done here

APIs

Auth

Auth protected routes expect an header x-api-token with content <key> where key is the key you have set on config/app.js file.

POST /statistics

Requires AUTH

Used to add statistics to the db. The individual docs are added using upsert, it means that if the document exists in the db it will be updated, otherwise a new doc will be added. The expected payload is:

{
    "collection": "collectionName", // optional
    "data": [{...}, {...}, ...], // array of documents to add to the collection
}

If no collection name is provided the default collection will be used: statistics. The default collection has a unique field named id that the user can use to uniquely identify an entry in the collection

POST /update-db

Requires AUTH

Used in this specific case to update some db collections. No payload is needed