Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ALotOfVideos/stats
Collects and tracks various stats of your Nexus Mods mods, ready to display with Grafana
https://github.com/ALotOfVideos/stats
grafana grafana-dashboard masseffect metrics mods nexusmods postgresql prometheus prometheus-exporter statistics timescaledb
Last synced: 3 months ago
JSON representation
Collects and tracks various stats of your Nexus Mods mods, ready to display with Grafana
- Host: GitHub
- URL: https://github.com/ALotOfVideos/stats
- Owner: ALotOfVideos
- License: gpl-3.0
- Created: 2020-03-20T18:42:59.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2020-05-22T17:04:35.000Z (over 4 years ago)
- Last Synced: 2024-07-18T16:30:12.065Z (4 months ago)
- Topics: grafana, grafana-dashboard, masseffect, metrics, mods, nexusmods, postgresql, prometheus, prometheus-exporter, statistics, timescaledb
- Language: Python
- Homepage:
- Size: 1.81 MB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Nexus Mods Stats
Collects and tracks various stats of your Nexus Mods mods.
## Contents
1. [Installation](#installation)
1. [Usage](#usage)
1. [Installation and usage with Docker](#installation-and-usage-with-docker)
1. [Constributing](#contributing)
1. [Screenshots](#screenshots)
## Installation
1. `git clone` this repository to your server.
1. Install dependencies: `pip install toml`. Consider using a [virtual environment](https://docs.python.org/3/tutorial/venv.html).
- for Prometheus: `pip install prometheus_client`
- for TimescaleDB: install the PostgreSQL development package (e.g. `libpq-dev` on Debian/Ubuntu, `libpqxx-devel` on Fedora) and `pip install psycopg2`
1. Copy `documentation/config.toml.example` to `config.toml`. Modify it to your needs and list the games and mods you want to track. Read the comments for more information on how to format your settings.
1. Get an API key from https://www.nexusmods.com/users/myaccount?tab=api and save it to your `config.toml`. Take care that nobody but you can access your API key!
## Usage
The recommended setup is to set up `timescaledb_exporter.py` for use with timescaleDB and Grafana.
To print stats to stdout once (e.g. testing your setup), run `./crawler.py`, or pipe to file: `./crawler.py > crawler.out`.
To export metrics to [Prometheus](https://prometheus.io):
1. [Install Prometheus](https://prometheus.io/docs/prometheus/latest/installation/)
1. Run `./prometheus_exporter.py` as a daemon.
1. Set Prometheus to scrape from the running script (default `localhost:8000`) with scrape interval matching the script's `"min update interval"`.
To export metrics to [TimescaleDB](https://www.timescale.com/):
1. [Install PostgreSQL + TimescaleDB](https://docs.timescale.com/latest/getting-started/installation)
1. Depending on your setup, enable network-based access: `listen_addresses` in `postgresql.conf`, authentication in `pg_hba.conf`.
1. Set up a user, password, and database ([instructions](https://medium.com/coding-blocks/creating-user-database-and-adding-access-on-postgresql-8bfcd2f4a91e)). Add this configuration to your `config.toml`.
1. Run `./timescale_exporter.py` as a daemon.
To display metrics with [Grafana](https://grafana.com/):
1. Set up your Grafana dashboards using the provided Prometheus metrics and labels (name, version, category), or PostgreSQL tables and columns. Find more info and examples in the [documentation](documentation) folder.
1. The TimescaleDB example dashboard requires some community plugins: `grafana-cli plugins install aidanmountford-html-panel`
## Installation and usage with Docker
This repository includes a `Dockerfile`, enabling you to easily build a docker container for this app, automatically installing all required dependincies while leaving your system unchanged.
1. `git clone` this repository to your server
1. Build the container: `docker build -t alov/nexus-mods-stats .`
1. Run an exporter:
```
docker run -it -v /absolute/path/to/your/config.toml:/nm-stats/config.toml alov/nexus-mods-stats python ./timescaledb_exporter.py
```
Also included is a `docker-compose.yml`, which allows you to automatically and easily deploy the whole stack of exporter, database and Grafana using docker.
1. `git clone` this repository to your server
1. Edit `docker-compose.yml` to your needs (uncomment Prometheus or TimescaleDB)
1. If using Prometheus:
1. Edit `documentation/prometheus.yml` if necessary, especially the scrape interval.
1. If using TimescaleDB:
1. Create your services `docker-compose up --no-start`, but start only the PostgreSQL server `docker start stats_timescaledb`.
1. Connect to your PostgreSQL server using `docker run -it --rm --network stats_default timescale/timescaledb:latest-pg9.6 psql -h stats_timescaledb -U postgres` and create your database (`CREATE DATABASE "nm-stats";`).
1. Set up your `config.toml` ([instructions](#installation))
1. Deploy your stack: `docker-compose up -d` and access grafana at `http://localhost:3000`
1. If you have a domain and want your Grafana public facing with https, add a reverse proxy (e.g. nginx with letsencrypt). This can be done with docker, too: e.g. [nginx-certbot](https://github.com/wmnnd/nginx-certbot), [docker-letsencrypt](https://github.com/linuxserver/docker-letsencrypt).
## Contributing
Feel free to PR!
## Screenshots
