Sentry 插件编写总结

sentry 插件需要特定的结构才能正常工作,最简单的结构即为本插件的文件结构。

sentry-rtx   *
│  .gitignore
│  README.md
│  setup.cfg
│  setup.py    *
└─ sentry_rtx    *
        plugin.py    *
        tof_api.py
        __init__.py

主要编写其中的 setup.py 和 plugin.py

sentry_rtx/plugin.py 中实现自己的通知插件类,通知类型的插件 is_configurednotify_users 是需要自己实现的。

sentry-rtx/setup.py 中,插件通过 entry_points 来自动注册。

编写完成后在 setup.py 目录运行安装命令

python setup.py install
# 或者pip install -e .

安装时如果需要指定 pypi 源可以在 setup.cfg 中设置

完成后,重启 Sentry 服务,进入 sentry web 界面,在需要使用该插件的项目下点击【项目设置】,配置处选择【警报】(/settings/alerts/),在设置tab最下方可以看到一个【无效集成】中有你新安装的插件,点击它开启插件。

dev tips:

  • 安装完自己写的插件后,使用SENTRY_CONF=/etc/sentry sentry upgrade可以检查插件是否报错。
  • 查看已安装的插件:SENTRY_CONF=/etc/sentry sentry plugins list
  • /manage/status/packages/页面可以看到已安装的插件

也可以看看


全国大流量卡免费领

19元月租ㆍ超值优惠ㆍ长期套餐ㆍ免费包邮ㆍ官方正品