腾讯蓝鲸论坛-专业的技术交流论坛

 找回密码
 立即注册
忘了密码?
搜索
热搜: 用户手册 FAQ
查看: 3404|回复: 2

[经验分享] 蓝鲸监控接入邮件通知服务的方法

[复制链接]

4

主题

0

好友

43

积分

预备会员

Rank: 1

发表于 2017-4-29 18:26:50 |显示全部楼层
    作为蓝鲸的合作伙伴必然也是蓝鲸3.0内测用户之一,众所周知在蓝鲸3.0中内置了一个蓝鲸监控的APP,而在该APP可选择的接收告警信息的方式有邮件、短信和微信三种。然而,在蓝鲸3.0中内置的三种通知服务的ESB组件是未完成的,需要我们进行少量的代码编辑才能使得通知服务正常工作。本帖子分享的是邮件通知服务的接入方法,希望对大家有帮助。

第一步,查阅ESB文档。
    打开ESB文档,查阅send_mail的使用说明。为什么要先来看文档呢?因为我们接下来要去编辑该组件的py文件,不先看看文档都定义了哪些字段,需要传哪些参数,我们怎么知道怎么去修改py文件呢?
再次强调一下,必须要严格保障该组件的输入参数要求和输出参数要求是符合api文档要求的。因为在监控APP里面已经是按照这个要求去调用了,否则的话会导致监控APP里调用该组件发送邮件不成功的。
1.png


         从文档中,我们可以看出必传参数有app_code、app_secret、title、content。然后再想一下发邮件是不是需要发件人?然而在这里发件人竟然不是比传参数?那就意味着在我们的py文件里面必须要写死一个发件人,因为监控APP调用这个组件进行发送邮件的时候根本没有传发件人这个参数。这也是能理解的,每家企业情况不一样,监控APP怎么知道每家的发件人账号是什么呢,对吧?另外,再想一下,发邮件是不是也要收件人?在监控APP里,调用该组件发送邮件的时候,是去平台的用户中心通过用户名来获取到该用户的邮箱地址的,所以大家在注册用户的时候必须要填有效的邮箱账号哦,否则收不到邮件哦。

    最后,作为吃螃蟹的人,告诉一下大家,监控APP调用该组件的时候传入了哪些参数。
1.png


         如果你想亲自验证下是否就传了这几个参数,可以去到/data/bksuite-3.0.9-beta/datasvr/bkdata/bk_bkdata_monitor/bin目录下运行check.sh。在你还没通该组件之前,检查【邮件通知】是异常的,此时你是可以看到相关日志的,如下图:
1.png


    当该组件服务接通之后,在测试就会看到检查正常的结果了,如下截图:
1.png


第二步,下载send_mail组件文档,编写代码以完善邮件通知服务组件。
    完整的send_mail.py文件和config.py文件都已经分享到论坛中了,链接如下:http://bbs.bk.tencent.com/forum.php?mod=viewthread&tid=333&extra=page%3D1
    在此我也不再重复啰嗦了,作为参加过早起鸟儿培训的童鞋们,应该是能看懂组件里面的逻辑的。注意事项呢我就再提两个:
1.      py文件里面用到了email这个库,请记得使用命令进行安装

2.      正如论坛上所提示的那样,Component本身有个invoke_other,特定用途的,请不要重写该函数。在send_mail的示例代码中,有这么一句话
1.png


    不要贪图便利就直接使用invoke_other这个函数了,而是改成我们自定义的函数,例如重新定义一个send_mail
1.png


    最后就是重启ESB服务了。
第三步,测试组件是否正常。
    在第二步中已经编写好了py文件,并且也重启了ESB服务,如果py文件写得没问题,应该就是可以收到邮件的。但是我们还是要进行测试一下。
1.png


    如果成功的话,你会收到一封测试的邮件,如下截图:
1.png


    如果没有成功,那么请去查看esb.log的日志,然后再针对报错进行排查。
第四步,测试监控APP是否能正常发送告警邮件。
    如果在第三步都可以正常接收到邮件了,监控APP应该也是可以正常发送告警邮件了。如果没有收到告警邮件,首先去监控APP的首页看下【近期告警事件】是否有告警触发了,如果没有,请先去建相关的告警策略以触发告警。如果有,并且第三步也正常,那么此时请联系蓝鲸的客服吧。
  以上的分享,希望对大家有帮助。

3

主题

1

好友

2245

积分

进阶会员

Rank: 4

发表于 2017-6-8 13:34:45 |显示全部楼层
您好,您这个帖子能写的更详细点吗?

2

主题

1

好友

156

积分

预备会员

Rank: 1

发表于 2017-6-8 15:05:24 |显示全部楼层
来 我来补充一下;
蓝鲸监控接入邮件通知服务的方法_补充.jpg
您需要登录后才可以回帖 登录 | 立即注册

蓝鲸官网

GMT+8, 2018-1-21 12:42

Powered by Discuz! X2.5

© 2001-2012 Comsenz Inc.

回顶部