{"id":13489681,"url":"https://github.com/line/promgen","last_synced_at":"2025-05-14T07:10:37.750Z","repository":{"id":10239479,"uuid":"64717629","full_name":"line/promgen","owner":"line","description":"Promgen is a configuration file generator for Prometheus","archived":false,"fork":false,"pushed_at":"2025-04-25T02:26:41.000Z","size":3983,"stargazers_count":1084,"open_issues_count":33,"forks_count":151,"subscribers_count":46,"default_branch":"master","last_synced_at":"2025-04-25T03:27:11.655Z","etag":null,"topics":["django","monitoring","prometheus"],"latest_commit_sha":null,"homepage":"https://line.github.io/promgen/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/line.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2016-08-02T02:35:13.000Z","updated_at":"2025-04-25T02:18:19.000Z","dependencies_parsed_at":"2023-02-16T12:31:02.838Z","dependency_job_id":"4a8bd524-248f-4cec-9250-8d345d30d6ac","html_url":"https://github.com/line/promgen","commit_stats":{"total_commits":1374,"total_committers":25,"mean_commits":54.96,"dds":0.1506550218340611,"last_synced_commit":"4ed6d1b35043b3a9ee51e8171b7f6178846970da"},"previous_names":[],"tags_count":106,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/line%2Fpromgen","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/line%2Fpromgen/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/line%2Fpromgen/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/line%2Fpromgen/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/line","download_url":"https://codeload.github.com/line/promgen/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254092798,"owners_count":22013292,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["django","monitoring","prometheus"],"created_at":"2024-07-31T19:00:33.206Z","updated_at":"2025-05-14T07:10:32.740Z","avatar_url":"https://github.com/line.png","language":"JavaScript","readme":"# What is Promgen?\n\nPromgen is a configuration file generator for [Prometheus](https://prometheus.io). Promgen is a web application written with [Django](https://docs.djangoproject.com/en/1.10/) and can help you do the following jobs.\n\n- Create and manage Prometheus configuration files\n- Configure alert rules and notification options\n\nSee the [Promgen introduction slides](https://www.slideshare.net/tokuhirom/promgen-prometheus-managemnet-tool-simpleclientjava-hacks-prometheus-casual) for the original history of Promgen.\n\nSee https://line.github.io/promgen/ for additional documentation.\n\n## Promgen screenshots\n\n![screenshot](docs/images/screenshot.png)\n\n## Contributing\n\nBelow are the steps to get started with Promgen.\n\nPlease see [CONTRIBUTING.md](https://github.com/line/promgen/blob/master/CONTRIBUTING.md) for contributing to Promgen.\n\nIf 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 to dl_oss_dev@linecorp.com.\n\n### 1. Initialize Promgen\n\nInitialize Promgen using Docker.\n\n```bash\n# Create promgen setting directory.\nmkdir -p ~/.config/promgen\nchmod 777 ~/.config/promgen\n\n# Initialize required settings with Docker container\n# This will prompt you for connection settings for your database and Redis broker\n# using the standard DSN syntax.\n# Database example: mysql://username:password@hostname/databasename\n# Broker example: redis://localhost:6379/0\ndocker run --rm -it -v ~/.config/promgen:/etc/promgen/ line/promgen docker-compose-bootstrap\n\n# Apply database updates\ndocker run --rm -v ~/.config/promgen:/etc/promgen/ line/promgen migrate\n\n# You can then check your configuration to ensure everything correct\ndocker run --rm -v ~/.config/promgen:/etc/promgen/ line/promgen check\n\n# Create initial login user. This is the same as the default django-admin command\n# https://docs.djangoproject.com/en/1.10/ref/django-admin/#django-admin-createsuperuser\ndocker run --rm -it -v ~/.config/promgen:/etc/promgen/ line/promgen createsuperuser\n```\n\nYou can then use your favorite configuration management system to deploy to each worker.\n\n\u003e Note: Promgen aims to use the [XDG](https://specifications.freedesktop.org/basedir-spec/latest/ar01s03.html) specs and follows suggestions made by the [12-Factor App](https://12factor.net/).\n\n### 2. Configure Prometheus\n\nConfigure Prometheus to load the target file from Prometheus and configure AlertManager to send notifications back to Promgen.\n\nSee the example settings files for proper configuration of Prometheus and AlertManager.\n\n- [Example settings file](promgen/tests/examples/promgen.yml)\n- [Example Prometheus file](docker/prometheus.yml)\n- [Example AlertManager file](docker/alertmanager.yml)\n\n### 3. Run Promgen\n\nRun Promgen using the following command.\n\n```bash\n# Run Promgen web worker. This is typically balanced behind an NGINX instance\ndocker run --rm -p 8000:8000 -v ~/.config/promgen:/etc/promgen/ line/promgen\n\n# Run Promgen celery worker. Make sure to run it on the same machine as your Prometheus server to manage the config settings\ndocker run --rm -v ~/.config/promgen:/etc/promgen/ -v /etc/prometheus:/etc/prometheus line/promgen worker\n\n# If you are using docker compose, you can spin up a demo environment\ndocker-compose up -d\n# Database migration to populate with initial data\ndocker-compose run web docker-compose-bootstrap\n# If you want to create a different admin user\ndocker-compose run web createsuperuser\n# Now you should be able to open the demo environment in your browser\n```\n\n## The MIT License\n\nCopyright (c) 2017 LINE Corporation\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n","funding_links":[],"categories":["JavaScript","Python","monitoring","Observability"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fline%2Fpromgen","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fline%2Fpromgen","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fline%2Fpromgen/lists"}