Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/robertslando/statistics-server
Statistics server
https://github.com/robertslando/statistics-server
mongodb mongodb-charts statistics usage-reports
Last synced: 13 days ago
JSON representation
Statistics server
- Host: GitHub
- URL: https://github.com/robertslando/statistics-server
- Owner: robertsLando
- Created: 2021-03-18T15:11:20.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2021-05-20T06:37:27.000Z (over 3 years ago)
- Last Synced: 2024-10-05T13:21:00.874Z (about 1 month ago)
- Topics: mongodb, mongodb-charts, statistics, usage-reports
- Language: JavaScript
- Homepage:
- Size: 431 KB
- Stars: 1
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Statistics
Full stack that provides all the tools to store and visualize custom usage statistics using docker
- mongodb
- node-red:
- Backend (for apis):
- MongoDB charts:
## Install
```bash
git clone https://github.com/robertsLando/statistics-server.git
cd statistics-server
docker-compose up
```
## Update
```bash
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:
```bash
docker exec -it \
$(docker container ls --filter name=charts_ -q) \
charts-cli add-user --first-name "" --last-name "" \
--email "" --password "" \
--role ""
```
Example creating a default admin user:
```bash
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
## Statistics pipeline for "last 24 hours"
By default, one statistics entry per ID and day is created. If your charts should operate on the most recent unique entries, you can add this pipeline to a new data source:
```jsonc
[
// Select only the last 24 hours of reports
{
$addFields: {
ts: { $ifNull: ["$ts", "$date"] }
}
},
{
"$match": {
"ts": { $gt: new Date(Date.now() - 24*60*60 * 1000) }
}
},
// And make sure there are no duplicate records (keep last)
{$sort: {ts: 1}},
{
$group: {
_id: "$id",
fields: {$last: "$$ROOT"}
}
},
{$replaceRoot: { newRoot: "$fields"}},
// If you want to clean up the data afterwards, you can do that here with $addFields, $set, etc.
]
```
## 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](backend/config)
### APIs
#### Auth
Auth protected routes expect an header `x-api-token` with content `` 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:
```js
{
"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
## Projects
Here is a list of projects that are currently using this as stack as base:
- [zwave-js/statistics-server](https://github.com/zwave-js/statistics-server)