如何开发ChatOps

简介: 如何开发ChatOps

目的是什么

为啥要开发ChatOps,那是个啥玩意?

现在各种Ops,比如DevOps,AIOps,ChatOps,NoOps等等,反正其背后的意义就是各种卷运维,让运维无路可走。

既然如此,为何咱还出力不讨好的开发ChatOps呢?

我的理解是“闲的”,用聊天的形式来做一些运维工作。

典型的应用场景如下: (1)、和 Jenkins、GitLab、GitHub 等 CI/CD 工具结合,执行构建、发布,代码合并等。 (2)、和 JIRA、Trello、Tower、禅道、邮件等办公系统结合起来,处理任务。 (3)、和 Kubernetes 云平台结合起来,执行容器的创建、发布等管理。 (4)、和 Zabbix、Prometheus、Open-Falcon 等监控系统结合,接收监控消息

ChatOps 站在巨人的肩膀上发展,也为工作带来了显而易见的好处:

  • 公开透明。所有的工作消息都在同一个聊天平台中沉淀并公开给所有相关成员,消除沟通壁垒,工作历史有迹可循,团队合作更加顺畅。
  • 上下文共享。减少因工作台切换等对消息的截断,保证消息的完整性,让工作承接有序,各角色,各工具都成为完成工作流中的一环,打造真正流畅的工作体验。
  • 移动友好。只需要在前台与预设好的机器人对话即可完成与后台工具、系统的交互,在移动环境下无需再与众多复杂的工具直接对接,大大提升移动办公的可行性。
  • DevOps 文化打造。用与机器人对话这种简单的方式降低 DevOps 的接受门槛,让这种自动化办公的理念更容易的扩展到团队的每一个角落。

本篇文章就简单使用钉钉机器人来做ChatOps。

添加钉钉机器人

登录钉钉开发者后台,依次选择应用开发 > 企业内部开发 > 机器人,点击创建应用

640.png

640.png

然后记住AppKey和AppSecret,如下:

640.png

配置服务器出口IP和消息接收地址,如下:

640.png

640.png

注意:配置https地址需要对应的有效证书。

开发机器人

HTTP HEADER

{
  "Content-Type": "application/json; charset=utf-8",
  "timestamp": "1577262236757",
  "sign":"xxxxxxxxxx"
}
参数 说明
timestamp 消息发送的时间戳,单位是毫秒。
sign 签名值。

开发者需对header中的timestamp和sign进行验证,以判断是否是来自钉钉的合法请求,避免其他仿冒钉钉调用开发者的HTTPS服务传送数据,具体验证逻辑如下:

  • timestamp 与系统当前时间戳如果相差1小时以上,则认为是非法的请求。
  • sign 与开发者自己计算的结果不一致,则认为是非法的请求。

必须当timestamp和sign同时验证通过,才能认为是来自钉钉的合法请求。sign的计算方法: header中的timestamp + "\n" + 机器人的appSecret当做签名字符串,使用HmacSHA256算法计算签名,然后进行Base64 encode,得到最终的签名值。

使用Go开发的样例如下:

package main
import (
 "bytes"
 "crypto/hmac"
 "crypto/sha256"
 "encoding/base64"
 "encoding/json"
 "fmt"
 "io/ioutil"
 "net/http"
 "net/url"
 "strconv"
 "github.com/gin-gonic/gin"
)
const (
 appSecret   = "xxx-xxx"
 baseHookUrl = "https://oapi.dingtalk.com/robot/send"
 accessToken = "xxx"
)
// Body请求体
type incoming struct {
 MsgType           string              `json:"msgtype"`
 Text              *Text               `json:"text"`
 MsgId             string              `json:"msgId"`
 CreateAt          int64               `json:"createAt"`
 ConversationType  string              `json:"conversationType"` // 1-单聊、2-群聊
 ConversationId    string              `json:"conversationId"`   // // 加密的会话ID
 ConversationTitle string              `json:"conversationId"`   // 会话标题(群聊时才有)
 SenderId          string              `json:"senderId"`
 SenderNick        string              `json:"senderNick"`
 SenderCorpId      string              `json:"senderCorpId"`
 SenderStaffId     string              `json:"senderStaffId"`
 ChatbotUserId     string              `json:"chatbotUserId"`
 AtUsers           []map[string]string `json:"atUsers"`
 SessionWebhook string `json:"sessionWebhook"`
 IsAdmin        bool   `json:"isAdmin"`
}
// Message 钉钉消息
type Message struct {
 MsgType string `json:"msgtype"`
 At      At     `json:"at,omitempty"`
 Text     *Text     `json:"text,omitempty"`
 Markdown *Markdown `json:"markdown,omitempty"`
 Link     *Link     `json:"link,omitempty"`
}
// At  定义需要at的用户
type At struct {
 AtMobiles []string `json:"atMobiles,omitempty"`
 IsAtAll   bool     `json:"isAtAll,omitempty"`
}
// MarkDown 类型
type Markdown struct {
 Title string `json:"title,omitempty"`
 Text  string `json:"text,omitempty"`
}
// Text text类型
type Text struct {
 Content string `json:"content,omitempty"`
}
// Link feedCard类型 links 参数
type Link struct {
 Title      string `json:"title,omitempty"`
 Text       string `json:"text,omitempty"`
 MessageURL string `json:"messageURL,omitempty"`
 PicURL     string `json:"picURL,omitempty"`
}
func main() {
 r := gin.New()
 r.POST("/chatops", func(c *gin.Context) {
  // 定义两个变量,其中data是获取request的body,sign是加签
  var (
   sign string
   data []byte
  )
  // 获取body里的请求参数
  //fmt.Println(c.Request.Header)
  httpSign := c.Request.Header.Get("Sign")
  httpTimestamp := c.Request.Header.Get("Timestamp")
  // timestamp 与系统当前时间戳如果相差1小时以上,则认为是非法的请求。
  if tsi, err := strconv.ParseInt(httpTimestamp, 10, 64); err != nil {
   fmt.Println("请求头可能未附加时间戳信息!!")
  } else {
   data, _ = ioutil.ReadAll(c.Request.Body)
   sign = signature(tsi, appSecret)
  }
  // 校验通过
  if httpSign == sign {
   // 获取消息内容
   var body incoming
   if err := json.Unmarshal(data, &body); err != nil {
    fmt.Println(err)
    return
   }
   // 获取文本内容
   content := body.Text.Content
   fmt.Println(content)
   // 根据内容判断做处理
   // 将处理结果返回给机器人
   sendDingTalk("主人," + content)
  }
 })
 r.Run(":9000")
}
func signature(ts int64, secret string) string {
 strToSign := fmt.Sprintf("%d\n%s", ts, secret)
 hmac256 := hmac.New(sha256.New, []byte(secret))
 hmac256.Write([]byte(strToSign))
 data := hmac256.Sum(nil)
 return base64.StdEncoding.EncodeToString(data)
}
func sendDingTalk(content string) {
 msg := &Message{
  MsgType: "markdown",
  At:      At{},
  Markdown: &Markdown{
   Title: "消息测试",
   Text:  content,
  },
 }
 query := url.Values{}
 query.Set("access_token", accessToken)
 hookUrl, _ := url.Parse(baseHookUrl)
 hookUrl.RawQuery = query.Encode()
 msgContent, _ := json.Marshal(msg)
 //创建一个请求
 req, err := http.NewRequest("POST", hookUrl.String(), bytes.NewReader(msgContent))
 if err != nil {
  // handle error
  fmt.Println(err)
 }
 client := &http.Client{}
 //设置请求头
 req.Header.Set("Content-Type", "application/json; charset=utf-8")
 //发送请求
 resp, err := client.Do(req)
 if err != nil {
  // handle error
  fmt.Println(err)
 }
 //关闭请求
 defer resp.Body.Close()
}

然后将其部署到对应的服务器上,在钉钉的测试群里进行对话测试,如下:

640.png

可以看到能正常的对答了,具体的返回内容根据业务逻辑进行开发。

注意:钉钉机器人需要增加具体的关键字,只有内容具有对应的关键字才会在群里收到消息。

相关文章
|
4月前
|
运维 监控 Linux
|
25天前
|
存储 测试技术 持续交付
团队配置管理规范:高效协作的秘诀与浅见
介绍软件配置管理规范的一些内容
47 2
|
2月前
|
存储 监控 安全
远程协作利器:项目管理软件助力团队高效合作
在后疫情时代,远程办公成为许多项目团队的选择。面对协作挑战,如设定目标、沟通和管理分布式团队,项目经理可借助项目管理软件提升效率。这类软件支持**项目规划**,如使用甘特图制定任务和依赖关系;实现**工时管理**,监控项目进度和预算;并促进**团队协作**,通过集成工具保持沟通和文档同步。例如,Feeds、Forums和Documents功能帮助保持团队同步和知识共享。
12 0
|
4月前
|
存储 云计算
生信工程师高效工作的背后——可观测性、资源适配与自动化
使用Memory Machine Cloud(简称MMCloud)的生信工程师们为什么工作效率比别人高呢?我们悄悄总结了MMCloud的三个核心优势——可观测性、资源适配与自动化。
160 0
|
6月前
|
人工智能 监控 数据可视化
适合团队合作的产品有哪些?10个可视化协作软件盘点!
10个好用的团队合作软件推荐,助力可视化在线协作!
|
12月前
|
Web App开发 监控 机器人
语雀质量体系与自动化
语雀质量体系与自动化
200 0
|
Web App开发 运维 前端开发
浅谈 2022 前端工作流中全流程多层次的四款测试工具
在应届生找工作的时候,我们经常会见到一条招聘要求:要求实习经历。或者 有实习经历者优先。 为什么大部分公司在招聘时,都要求你必须有实习经历?
浅谈 2022 前端工作流中全流程多层次的四款测试工具
|
存储 安全 测试技术
Lyft 微服务研发效能提升实践 | 4. 基于自动验收测试的部署门禁
Lyft 微服务研发效能提升实践 | 4. 基于自动验收测试的部署门禁
157 0
Lyft 微服务研发效能提升实践 | 4. 基于自动验收测试的部署门禁
|
运维 监控 JavaScript
什么是 ChatOps | 学习笔记
快速学习什么是 ChatOps
475 0
|
数据管理 程序员 测试技术
研发过程中的文档管理与工具
从工作的这几年实践经验来看,写文档原则上本着复杂的事项细写,简单的事项简写或者不写,卷可以但又不闲的慌;
328 0
研发过程中的文档管理与工具