| Name | alert-exporter JSON |
| Version |
0.5.1
JSON |
| download |
| home_page | |
| Summary | Extract alerts configured in different sources (eg: Prometheus Rules, CloudWatch Alarms, Pingdom) |
| upload_time | 2022-12-01 14:05:48 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.7 |
| license | GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007 Extract a list of alerts configured in different sources (eg: Prometheus Rules, CloudWatch Alarms, etc.) Copyright (C) 2022 Baptiste ROUX This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>. Also add information on how to contact you by electronic and paper mail. You should also get your employer (if you work as a programmer) or school, if any, to sign a "copyright disclaimer" for the program, if necessary. For more information on this, and how to apply and follow the GNU GPL, see <http://www.gnu.org/licenses/>. The GNU General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. But first, please read <http://www.gnu.org/philosophy/why-not-lgpl.html>. |
| keywords |
alert_exporter
alert
monitoring
prometheus
cloudwatch
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Alert Exporter
<p>
<a href="https://pypi.org/project/alert-exporter/"><img alt="PyPI" src="https://img.shields.io/pypi/v/alert-exporter"></a>
<a href="https://pypi.org/project/alert-exporter/"><img alt="PyPI - Python Version" src="https://img.shields.io/pypi/pyversions/alert-exporter"></a>
<a href="https://github.com/BapRx/alert-exporter/"><img alt="GitHub repo size" src="https://img.shields.io/github/repo-size/BapRx/alert-exporter"></a>
<a href="https://pypi.org/project/alert-exporter/"><img alt="PyPI - Status" src="https://img.shields.io/pypi/status/alert-exporter"></a>
</p>
## Installation
Use the package manager [pip](https://pip.pypa.io/en/stable/) to install alert-exporter.
```bash
pip install alert-exporter
```
## Usage
```bash
❯ alert-exporter --help
Extract alerts configured in different sources (eg: Prometheus Rules, CloudWatch Alarms, Pingdom)
optional arguments:
-h, --help show this help message and exit
-v, --version show program's version number and exit
--log-level {DEBUG,INFO,WARNING,ERROR}
-o OUTPUT_FILE, --output-file OUTPUT_FILE
--jinja-template [JINJA_TEMPLATE]
-f {markdown,yaml,html}, --format {markdown,yaml,html}
--prometheus
--prometheus-filters PROMETHEUS_FILTERS
--context [CONTEXT]
--cloudwatch
--aws-profile AWS_PROFILE
--aws-region AWS_REGION
Specific region to target. Default: Iterate over all regions available.
--pingdom
--pingdom-api-key PINGDOM_API_KEY
--pingdom-tags PINGDOM_TAGS
Comma separated list of tags. Eg: tag1,tag2
```
### Multiple sources are available, one or many can be selected
#### Kubernetes / Prometheus
The current context is used unless you provide the `--context` flag.
```bash
alert-exporter -o minikube.html --prometheus --context minikube
```
You can filter prometheus rule to match specific labels using the '--prometheus-filters' flag.
```bash
alert-exporter -o minikube.html --prometheus --context minikube --prometheus-filters '{"severity": "critical"}'
```
#### AWS Cloudwatch
All available regions are parsed unless you provide the `--aws-region` flag.
You need to be authenticated before using this tool.
```bash
alert-exporter -o aws.html --cloudwatch --aws-region eu-west-1 --aws-profile profile
```
#### Pingdom
An API key with read only permission is required to fetch the checks. The key can be provided in the `PINGDOM_API_KEY` environment variable.
```bash
alert-exporter -o pingdom.html --pingdom --pingdom-tags example-tag
```
#### Multiple sources at once
```bash
alert-exporter -o combined.html --prometheus --cloudwatch --aws-region eu-west-1
```
### Formats
Predefined formats are provided with this tool:
- HTML
- Markdown
- YAML
You can use a custom format by providing a Jinja2 file with the `--jinja-template` flag.
## HTML output example
<a href="https://raw.githubusercontent.com/BapRx/alert-exporter/master/docs/alerts-html.png"><img alt="HTML output" src="https://raw.githubusercontent.com/BapRx/alert-exporter/master/docs/alerts-html.png"></a>
## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Raw data
{
"_id": null,
"home_page": "",
"name": "alert-exporter",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "alert_exporter,alert,monitoring,prometheus,cloudwatch",
"author": "",
"author_email": "Baptiste ROUX <rouxbaptiste@outlook.com>",
"download_url": "https://files.pythonhosted.org/packages/93/a2/e761bdf2d7bc9446867c2bb58b1d8f3280f289de5c9a475b85696b981e98/alert_exporter-0.5.1.tar.gz",
"platform": null,
"description": "# Alert Exporter\n\n<p>\n<a href=\"https://pypi.org/project/alert-exporter/\"><img alt=\"PyPI\" src=\"https://img.shields.io/pypi/v/alert-exporter\"></a>\n<a href=\"https://pypi.org/project/alert-exporter/\"><img alt=\"PyPI - Python Version\" src=\"https://img.shields.io/pypi/pyversions/alert-exporter\"></a>\n<a href=\"https://github.com/BapRx/alert-exporter/\"><img alt=\"GitHub repo size\" src=\"https://img.shields.io/github/repo-size/BapRx/alert-exporter\"></a>\n<a href=\"https://pypi.org/project/alert-exporter/\"><img alt=\"PyPI - Status\" src=\"https://img.shields.io/pypi/status/alert-exporter\"></a>\n</p>\n\n## Installation\n\nUse the package manager [pip](https://pip.pypa.io/en/stable/) to install alert-exporter.\n\n```bash\npip install alert-exporter\n```\n\n## Usage\n\n```bash\n\u276f alert-exporter --help\nExtract alerts configured in different sources (eg: Prometheus Rules, CloudWatch Alarms, Pingdom)\n\noptional arguments:\n -h, --help show this help message and exit\n -v, --version show program's version number and exit\n --log-level {DEBUG,INFO,WARNING,ERROR}\n -o OUTPUT_FILE, --output-file OUTPUT_FILE\n --jinja-template [JINJA_TEMPLATE]\n -f {markdown,yaml,html}, --format {markdown,yaml,html}\n --prometheus\n --prometheus-filters PROMETHEUS_FILTERS\n --context [CONTEXT]\n --cloudwatch\n --aws-profile AWS_PROFILE\n --aws-region AWS_REGION\n Specific region to target. Default: Iterate over all regions available.\n --pingdom\n --pingdom-api-key PINGDOM_API_KEY\n --pingdom-tags PINGDOM_TAGS\n Comma separated list of tags. Eg: tag1,tag2\n```\n\n### Multiple sources are available, one or many can be selected\n\n#### Kubernetes / Prometheus\n\nThe current context is used unless you provide the `--context` flag.\n\n```bash\nalert-exporter -o minikube.html --prometheus --context minikube\n```\n\nYou can filter prometheus rule to match specific labels using the '--prometheus-filters' flag.\n\n```bash\nalert-exporter -o minikube.html --prometheus --context minikube --prometheus-filters '{\"severity\": \"critical\"}'\n```\n\n#### AWS Cloudwatch\n\nAll available regions are parsed unless you provide the `--aws-region` flag.\n\nYou need to be authenticated before using this tool.\n\n```bash\nalert-exporter -o aws.html --cloudwatch --aws-region eu-west-1 --aws-profile profile\n```\n\n#### Pingdom\n\nAn API key with read only permission is required to fetch the checks. The key can be provided in the `PINGDOM_API_KEY` environment variable.\n\n```bash\nalert-exporter -o pingdom.html --pingdom --pingdom-tags example-tag\n```\n\n#### Multiple sources at once\n\n```bash\nalert-exporter -o combined.html --prometheus --cloudwatch --aws-region eu-west-1\n```\n\n### Formats\n\nPredefined formats are provided with this tool:\n\n- HTML\n- Markdown\n- YAML\n\nYou can use a custom format by providing a Jinja2 file with the `--jinja-template` flag.\n\n## HTML output example\n\n<a href=\"https://raw.githubusercontent.com/BapRx/alert-exporter/master/docs/alerts-html.png\"><img alt=\"HTML output\" src=\"https://raw.githubusercontent.com/BapRx/alert-exporter/master/docs/alerts-html.png\"></a>\n\n## Contributing\n\nPull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.\n",
"bugtrack_url": null,
"license": "GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007 Extract a list of alerts configured in different sources (eg: Prometheus Rules, CloudWatch Alarms, etc.) Copyright (C) 2022 Baptiste ROUX This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>. Also add information on how to contact you by electronic and paper mail. You should also get your employer (if you work as a programmer) or school, if any, to sign a \"copyright disclaimer\" for the program, if necessary. For more information on this, and how to apply and follow the GNU GPL, see <http://www.gnu.org/licenses/>. The GNU General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. But first, please read <http://www.gnu.org/philosophy/why-not-lgpl.html>. ",
"summary": "Extract alerts configured in different sources (eg: Prometheus Rules, CloudWatch Alarms, Pingdom)",
"version": "0.5.1",
"split_keywords": [
"alert_exporter",
"alert",
"monitoring",
"prometheus",
"cloudwatch"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "51006787f26a428c55ebbfc13809c8e6",
"sha256": "228134c43657024f1e96f36d47c3dcd86f32c20f984d33de1ca065be25f7f615"
},
"downloads": -1,
"filename": "alert_exporter-0.5.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "51006787f26a428c55ebbfc13809c8e6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 14304,
"upload_time": "2022-12-01T14:05:29",
"upload_time_iso_8601": "2022-12-01T14:05:29.140009Z",
"url": "https://files.pythonhosted.org/packages/f5/a2/2941f7745fbe82924caa1878e10511010faac33f5d3ee52516f846be1949/alert_exporter-0.5.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "df2f8f52b6ab4ec2ae87db343d4b0ba1",
"sha256": "b793cf354685ed8b3f1fc90eea7a4c124fc5472e710c3a19ada81ba1026b2b44"
},
"downloads": -1,
"filename": "alert_exporter-0.5.1.tar.gz",
"has_sig": false,
"md5_digest": "df2f8f52b6ab4ec2ae87db343d4b0ba1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 147857,
"upload_time": "2022-12-01T14:05:48",
"upload_time_iso_8601": "2022-12-01T14:05:48.017575Z",
"url": "https://files.pythonhosted.org/packages/93/a2/e761bdf2d7bc9446867c2bb58b1d8f3280f289de5c9a475b85696b981e98/alert_exporter-0.5.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-01 14:05:48",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "alert-exporter"
}
