天天看點
傳回

如何開發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。

添加釘釘機器人

登入釘釘開發者背景，依次選擇應用開發 > 企業内部開發 > 機器人，點選建立應用。

如何開發ChatOps
如何開發ChatOps

然後記住AppKey和AppSecret，如下：

如何開發ChatOps

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

如何開發ChatOps
如何開發ChatOps
注意：配置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()
}

然後将其部署到對應的伺服器上，在釘釘的測試群裡進行對話測試，如下：

如何開發ChatOps

可以看到能正常的對答了，具體的傳回内容根據業務邏輯進行開發。

注意：釘釘機器人需要增加具體的關鍵字，隻有内容具有對應的關鍵字才會在群裡收到消息。

文檔

  • ​​https://open.dingtalk.com/document/robots/enterprise-created-chatbot​​

最後，求關注。如果你還想看更多優質原創文章，歡迎關注我們的公衆号「運維開發故事」。

運維 開發者
上一篇: 監控SAP郵件進出站并分析錯誤
下一篇: SAP産品介紹

繼續閱讀