Package: promgen
What is Promgen?Promgen is a configuration file generator forPrometheus. Promgen is a web application written withDjangoand can help you do the following jobs.Create and manage Prometheus configuration filesConfigure alert rules and notification optionsSee thePromgen introduction slidesfor the original history of Promgen.Seehttps://line.github.io/promgen/for additional documentation.Promgen screenshotsContributingBelow are the steps to get started with Promgen.Please seeCONTRIBUTING.mdfor contributing to Promgen.If you believe you have discovered a vulnerability or have an issue related to security, please DO NOT open a public issue. Instead, send us a mail todl_oss_dev@linecorp.com.1. Initialize PromgenInitialize Promgen using Docker.# Create promgen setting directory.mkdir-p~/.config/promgen
chmod777~/.config/promgen# Initialize required settings with Docker container# This will prompt you for connection settings for your database and Redis broker# using the standard DSN syntax.# Database example: mysql://username:password@hostname/databasename# Broker example: redis://localhost:6379/0dockerrun--rm-it-v~/.config/promgen:/etc/promgen/line/promgenbootstrap# Apply database updatesdockerrun--rm-v~/.config/promgen:/etc/promgen/line/promgenmigrate# You can then check your configuration to ensure everything correctdockerrun--rm-v~/.config/promgen:/etc/promgen/line/promgencheck# Create initial login user. This is the same as the default django-admin command# https://docs.djangoproject.com/en/1.10/ref/django-admin/#django-admin-createsuperuserdockerrun--rm-it-v~/.config/promgen:/etc/promgen/line/promgencreatesuperuserYou can then use your favorite configuration management system to deploy to each worker.Note: Promgen aims to use theXDGspecs and follows suggestions made by the12-Factor App.2. Configure PrometheusConfigure 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.Example settings fileExample Prometheus fileExample AlertManager file3. Run PromgenRun Promgen using the following command.# Run Promgen web worker. This is typically balanced behind an NGINX instancedockerrun--rm-p8000:8000-v~/.config/promgen:/etc/promgen/line/promgen# Run Promgen celery worker. Make sure to run it on the same machine as your Prometheus server to manage the config settingsdockerrun--rm-v~/.config/promgen:/etc/promgen/-v/etc/prometheus:/etc/prometheusline/promgenworker# Or if using docker-compose you can spin up a complete test environmentdocker-composeup-d# Database Migrationdocker-composerunwebmigrate# Create initial userdocker-composerunwebcreatesuperuserThe MIT LicenseCopyright (c) 2017 LINE CorporationPermission 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.