Skip to content

Latest commit

 

History

History
120 lines (82 loc) · 3.53 KB

README.md

File metadata and controls

120 lines (82 loc) · 3.53 KB
Raw

Statuer, a monitor server [WIP]

Continuous integration

Statuer is a self hosted service to help you keep track of all your important services (HTTP, TCP, databases...). This project is still in progress

Requirements

  • A Mysql database (required)
  • A Discord bot to manage the configuration (optional)
  • A Web client or Phone app to manage the configuration (optional)

How to install your statuer instance ?

Using docker

Image of the api: lefuturiste/statuer-api

  • docker pull lefuturiste/statuer-api:latest
  • use the docker run command
docker run -d \
    --name statuer \
    -p 9425:80 \
    -e MYSQL_CONNECTION_URL=jdbc:mysql://localhost:3306/statuer \
    -e MYSQL_USERNAME=root \
    -e MYSQL_PASSWORD=root \
    -e DISCORD_BOT_TOKEN=XXX \
    -e DISCORD_CLIENT_ID=4242 \
lefuturiste/statuer-api:latest
  • you can also directly use docker-compose. See docker-compose.yml

Environment variables

  • MYSQL_CONNECTION_URL, example: jdbc:mysql://HOST:3306/statuer
  • MYSQL_USERNAME, example: statuer
  • MYSQL_PASSWORD, example: very_secure_pass
  • (optional) DISCORD_BOT_TOKEN
  • (optional) DISCORD_CLIENT_ID
  • (optional) DISCORD_PREFIX default to ??

Discord bot

This service can be managed using a discord bot.

Example of invite link: https://discordapp.com/oauth2/authorize?client_id=YOUR_CLIENT_ID&scope=bot&permissions=1611000896

Prefix: ??|&&|##|mention

Commands:

  • ??ping

  • ??help

  • ??about

  • ??status number of service down now

  • ??get <path> show information about a namespace|project|service

  • ??create <path> create a path

  • ??edit <path> name=<new name> edit a path, you can use any key that you want to edit

  • ??edit <path> proprety=1 proprety=2

  • ??delete <path> delete a path

  • ??webhook <path> <channel> set a webhook channel for a path (this will manage auto the webhooks)

Discord authorization: restrain a discord bot by channel and by discord user.

Structure, architecture

Database entities

The statuer data structure is divided into distinct entities:

  • Namespace: the data structure for a organization
  • Project: the data structure for a project inside a organization, for example a company can have multiple projects or products
  • Service: inside a project you will have many service for example an API, a database, a user dashboard or panel, workers and more
  • Incident: when a service fail a incident will be created this incident will be considered as 'resolved' when the service is up again

Notifier

This piece of code will be called when there is a need of alerting when the status of a service change.

  • Webhook (previsioning)
  • Specific webhook integration for Slack (previsioning) or Discord (available)
  • Twitter bot integration (previsioning)
  • SMS with different API (previsioning)
  • Email (previsioning)

Checker

This piece of code will check the service using a specific method. This will return the availability (up|down) of the service along with the response time in ms.

  • HTTP
  • PING (previsioning)
  • TCP (previsioning)
  • SMTP (previsioning)
  • MYSQL (previsioning)
  • MongoDB (previsioning)
  • RabbitMQ (previsioning)
  • SSH (previsioning)

Roadmap

  • Add more Notifiers
  • Add more Checkers
  • Create documentation
  • Add unit test for CheckThread
  • Add unit test for Discord commands
  • Add unit test for Unit test
  • Chain setter
  • Directly use public proprety instead of getter