https://github.com/python-discord/metricity

Advanced metric collection for the Python Discord server
https://github.com/python-discord/metricity

discord discord-bot metrics postgresql statistics

Last synced: about 2 months ago
JSON representation

Advanced metric collection for the Python Discord server

• Host: GitHub
• URL: https://github.com/python-discord/metricity
• Owner: python-discord
• License: mit
• Created: 2020-08-24T22:10:57.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-04-08T03:53:50.000Z (9 months ago)
• Last Synced: 2024-04-08T23:11:26.050Z (9 months ago)
• Topics: discord, discord-bot, metrics, postgresql, statistics
• Language: Python
• Homepage:
• Size: 973 KB
• Stars: 41
• Watchers: 12
• Forks: 17
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

• awesome-discordpy - python-discord/metricity - Advanced metric collection for the Python Discord server. (Example Bots / Miscellaneous)

README

        
![Metricity Banner](./docs/banner.png)

Metricity is an application for the Python Discord server which collects advanced metrics on the usage of the server.

Metricity only provides the collection of metrics, a service such as Grafana should be used to generate visualisations of the data.

### Setup

You will need [Poetry](https://python-poetry.org) to setup and run Metricity. There is a Docker image available which has a working poetry installation.

There are two environment variables, `BOT_TOKEN` and `DATABASE_URI`. These should be set to the Discord developer token and postgres database URI respectively. You can also alter these configuration values by copying `config-default.toml` to `config.toml` and altering the values, this file should not be comitted to git, it is your personal configuration.

To apply database migrations run `poetry run alembic upgrade head`.

To run the application use `poetry run start`.

If you alter the models then use `poetry run alembic revision -m "" --autogenerate` to generate a migration. **Make sure to check the changes generated are correct**.

### Join us on Discord!

If you are a Python programmer and want to meet fellow Pythonistas, come join us at !