如何開發(fā)ChatOps


目的是什么
為啥要開發(fā)ChatOps,那是個啥玩意?

現(xiàn)在各種Ops,比如DevOps,AIOps,ChatOps,NoOps等等,反正其背后的意義就是各種卷運維,讓運維無路可走。

既然如此,為何咱還出力不討好的開發(fā)ChatOps呢?

我的理解是“閑的”,用聊天的形式來做一些運維工作。

典型的應(yīng)用場景如下: (1)、和 Jenkins、GitLab、GitHub 等 CI/CD 工具結(jié)合,執(zhí)行構(gòu)建、發(fā)布,代碼合并等。 (2)、和 JIRA、Trello、Tower、禪道、郵件等辦公系統(tǒng)結(jié)合起來,處理任務(wù)。 (3)、和 Kubernetes 云平臺結(jié)合起來,執(zhí)行容器的創(chuàng)建、發(fā)布等管理。 (4)、和 Zabbix、Prometheus、Open-Falcon 等監(jiān)控系統(tǒng)結(jié)合,接收監(jiān)控消息

ChatOps 站在巨人的肩膀上發(fā)展,也為工作帶來了顯而易見的好處:

公開透明。所有的工作消息都在同一個聊天平臺中沉淀并公開給所有相關(guān)成員,消除溝通壁壘,工作歷史有跡可循,團隊合作更加順暢。
上下文共享。減少因工作臺切換等對消息的截斷,保證消息的完整性,讓工作承接有序,各角色,各工具都成為完成工作流中的一環(huán),打造真正流暢的工作體驗。
移動友好。只需要在前臺與預(yù)設(shè)好的機器人對話即可完成與后臺工具、系統(tǒng)的交互,在移動環(huán)境下無需再與眾多復(fù)雜的工具直接對接,大大提升移動辦公的可行性。
DevOps 文化打造。用與機器人對話這種簡單的方式降低 DevOps 的接受門檻,讓這種自動化辦公的理念更容易的擴展到團隊的每一個角落。
本篇文章就簡單使用釘釘機器人來做ChatOps。

添加釘釘機器人
登錄釘釘開發(fā)者后臺,依次選擇應(yīng)用開發(fā) > 企業(yè)內(nèi)部開發(fā) > 機器人,點擊創(chuàng)建應(yīng)用。

然后記住AppKey和AppSecret,如下:

配置服務(wù)器出口IP和消息接收地址,如下:

注意:配置https地址需要對應(yīng)的有效證書。

開發(fā)機器人
HTTP HEADER

{
  "Content-Type": "application/json; charset=utf-8",
  "timestamp": "1577262236757",
  "sign":"xxxxxxxxxx"
}
參數(shù)    說明
timestamp    消息發(fā)送的時間戳,單位是毫秒。
sign    簽名值。
開發(fā)者需對header中的timestamp和sign進行驗證,以判斷是否是來自釘釘?shù)暮戏ㄕ埱?,避免其他仿冒釘釘調(diào)用開發(fā)者的HTTPS服務(wù)傳送數(shù)據(jù),具體驗證邏輯如下:

timestamp 與系統(tǒng)當(dāng)前時間戳如果相差1小時以上,則認為是非法的請求。
sign 與開發(fā)者自己計算的結(jié)果不一致,則認為是非法的請求。






必須當(dāng)timestamp和sign同時驗證通過,才能認為是來自釘釘?shù)暮戏ㄕ埱?。sign的計算方法: header中的timestamp + "\n" + 機器人的appSecret當(dāng)做簽名字符串,使用HmacSHA256算法計算簽名,然后進行Base64 encode,得到最終的簽名值。

使用Go開發(fā)的樣例如下:

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 參數(shù)
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里的請求參數(shù)
  //fmt.Println(c.Request.Header)
  httpSign := c.Request.Header.Get("Sign")
  httpTimestamp := c.Request.Header.Get("Timestamp")
  // timestamp 與系統(tǒng)當(dāng)前時間戳如果相差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 {
   // 獲取消息內(nèi)容
   var body incoming
   if err := json.Unmarshal(data, &body); err != nil {
    fmt.Println(err)
    return
   }

   // 獲取文本內(nèi)容
   content := body.Text.Content
   fmt.Println(content)

   // 根據(jù)內(nèi)容判斷做處理

   // 將處理結(jié)果返回給機器人
   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)
 //創(chuàng)建一個請求
 req, err := http.NewRequest("POST", hookUrl.String(), bytes.NewReader(msgContent))
 if err != nil {
  // handle error
  fmt.Println(err)
 }

 client := &http.Client{}
 //設(shè)置請求頭
 req.Header.Set("Content-Type", "application/json; charset=utf-8")
 //發(fā)送請求
 resp, err := client.Do(req)

 if err != nil {
  // handle error
  fmt.Println(err)
 }
 //關(guān)閉請求
 defer resp.Body.Close()
}

然后將其部署到對應(yīng)的服務(wù)器上,在釘釘?shù)臏y試群里進行對話測試,如下:

可以看到能正常的對答了,具體的返回內(nèi)容根據(jù)業(yè)務(wù)邏輯進行開發(fā)。

注意:釘釘機器人需要增加具體的關(guān)鍵字,只有內(nèi)容具有對應(yīng)的關(guān)鍵字才會在群里收到消息。

文檔
https://open.dingtalk.com/document/robots/enterprise-created-chatbot




作者:喬克


歡迎關(guān)注:運維開發(fā)故事