Name | zcp-alert-backend JSON |
Version |
1.0.0
JSON |
| download |
home_page | None |
Summary | This is the backend service for the alert management of the Cloud Z MP solution |
upload_time | 2024-12-06 07:38:55 |
maintainer | None |
docs_url | None |
author | Kilsoo Kang |
requires_python | <4.0,>=3.12 |
license | Apache License Version 2.0 |
keywords |
|
VCS |
|
bugtrack_url |
|
requirements |
No requirements were recorded.
|
Travis-CI |
No Travis.
|
coveralls test coverage |
No coveralls.
|
# zcp-alert-backend
![Platform Badge](https://img.shields.io/badge/platform-zmp-red)
![Component Badge](https://img.shields.io/badge/compolent-alert-red)
![CI Badge](https://img.shields.io/badge/ci-github_action-green)
![License Badge](https://img.shields.io/badge/license-Apache_2.0-green)
![PyPI - Version](https://img.shields.io/pypi/v/zcp-alert-backend)
![PyPI - Implementation](https://img.shields.io/pypi/implementation/zcp-alert-backend)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/zcp-alert-backend)
![PyPI - Wheel](https://img.shields.io/pypi/wheel/zcp-alert-backend)
<!-- ![Language Badge](https://img.shields.io/badge/language-python-blue)
![Version Badge](https://img.shields.io/badge/version-^3.12-blue) -->
The zcp-alert-backend is the software that manages alerts, channels, integrations, and silences for alert notifications.
## Architecture
![Alert architecture on the cloudzcp platform](alert-architecture.png)
## Features
### 1. Alert Management
The alert-backend receives the alert from the alertmanager of the corext monitoring system and the OpenSearch.
And then saves the alert playload into the MongoDB for the lifecyle managment.
#### State Diagram
![alt text](alert-state-diagram.png)
### 2. Channel Management
The alert-backend manages the notification channel.
Supported the third-party is
- Slack
- MS Teams
- Goole Chat
- Kakaotalk
- Emal
- Webhook
### 3. Integration Management
The alert-backend manages the integrations for the notification to the channels using the alert information.
e.g.) prioity, severity, cluster, project and labels
### 4. Silence Management
The alert-backend manages the silence to snooze the alert notification to the channel during defined period (for maintenance job)
### 5. Dashboard
The alert-backend provides the status dashboard and MTTA, MTTR dashbord
Raw data
{
"_id": null,
"home_page": null,
"name": "zcp-alert-backend",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.12",
"maintainer_email": null,
"keywords": null,
"author": "Kilsoo Kang",
"author_email": "kilsoo75@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/db/b0/29efc97ab73ebb8c49070f92fe96d255b83e00e9043a9f970d708891051a/zcp_alert_backend-1.0.0.tar.gz",
"platform": null,
"description": "# zcp-alert-backend\n\n![Platform Badge](https://img.shields.io/badge/platform-zmp-red)\n![Component Badge](https://img.shields.io/badge/compolent-alert-red)\n![CI Badge](https://img.shields.io/badge/ci-github_action-green)\n![License Badge](https://img.shields.io/badge/license-Apache_2.0-green)\n![PyPI - Version](https://img.shields.io/pypi/v/zcp-alert-backend)\n![PyPI - Implementation](https://img.shields.io/pypi/implementation/zcp-alert-backend)\n![PyPI - Python Version](https://img.shields.io/pypi/pyversions/zcp-alert-backend)\n![PyPI - Wheel](https://img.shields.io/pypi/wheel/zcp-alert-backend)\n\n<!-- ![Language Badge](https://img.shields.io/badge/language-python-blue)\n![Version Badge](https://img.shields.io/badge/version-^3.12-blue) -->\n\nThe zcp-alert-backend is the software that manages alerts, channels, integrations, and silences for alert notifications.\n\n## Architecture\n![Alert architecture on the cloudzcp platform](alert-architecture.png)\n\n## Features\n### 1. Alert Management\nThe alert-backend receives the alert from the alertmanager of the corext monitoring system and the OpenSearch.\nAnd then saves the alert playload into the MongoDB for the lifecyle managment.\n\n#### State Diagram\n![alt text](alert-state-diagram.png)\n\n### 2. Channel Management\nThe alert-backend manages the notification channel.\n\nSupported the third-party is\n- Slack\n- MS Teams\n- Goole Chat\n- Kakaotalk\n- Emal\n- Webhook\n\n### 3. Integration Management\nThe alert-backend manages the integrations for the notification to the channels using the alert information.\n\ne.g.) prioity, severity, cluster, project and labels\n\n### 4. Silence Management\nThe alert-backend manages the silence to snooze the alert notification to the channel during defined period (for maintenance job)\n\n### 5. Dashboard\nThe alert-backend provides the status dashboard and MTTA, MTTR dashbord\n",
"bugtrack_url": null,
"license": "Apache License Version 2.0",
"summary": "This is the backend service for the alert management of the Cloud Z MP solution",
"version": "1.0.0",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "852accbc2dd89e644e59167cc4af3ee8cc2bdb3a83240ea206af438880656118",
"md5": "31723b4c995150541bb994d0b195dd19",
"sha256": "c524805fc24e36597abf4c4aeadc032b59f9b5b6f539f2794c196737232889c0"
},
"downloads": -1,
"filename": "zcp_alert_backend-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "31723b4c995150541bb994d0b195dd19",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.12",
"size": 109466,
"upload_time": "2024-12-06T07:38:54",
"upload_time_iso_8601": "2024-12-06T07:38:54.201150Z",
"url": "https://files.pythonhosted.org/packages/85/2a/ccbc2dd89e644e59167cc4af3ee8cc2bdb3a83240ea206af438880656118/zcp_alert_backend-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "dbb029efc97ab73ebb8c49070f92fe96d255b83e00e9043a9f970d708891051a",
"md5": "d5b52efa0c8ac59241d66e228dfbe701",
"sha256": "15d72734869858fd5db56d95c06697fa37666a832ee42b67abc099e0bebda0d8"
},
"downloads": -1,
"filename": "zcp_alert_backend-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "d5b52efa0c8ac59241d66e228dfbe701",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.12",
"size": 78105,
"upload_time": "2024-12-06T07:38:55",
"upload_time_iso_8601": "2024-12-06T07:38:55.930242Z",
"url": "https://files.pythonhosted.org/packages/db/b0/29efc97ab73ebb8c49070f92fe96d255b83e00e9043a9f970d708891051a/zcp_alert_backend-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-06 07:38:55",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "zcp-alert-backend"
}