# Sentry DingTalk
Sentry 集成钉钉机器人通知
## Requirments
- sentry >= 21.5.1
## 特性
- 发送异常通知到钉钉
- 支持钉钉机器人webhook设置关键字
- 支持配置多个钉钉机器人，并根据 flag 标记将特定消息发送到不同的机器人
- 配置环境变量
- DINGTALK_WEBHOOK: Optional(string)
- DINGTALK_CUSTOM_KEYWORD: Optional(string)
## 快速使用
### 安装
1. 使用 `pip` 命令
```bash
pip install sentry-dingtalks-notify
```
2. 写入依赖文件 `onpremise-xxx/sentry/requirements.txt`
```bash
echo sentry-dingtalks-notify >> requirements.txt
```
### 钉钉机器人
[配置](https://developers.dingtalk.com/document/app/custom-robot-access)钉钉机器人并拿到对应的 webhook, 可以对机器人设置 关键词、签名、IP限制
### 配置
在 Sentry 面板 Settings > Integrations 中找到 DingTalk 并配置 webhook、关键词等信息，添加项目，创建告警规则
### 测试
1. Enable Plugin
2. Test Plugin
Raw data
{
"_id": null,
"home_page": "https://github.com/damengzhang/sentry-dingtalks-notify",
"name": "sentry-dingtalks-notify",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6.13",
"maintainer_email": null,
"keywords": "sentry dingtalk",
"author": "damengzhang",
"author_email": "damengzhang@163.com",
"download_url": "https://files.pythonhosted.org/packages/af/f9/313306a0d17e9517747937c752c1ec7003a263d7a4d3a818d5988f81536e/sentry_dingtalks_notify-1.0.0.tar.gz",
"platform": null,
"description": "\r\n# Sentry DingTalk\r\n\r\nSentry \u96c6\u6210\u9489\u9489\u673a\u5668\u4eba\u901a\u77e5\r\n\r\n## Requirments \r\n- sentry >= 21.5.1\r\n\r\n## \u7279\u6027\r\n- \u53d1\u9001\u5f02\u5e38\u901a\u77e5\u5230\u9489\u9489\r\n- \u652f\u6301\u9489\u9489\u673a\u5668\u4ebawebhook\u8bbe\u7f6e\u5173\u952e\u5b57\r\n- \u652f\u6301\u914d\u7f6e\u591a\u4e2a\u9489\u9489\u673a\u5668\u4eba\uff0c\u5e76\u6839\u636e flag \u6807\u8bb0\u5c06\u7279\u5b9a\u6d88\u606f\u53d1\u9001\u5230\u4e0d\u540c\u7684\u673a\u5668\u4eba\r\n- \u914d\u7f6e\u73af\u5883\u53d8\u91cf\r\n - DINGTALK_WEBHOOK: Optional(string)\r\n - DINGTALK_CUSTOM_KEYWORD: Optional(string)\r\n## \u5feb\u901f\u4f7f\u7528\r\n### \u5b89\u88c5\r\n1. \u4f7f\u7528 `pip` \u547d\u4ee4\r\n ```bash\r\n pip install sentry-dingtalks-notify\r\n ```\r\n\r\n2. \u5199\u5165\u4f9d\u8d56\u6587\u4ef6 `onpremise-xxx/sentry/requirements.txt`\r\n\r\n ```bash\r\n echo sentry-dingtalks-notify >> requirements.txt\r\n ```\r\n\r\n### \u9489\u9489\u673a\u5668\u4eba\r\n[\u914d\u7f6e](https://developers.dingtalk.com/document/app/custom-robot-access)\u9489\u9489\u673a\u5668\u4eba\u5e76\u62ff\u5230\u5bf9\u5e94\u7684 webhook, \u53ef\u4ee5\u5bf9\u673a\u5668\u4eba\u8bbe\u7f6e \u5173\u952e\u8bcd\u3001\u7b7e\u540d\u3001IP\u9650\u5236\r\n\r\n### \u914d\u7f6e\r\n\u5728 Sentry \u9762\u677f Settings > Integrations \u4e2d\u627e\u5230 DingTalk \u5e76\u914d\u7f6e webhook\u3001\u5173\u952e\u8bcd\u7b49\u4fe1\u606f\uff0c\u6dfb\u52a0\u9879\u76ee\uff0c\u521b\u5efa\u544a\u8b66\u89c4\u5219\r\n\r\n### \u6d4b\u8bd5\r\n1. Enable Plugin\r\n2. Test Plugin\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A sentry extension integrates DingTalk robot webhook",
"version": "1.0.0",
"project_urls": {
"Homepage": "https://github.com/damengzhang/sentry-dingtalks-notify"
},
"split_keywords": [
"sentry",
"dingtalk"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3957fc30b5067abafe05865dce28196d2a7fefd5dc8ae0d39995757c826a4c6d",
"md5": "09874ddf7edfbda08d1262472844acd3",
"sha256": "31a5148bd3691865f09a9f477b5b27c57606c95e92c83d98c0a8a6401085b560"
},
"downloads": -1,
"filename": "sentry_dingtalks_notify-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "09874ddf7edfbda08d1262472844acd3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6.13",
"size": 5181,
"upload_time": "2024-12-03T02:24:19",
"upload_time_iso_8601": "2024-12-03T02:24:19.168773Z",
"url": "https://files.pythonhosted.org/packages/39/57/fc30b5067abafe05865dce28196d2a7fefd5dc8ae0d39995757c826a4c6d/sentry_dingtalks_notify-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "aff9313306a0d17e9517747937c752c1ec7003a263d7a4d3a818d5988f81536e",
"md5": "12c92c282d369c97cc1e970ad5a55b10",
"sha256": "7424a614b650ccdc9167e0e964cc8ddae3f171b289539b0df5ae687531e346d9"
},
"downloads": -1,
"filename": "sentry_dingtalks_notify-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "12c92c282d369c97cc1e970ad5a55b10",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6.13",
"size": 5548,
"upload_time": "2024-12-03T02:24:20",
"upload_time_iso_8601": "2024-12-03T02:24:20.995604Z",
"url": "https://files.pythonhosted.org/packages/af/f9/313306a0d17e9517747937c752c1ec7003a263d7a4d3a818d5988f81536e/sentry_dingtalks_notify-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-03 02:24:20",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "damengzhang",
"github_project": "sentry-dingtalks-notify",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "sentry-dingtalks-notify"
}
JSON
