Update wechat_qiye_alert.py

完善注释

Author: anjia0532

wechat_qiye_alert.py

@@ -12,14 +12,14 @@
 import requests
 
 '''
-##########################################################
-# 微信企业号推送消息                                     #
-#                                                        #
-# 作者: AnJia <[email protected]>                      #
-# 作者博客: https://anjia.ml/                            #
-# Github: https://github.com/anjia0532/weixin-qiye-alert #
-#                                                        #
-##########################################################
+#################################################################
+# 微信企业号推送消息                                              #
+#                                                               #
+# 作者: AnJia <[email protected]>                              #
+# 作者博客: https://anjia.ml/                                    #
+# Github: https://github.com/anjia0532/elastalert-wechat-plugin #
+#                                                               #
+#################################################################
 '''
 class WeChatAlerter(Alerter):
 
@@ -44,20 +44,22 @@ def create_default_title(self, matches):
         return subject
 
     def alert(self, matches):
+        
+        # 参考elastalert的写法
         # https://github.com/Yelp/elastalert/blob/master/elastalert/alerts.py#L236-L243
+        
         body = self.create_alert_body(matches)
 
+        # 微信企业号获取Token文档
         # http://qydev.weixin.qq.com/wiki/index.php?title=AccessToken
         self.get_token()
 
-        #print self.access_token
-        #print self.expires_in
-
         self.senddata(body)
-        elastalert_logger.info("发送消息给 %s" % (self.corp_id))
+        elastalert_logger.info("send message to %s" % (self.corp_id))
 
     def get_token(self):
 
+        #获取token是有次数限制的,本想本地缓存过期时间和token，但是elastalert每次调用都是一次性的，不能全局缓存
         #if self.expires_in >= datetime.datetime.now() and not self.access_token:
         #    return self.access_token
 
@@ -74,7 +76,11 @@ def get_token(self):
         token_data = token_file.read().decode('utf-8')
         token_json = json.loads(token_data)
         token_json.keys()
-
+        
+        if token_json['access_token'] is None :
+            print token_data
+            sys.exit()
+        
         #获取access_token和expires_in
         self.access_token = token_json['access_token']
         #self.expires_in = datetime.datetime.now() + datetime.timedelta(seconds=token_json['expires_in'])
@@ -87,15 +93,16 @@ def senddata(self, content):
 
         if len(content) > 2000:
             content = content[:1997] + "..."
-
+        # 微信发送消息文档
+        # http://qydev.weixin.qq.com/wiki/index.php?title=%E6%B6%88%E6%81%AF%E7%B1%BB%E5%9E%8B%E5%8F%8A%E6%95%B0%E6%8D%AE%E6%A0%BC%E5%BC%8F
         send_url = 'https://qyapi.weixin.qq.com/cgi-bin/message/send?access_token=' + self.access_token
 
         headers = {'content-type': 'application/json'}
 
         payload = {
-            "touser": self.user_id,
-            "toparty": self.party_id,
-            "totag": self.tag_id,
+            "touser": self.user_id, #用户账户，建议使用tag
+            "toparty": self.party_id, #部门id，建议使用tag
+            "totag": self.tag_id, #tag可以很灵活的控制发送群体细粒度。比较理想的推送应该是，在heartbeat或者其他elastic工具自定义字段，添加标签id。这边根据自定义的标签id，进行推送
             'msgtype': "text",
             "agentid": self.agent_id,
             "text":{
@@ -105,6 +112,7 @@ def senddata(self, content):
         }
 
         # set https proxy, if it was provided
+        # 如果需要设置代理，可修改此参数并传入requests
         # proxies = {'https': self.pagerduty_proxy} if self.pagerduty_proxy else None
         try:
             response = requests.post(send_url, data=json.dumps(payload, ensure_ascii=False), headers=headers)
@@ -118,4 +126,4 @@ def senddata(self, content):
 
 
     def get_info(self):
-        return {'type': 'WeChatAlerter'}
+        return {'type': 'WeChatAlerter'}