promoter

プロモーター

Promoter は、AlertManager アラーム通知用の Webhook 実装であり、現在钉钉と企业微信をサポートし、メッセージ通知でのリアルタイム アラーム チャートの表示をサポートしています。

インストール

プロジェクトは Go 言語で書かれており、Promoter をインストールするにはさまざまな方法があります。

バイナリをコンパイルする

プロジェクトを直接クローンし、手動でビルドします。

$ git clone https://github.com/cnych/promoter.git
$ cd promoter
$ go build -a -o promoter cmd/promoter/main.go
$ ./promoter --config.file= < your_file >

Dockerイメージ

プロモーター イメージが Docker Hub にアップロードされます。次のコマンドを使用してサービスを開始してみてください。

$ docker run --name promoter -d -p 8080:8080 cnych/promoter:main

構成

次の構成は基本的に、プロモーターによって使用される構成をカバーしています。

 global :
  prometheus_url : http://192.168.31.31:30104
  wechat_api_secret : <secret>
  wechat_api_corp_id : <secret>
  dingtalk_api_token : <secret>
  dingtalk_api_secret : <secret>

s3 :
  access_key : <secret>
  secret_key : <secret>
  endpoint : oss-cn-beijing.aliyuncs.com
  region : cn-beijing
  bucket : <bucket>

receivers :
  - name : rcv1
    wechat_configs :
      - agent_id : <agent_id>
        to_user : " @all "
        message_type : markdown
        message : ' {{ template "wechat.default.message" . }} '
    dingtalk_configs :
      - message_type : markdown
        markdown :
          title : ' {{ template "dingtalk.default.title" . }} '
          text : ' {{ template "dingtalk.default.content" . }} '
        at :
          atMobiles : [ "123456" ]
          isAtAll : false

グローバルでは、エンタープライズ WeChat キーや DingTalk キーなどのグローバル属性を構成できます。S3 には、監視アイコンによって生成された画像を保存するためのオブジェクト ストレージ (Alibaba Cloud OSS も使用可能) 構成があります。

以下のreceivers text 1 つのレシーバーで Enterprise WeChat と DingTalk を同時にmarkdownできます。たとえば、ここでのnameはrcv1です。受信側 Webhook アドレスはhttp://<promoter-url>/rcv1/send 、AlertManager Webhook で設定する必要があります。

Enterprise WeChat の Markdown 形式は画像の直接表示をサポートしていないことに注意してください。

テンプレート

デフォルトのテンプレートはtemplate/default.tmplにあり、必要に応じてカスタマイズできます。

 {{ define "__subject" }}[{{ .Status | toUpper }}{{ if eq .Status "firing" }}:{{ .Alerts.Firing | len }}{{ end }}] {{ .GroupLabels.SortedPairs.Values | join " " }} {{ if gt (len .CommonLabels) (len .GroupLabels) }}({{ with .CommonLabels.Remove .GroupLabels.Names }}{{ .Values | join " " }}{{ end }}){{ end }}{{ end }}

{{ define "default.__text_alert_list" }}{{ range . }}
**{{ .Annotations.summary }}**

{{ range .Images }}
![click there get alert image]({{ .Url }})
{{- end }}

**description:**
> {{ .Annotations.description }}

**labels:**
{{ range .Labels.SortedPairs }}{{ if and (ne (.Name) "severity") (ne (.Name) "summary") }}> - {{ .Name }}: {{ .Value | markdown | html }}
{{ end }}{{ end }}
{{ end }}{{ end }}

{{ define "dingtalk.default.title" }}{{ template "__subject" . }}{{ end }}
{{ define "dingtalk.default.content" }}
{{ if gt (len .Alerts.Firing) 0 -}}
### {{ .Alerts.Firing | len }} Alerts Firing:
{{ template "default.__text_alert_list" .Alerts.Firing }}
{{ range .AtMobiles }}@{{ . }}{{ end }}
{{- end }}
{{ if gt (len .Alerts.Resolved) 0 -}}
### **{{ .Alerts.Resolved | len }} Alerts Resolved:**
{{ template "default.__text_alert_list" .Alerts.Resolved }}
{{ range .AtMobiles }}@{{ . }}{{ end }}
{{- end }}
{{- end }}

{{ define "wechat.default.message" }}
{{ if gt (len .Alerts.Firing) 0 -}}
### {{ .Alerts.Firing | len }} Alerts Firing:
> {{ template "default.__text_alert_list" .Alerts.Firing }}
{{- end }}
{{ if gt (len .Alerts.Resolved) 0 -}}
### **{{ .Alerts.Resolved | len }} Alerts Resolved:**
{{ template "default.__text_alert_list" .Alerts.Resolved }}
{{- end }}
{{- end }}
{{ define "wechat.default.to_user" }}{{ end }}
{{ define "wechat.default.to_party" }}{{ end }}
{{ define "wechat.default.to_tag" }}{{ end }}
{{ define "wechat.default.agent_id" }}{{ end }}