Skip to content
Graph your Pleroma server stats with Python + Postgresql + Grafana
Python
Branch: master
Clone or download
Pull request Compare This branch is 5 commits ahead of salvadorpla:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
Pipfile
Pipfile.lock
Pleromastats.png
README.md
config.txt
pleroma-stats.py
v1.2-graphs.png

README.md

Graphical Pleroma's stats with Python + Postgresql + Grafana

Python script that gets realtime stats data from Pleroma's DB.

Dependencies

  • Python3
  • Grafana
  • Postgresql server

Install python deps:

sudo pip3 install pipenv
pipenv install

Usage:

  1. Edit config.txt to specify the hostname of the Pleroma server you would like to get data from, its DB name and DB user and also the DB name and DB user for Grafana.

  2. Create one Postgresql database for Grafana, in example 'pleroma_stats', with two tables:

CREATE DATABASE pleroma_stats WITH OWNER pleroma;
\c pleroma_stats;
CREATE TABLE stats(
DATETIME TIMESTAMPTZ PRIMARY KEY NOT NULL,
USERS INT,
USERS_HOUR INT,
POSTS INT,
POSTS_HOUR INT, POSTS_USERS INT,
INTERACTIONS INT,
ACTIVE INT, ACTIVE30 INT,
SERVERS INT, SERVERS_HOUR INT,
POSTS_ACTIVE INT,
FEDERATED_USERS INT, FEDERATED_USERS_HOUR INT,
FED_POSTS_HOUR INT, USED_DISK_SPACE INT,
DISC_SPACE_HOUR INT
);

CREATE TABLE unreached_servers(
SERVER VARCHAR(30),
SINCE TIMESTAMP,
DAYS VARCHAR(30),
INSERTED_AT TIMESTAMP PRIMARY KEY NOT NULL,
DATETIME TIMESTAMPTZ
);
  1. pipenv run python pleroma-stats.py
  2. Use your favourite scheduling method to set pleroma-stats.py to run regularly, using pipenv.
  3. Add the datasource PostgreSQL to your Grafana, configuring Host (usually localhost:5432), Database (in the example is pleroma_stats) and User fields.

Then you could graph your Pleroma server stats with Grafana's PostgreSQL datasource! It gets all needed data from Pleroma's Postgresql database and then store stats to a new Postgresql database created above, to feed Grafana with their values.

What values can you track in Grafana?

  • Local users
  • New local users / hour
  • Local posts
  • Local posts / hour
  • Posts per user
  • Federated users
  • New federated users / hour
  • Federated servers
  • New federated servers / hour
  • Unreached servers (How many & which ones)
  • New in v1.2!
  • Federated posts / hour
  • Disc space used by the Pleroma's database
  • Database disc space increase / hour

Grafana showing Pleroma stats

  • New v1.2 graphs!

v1.2 - New graphs

You can’t perform that action at this time.