line/promgen

Name: promgen

Owner: LINE

Description: Promgen is a configuration file generator for Prometheus

Created: 2016-08-02 02:35:13.0

Updated: 2018-05-23 12:06:02.0

Pushed: 2018-05-24 06:53:32.0

Homepage: https://line.github.io/promgen/

Size: 3943

Language: Python

GitHub Committers

UserMost Recent Commit# Commits

Other Committers

UserEmailMost Recent Commit# Commits

README

What is Promgen?

Promgen is a configuration file generator for Prometheus. Promgen is a web application written with Django and can help you do the following jobs.

See the Promgen introduction slides for more details.

Promgen screenshots

screenshot

Getting started

Below are the steps to get started with Promgen.

Please see CONTRIBUTING.md for contributing to Promgen.

1. Initialize Promgen

Initialize Promgen using Docker.

eate promgen setting directory.
r -p ~/.config/promgen
d 777 ~/.config/promgen

itialize required settings with Docker container
is will prompt you for connection settings for your database and Redis broker
ing the standard DSN syntax.
tabase example: mysql://password:username@hostname/databasename
oker example: redis://localhost:6379/0
er run --rm -it -v ~/.config/promgen:/etc/promgen/ line/promgen bootstrap

ply database updates
er run --rm -v ~/.config/promgen:/etc/promgen/ line/promgen migrate

eate initial login user. This is the same as the default django-admin command
tps://docs.djangoproject.com/en/1.10/ref/django-admin/#django-admin-createsuperuser
er run --rm -it -v ~/.config/promgen:/etc/promgen/ line/promgen createsuperuser

You can then use your favorite configuration management system to deploy to each worker.

Note: Promgen aims to use the XDG specs and follows suggestions made by the 12-Factor App.

2. Configure Prometheus

Configure Prometheus to load the target file from Prometheus and configure AlertManager to send notifications back to Promgen.

See the example settings files for proper configuration of Prometheus and AlertManager.

3. Run Promgen

Run Promgen using the following command.

n Promgen web worker. This is typically balanced behind an NGINX instance
er run --rm -p 8000:8000 -v ~/.config/promgen:/etc/promgen/ line/promgen

n Promgen celery worker. Make sure to run it on the same machine as your Prometheus server to manage the config settings
er run --rm -v ~/.config/promgen:/etc/promgen/ -v /etc/prometheus:/etc/prometheus line/promgen worker

 if using docker-compose you can spin up a complete test environment
er-compose up -d
eate initial user
er-compose run web createsuperuser
The MIT License

Copyright (c) 2017 LINE Corporation

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.


This work is supported by the National Institutes of Health's National Center for Advancing Translational Sciences, Grant Number U24TR002306. This work is solely the responsibility of the creators and does not necessarily represent the official views of the National Institutes of Health.