Tag Archives: Sentry

从GH-1372 issue完成时开始，Sentry 7.x转向使用自家定义的SSO Provider，逐渐抛弃django-social-auth结构。因为缺乏文档，我在此事上消耗了大量的时间。现在写这篇Wiki用于记录： 基类：sentry/auth/provider.py 中的 Provider 虚基类 样例：sentry/auth/providers/ 目录下的dummy.py和oauth2.py 两个，以及sentry-sso-google 基于Sentry自带的OAuth2Provider   基本执行流程： 通过django机制加载app，在初始化时调用sentry.auth.manager的register方法，注册自己的名字和class 管理员在 Organization 的Auth页开启SSO时，会生成上述类的一个实例。Sentry的helper.py负责此流程，先调用get_auth_pipeline()函数，取得一个成员为多个 AuthView的超类 的list，然后对着这个list依次执行成员的 dispatch()函数 每个步骤按照pipeline的顺序执行一个AuthView.dispatch(self,request,helper)函数，其中request可以读到当前的django request内容。因为URL都为/auth/sso/ 所以需要根据querystring来判断执行到哪一步了，并收集本步的信息，调用 helper.bind_state() 保存起来，然后return help.next_step()跳到下一步执行 最后build_identify()会被执行，需要返回一个至少包含id、email、name的dict，此dict被Sentry用来构造用户信息。

这插件被大家催了很久了，到1月底终于决定动手做。 准备知识 公众号Pub服务API（内网wiki，链接已删除） 签名请求规范（内网wiki，链接已删除） New Forms of Authentication 插件组成 setup.py 安装脚本。插件注册发现机制请参见 sentry_IM/__init__.py 确保这个目录是python package的文件。顺便查询一下VERSION供引用 sentry_IM/requests_APISign.py 上述New Forms of Authentication文档里提到的requests auth class，提供公司的Authencation验证header sentry_IM/send_IM.py 发消息用的Class sentry_IM/plugin.py 插件本身 程序讲解 插件本身继承自sentry.plugins.bases.notify.NotificationPlugin类，需要实现其notify(self, notification)方法。因基类里notify()调用了notify_users()，所以pylint会有提示。 参数notification为一个对象，可以从中取得event，然后从event取得所属的group以及group所属的project。根据project可以取得要通知的人员列表。（这里抄袭了MailPlugin的发送列表）因为这个函数得到的人员列表是Sentry里的User id，所以还需要再根据id查询到User，然后从其Email字段中取得localpart 最后，根据上述project.name、event.message、group.get_absolute_url() 组装其通知消息文本（URL在IM客户端渲染时才变成超链接，我这里只发URL本身），生成send_IM.py 的实例，对着上述人员列表发送消息文本。 IM插件所需的四个参数，在总的配置文件中列出，由插件生成send_IM实例时传递，然后由其传递给requests_APISign的实例，完成对HTTP请求的签名 配置是否开启 本来是想像MailPlugin那样直接在Account/Notification页做个列表供勾选。但阅读代码发现，这个功能并不是MailPlugin自己的功能，而是sentry做了特殊处理，先获得用户订阅的projects_list，然后循环生成ProjectEmailOptionsForm的list，随后再执行从各插件获取的ext_forms[]配置表单。ext_forms里每一个插件配置表单的初始化参数只有plugin、user和prefix，要想表达“所有可订阅的projects”这个概念会相当啰嗦。因此，最终确定为：表单里只勾选per-User 级别是否开启；而用户是否属于具体某个event/project的发送目标，则直接共用MailPlugin那边的选择，然后再用上述per-User级别开关做一遍过滤。这里两个插件之间略有粘连，主要是由于User-Project之间只有单向对应关系，逆向查询太罗嗦导致的。 最终发送效果 Github地址 https://github.com/julyclyde/sentry-IM

根据 sentry/plugins/bases/__init__.py 的说明，新版插件分类四类，其中常见的： NotificationPlugin 比如sentry_mail、sentry_webhook插件 NotificationPlugin的基类定义参见 sentry/plugins/bases/notify.py

本讨论均基于Sentry 7.7版本 插件机制 自带插件 src/sentry/plugins/ 每插件一个目录 自带插件loader：src/sentry/conf/server.py 里的INSTALLED_APPS tuple 外装插件loader：utils/runner.py 里的 install_plugins()函数，对iter_entry_points()遍历并将其加入INSTALLED_APPS tuple中 外装插件注册：插件的setup.py里执行注册entry_points的过程。例https://github.com/getsentry/sentry-groveio/blob/master/setup.py 参考setuptools:pkg_resources 参考资料：https://pythonhosted.org/setuptools/pkg_resources.html 列出本Python安装的Sentry插件 #!/usr/bin/env python import pkg_resources for ep in pkg_resources.iter_entry_points(‘sentry.apps’):     print str(ep) for ep in pkg_resources.iter_entry_points(‘sentry.plugins’):     print str(ep)   sentry-jira插件 插件基本配置 每Project分别配置，需要输入jira的instance URL、用户名和密码。以上内容base64存在数据库sentry_projectoptions表里 where `key` … Continue reading →