一篇文章教你如何开发ChatOps

乔克 2023-03-28 原文

目的是什么

为啥要开发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。

添加钉钉机器人

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

然后记住AppKey和AppSecret，如下：

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

注意：配置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开发的样例如下：

main
 (
 "bytes"
 "crypto/hmac"
 "crypto/sha256"
 "encoding/base64"
 "encoding/json"
 "fmt"
 "io/ioutil"
 "net/http"
 "net/url"
 "strconv"
 "github.com/gin-gonic/gin"
)
 (
 appSecret   = "xxx-xxx"
 baseHookUrl = "https://oapi.dingtalk.com/robot/send"
 accessToken = "xxx"
)
// Body请求体
 incoming  {
 MsgType                         `json:"msgtype"`
 Text              *Text               `json:"text"`
 MsgId                           `json:"msgId"`
 CreateAt                         `json:"createAt"`
 ConversationType                `json:"conversationType"` // 1-单聊、2-群聊
 ConversationId                  `json:"conversationId"`   // // 加密的会话ID
 ConversationTitle               `json:"conversationId"`   // 会话标题（群聊时才有）
 SenderId                        `json:"senderId"`
 SenderNick                      `json:"senderNick"`
 SenderCorpId                    `json:"senderCorpId"`
 SenderStaffId                   `json:"senderStaffId"`
 ChatbotUserId                   `json:"chatbotUserId"`
 AtUsers           [][] `json:"atUsers"`

 SessionWebhook  `json:"sessionWebhook"`
 IsAdmin           `json:"isAdmin"`
}
// Message 钉钉消息
 Message  {
 MsgType  `json:"msgtype"`
 At      At     `json:"at,omitempty"`

 Text     *Text     `json:"text,omitempty"`
 Markdown *Markdown `json:"markdown,omitempty"`
 Link     *Link     `json:"link,omitempty"`
}
// At  定义需要at的用户
 At  {
 AtMobiles [] `json:"atMobiles,omitempty"`
 IsAtAll        `json:"isAtAll,omitempty"`
}
// MarkDown 类型
 Markdown  {
 Title  `json:"title,omitempty"`
 Text   `json:"text,omitempty"`
}
// Text text类型
 Text  {
 Content  `json:"content,omitempty"`
}
// Link feedCard类型 links 参数
 Link  {
 Title       `json:"title,omitempty"`
 Text        `json:"text,omitempty"`
 MessageURL  `json:"messageURL,omitempty"`
 PicURL      `json:"picURL,omitempty"`
}
 () {
 r := gin.New()
 r.POST("/chatops", (c *gin.Context) {
  // 定义两个变量，其中data是获取request的body，sign是加签
   (
   sign 
   data []
  )
  // 获取body里的请求参数
  //fmt.Println(c.Request.Header)
  httpSign := c.Request.Header.Get("Sign")
  httpTimestamp := c.Request.Header.Get("Timestamp")
  // timestamp 与系统当前时间戳如果相差1小时以上，则认为是非法的请求。
   tsi, err := strconv.ParseInt(httpTimestamp, 10, 64); err !=  {
   fmt.Println("请求头可能未附加时间戳信息!!")
  }  {
   data, _ = ioutil.ReadAll(c.Request.Body)
   sign = signature(tsi, appSecret)
  }
  // 校验通过
   httpSign == sign {
   // 获取消息内容
    body incoming
    err := json.Unmarshal(data, &body); err !=  {
    fmt.Println(err)
    
   }
   // 获取文本内容
   content := body.Text.Content
   fmt.Println(content)

   // 根据内容判断做处理

   // 将处理结果返回给机器人
   sendDingTalk("主人," + content)
  }
 })
 r.Run(":9000")
}
 (ts , secret )  {
 strToSign := fmt.Sprintf("%d\n%s", ts, secret)
 hmac256 := hmac.New(sha256.New, [](secret))
 hmac256.Write([](strToSign))
 data := hmac256.Sum()
  base64.StdEncoding.EncodeToString(data)
}
 (content ) {
 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))
  err !=  {
  // handle error
  fmt.Println(err)
 }

 client := &http.Client{}
 //设置请求头
 req.Header.Set("Content-Type", "application/json; charset=utf-8")
 //发送请求
 resp, err := client.Do(req)

  err !=  {
  // handle error
  fmt.Println(err)
 }
 //关闭请求
  resp.Body.Close()
}

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

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

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

有关一篇文章教你如何开发ChatOps的更多相关文章

ruby - 如何使用 Nokogiri 的 xpath 和 at_xpath 方法 - 2
我正在学习如何使用Nokogiri，根据这段代码我遇到了一些问题:require'rubygems'require'mechanize'post_agent=WWW::Mechanize.newpost_page=post_agent.get('http://www.vbulletin.org/forum/showthread.php?t=230708')puts"\nabsolutepathwithtbodygivesnil"putspost_page.parser.xpath('/html/body/div/div/div/div/div/table/tbody/tr/td/div
ruby - 如何从 ruby 中的字符串运行任意对象方法？ - 2
总的来说，我对ruby还比较陌生，我正在为我正在创建的对象编写一些rspec测试用例。许多测试用例都非常基础，我只是想确保正确填充和返回值。我想知道是否有办法使用循环结构来执行此操作。不必为我要测试的每个方法都设置一个assertEquals。例如:describeitem,"TestingtheItem"doit"willhaveanullvaluetostart"doitem=Item.new#HereIcoulddotheitem.name.shouldbe_nil#thenIcoulddoitem.category.shouldbe_nilendend但我想要一些方法来使用
python - 如何使用 Ruby 或 Python 创建一系列高音调和低音调的蜂鸣声？ - 2
关闭。这个问题是opinion-based.它目前不接受答案。想要改进这个问题？更新问题，以便editingthispost可以用事实和引用来回答它.关闭4年前。Improvethisquestion我想在固定时间创建一系列低音和高音调的哔哔声。例如:在150毫秒时发出高音调的蜂鸣声在151毫秒时发出低音调的蜂鸣声200毫秒时发出低音调的蜂鸣声250毫秒的高音调蜂鸣声有没有办法在Ruby或Python中做到这一点？我真的不在乎输出编码是什么(.wav、.mp3、.ogg等等)，但我确实想创建一个输出文件。
ruby-on-rails - 如何验证 update_all 是否实际在 Rails 中更新 - 2
给定这段代码defcreate@upgrades=User.update_all(["role=?","upgraded"],:id=>params[:upgrade])redirect_toadmin_upgrades_path,:notice=>"Successfullyupgradeduser."end我如何在该操作中实际验证它们是否已保存或未重定向到适当的页面和消息？最佳答案在Rails3中，update_all不返回任何有意义的信息，除了已更新的记录数(这可能取决于您的DBMS是否返回该信息)。http://ar.ru
ruby-on-rails - 'compass watch' 是如何工作的/它是如何与 rails 一起使用的 - 2
我在我的项目目录中完成了compasscreate.和compassinitrails。几个问题:我已将我的.sass文件放在public/stylesheets中。这是放置它们的正确位置吗？当我运行compasswatch时，它不会自动编译这些.sass文件。我必须手动指定文件:compasswatchpublic/stylesheets/myfile.sass等。如何让它自动运行？文件ie.css、print.css和screen.css已放在stylesheets/compiled。如何在编译后不让它们重新出现的情况下删除它们？我自己编译的.sass文件编译成compiled/t
ruby - 如何将脚本文件的末尾读取为数据文件(Perl 或任何其他语言) - 2
我正在寻找执行以下操作的正确语法(在Perl、Shell或Ruby中):#variabletoaccessthedatalinesappendedasafileEND_OF_SCRIPT_MARKERrawdatastartshereanditcontinues. 最佳答案 Perl用__DATA__做这个:#!/usr/bin/perlusestrict;usewarnings;while(){print;}__DATA__Texttoprintgoeshere 关于ruby-如何将脚
ruby - 如何指定 Rack 处理程序 - 2
Rackup通过Rack的默认处理程序成功运行任何Rack应用程序。例如:classRackAppdefcall(environment)['200',{'Content-Type'=>'text/html'},["Helloworld"]]endendrunRackApp.new但是当最后一行更改为使用Rack的内置CGI处理程序时，rackup给出“NoMethodErrorat/undefinedmethod`call'fornil:NilClass”:Rack::Handler::CGI.runRackApp.newRack的其他内置处理程序也提出了同样的反对意见。例如Rack
ruby - 如何每月在 Heroku 运行一次 Scheduler 插件？ - 2
在选择我想要运行操作的频率时，唯一的选项是“每天”、“每小时”和“每10分钟”。谢谢!我想为我的Rails3.1应用程序运行调度程序。最佳答案这不是一个优雅的解决方案，但您可以安排它每天运行，并在实际开始工作之前检查日期是否为当月的第一天。关于ruby-如何每月在Heroku运行一次Scheduler插件？，我们在StackOverflow上找到一个类似的问题： https://stackoverflow.com/questions/8692687/
ruby-on-rails - 如何从 format.xml 中删除 <hash></hash> - 2
我有一个对象has_many应呈现为xml的子对象。这不是问题。我的问题是我创建了一个Hash包含此数据，就像解析器需要它一样。但是rails自动将整个文件包含在.........我需要摆脱type="array"和我该如何处理？我没有在文档中找到任何内容。最佳答案我遇到了同样的问题；这是我的XML:我在用这个:entries.to_xml将散列数据转换为XML，但这会将条目的数据包装到中所以我修改了:entries.to_xml(root:"Contacts")但这仍然将转换后的XML包装在“联系人”中，将我的XML代码修改为
ruby - 如何使用文字标量样式在 YAML 中转储字符串？ - 2
我有一大串格式化数据(例如JSON)，我想使用Psychinruby同时保留格式转储到YAML。基本上，我希望JSON使用literalstyle出现在YAML中:---json:|{"page":1,"results":["item","another"],"total_pages":0}但是，当我使用YAML.dump时，它不使用文字样式。我得到这样的东西:---json:!"{\n\"page\":1,\n\"results\":[\n\"item\",\"another\"\n],\n\"total_pages\":0\n}\n"我如何告诉Psych以想要的样式转储标量？解