https://github.com/allanchain/grafana-feishu

Lightweight server to translate Grafana webhook to Feishu card.
https://github.com/allanchain/grafana-feishu

feishu grafana webhook

Last synced: about 23 hours ago
JSON representation

Lightweight server to translate Grafana webhook to Feishu card.

• Host: GitHub
• URL: https://github.com/allanchain/grafana-feishu
• Owner: AllanChain
• License: unlicense
• Created: 2023-05-02T05:07:53.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-05-15T08:59:41.000Z (6 months ago)
• Last Synced: 2024-05-15T23:48:33.325Z (6 months ago)
• Topics: feishu, grafana, webhook
• Language: Go
• Homepage:
• Size: 20.5 KB
• Stars: 1
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Grafana-Feishu

Lightweight server to translate Grafana webhook to Feishu card.

## Usage

The program needs two environment variables:

- `FEISHU_WEBHOOK`: (Optional) The web hook URL to push Feishu notifications. Should be something like `https://open.feishu.cn/open-apis/bot/v2/hook/a21843-123-123-abc987`

- `FEISHU_WEBHOOK_BASE`: (Optional, has no effect if `FEISHU_WEBHOOK` is set) Something like `https://open.feishu.cn/open-apis/bot/v2/hook` (default).

- `FEISHU_WEBHOOK_UUID`: (Optional, has no effect if `FEISHU_WEBHOOK` is set) The bot UUID, something like `a21843-123-123-abc987`.

If the bot UUID is not specified, it should be provided in the path. See below for detail.

- `WEBHOOK_AUTH`: (Optional) The username and password. Should be something like `user:password`

Here is an example docker compose file:

```yaml

version: 3

services:

  grafana:

    # ...

  grafana-feishu:

    image: allanchain/grafana-feishu

    container_name: grafana-feishu

    restart: always

    environment:

      - WEBHOOK_AUTH=${WEBHOOK_AUTH}

      - FEISHU_WEBHOOK=${FEISHU_WEBHOOK}

      # Or, instead of FEISHU_WEBHOOK:

      # - FEISHU_WEBHOOK_BASE=${FEISHU_WEBHOOK_BASE}

      # - FEISHU_WEBHOOK_UUID=${FEISHU_WEBHOOK_UUID}

```

The exposed port is `2387`.

After setting up the server, go to Grafana > "Alerting" > "Contact points", add a new contact point with integration as "Webhook". Fill in the URL and credentials. 

If the bot UUID is provided in `FEISHU_WEBHOOK` or `FEISHU_WEBHOOK_UUID` is set, the URL should be `http://grafana-feishu:2387`. Otherwise, the URL should be `http://grafana-feishu:2387/{botUUID}`, where `{botUUID}` is the UUID of the bot you created in Feishu, i.e. the last part of the bot webhook URL.



By default, the color of the card reflects the alert status, and the card title will be the `"summary"` annotation, and the content will be the `"description"` annotation. You can customize the summary and description in alert rules using Go templates. An example:

```

{{ if $values.B }}{{ if eq $values.C.Value 0.0 }}Resolve {{ end }}alert{{ else }}No data{{ end }}

```