sachet

KO | EN

gitlite — search

#javascript #python #hacktoberfest #typescript #android #rust #deep-learning #linux #macos #awesome #awesome-list #security #ios #open-source

(★ 213)

SMS alerts for Prometheus' Alertmanager

File Explorer

Download Latest Version (.zip)

- - go.yml
  - golangci-lint.yml
- - config.go
  - handlers.go
  - handlers_test.go
  - main.go
  - main_test.go
  - telemetry.go
- config.yaml
- telegram.tmpl
- - aliyun.go
- - aspsms.go
- - cm.go
- - esendex.go
- - exotel.go
- - freemobile.go
- - ghasedak.go
- - infobip.go
- - kannel.go
- - kavenegar.go
- - mailruim.go
- - mediaburst.go
- - melipayamak.go
- - messagebird.go
  - README.md
- - nexmo.go
- - nowsms.go
- - otc.go
- - ovh.go
- - pushbullet.go
  - README.md
- - sap.go
- - sfr.go
- - README.md
  - sipgate.go
- - sms77.go
- - smsc.go
- - telegram.go
- - tencentcloud.go
- - README.md
  - textmagic.go
- - turbosms.go
- - twilio.go
- modules.txt
.gitignore
.golangci.yml
.travis.yml
build_push_image.sh
Dockerfile
go.mod
go.sum
LICENSE
README.md
release.sh
sachet.go

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Sachet

Sachet (or सचेत) is Hindi for conscious. Sachet is an SMS alerting tool for the [Prometheus Alertmanager](https://github.com/prometheus/alertmanager).

## The problem
There are many SMS providers and Alertmanager supporting all of them would make the code noisy. To get around this issue a new service needed to be created dedicated only for SMS.

## The solution
An HTTP API that accepts Alertmanager webhook calls and allows an end-user to configure it for the SMS provider of their dreams.

## Usage

First get it

```
$ go get github.com/messagebird/sachet/cmd/sachet
```

And then running Sachet is as easy as executing `sachet` on the command line.

```
$ sachet
```

Use the `-h` flag to get help information.

```
$ sachet -h
Usage of sachet:
  -config string
        The configuration file (default "config.yaml")
  -listen-address string
        The address to listen on for HTTP requests. (default ":9876")
```

## Testing

Sachet expects a JSON object from Alertmanager. The format of this JSON is described in [the Alertmanager documentation](https://prometheus.io/docs/alerting/configuration/#webhook-receiver-<webhook_config>), or, alternatively, in [the Alertmanager GoDoc](https://godoc.org/github.com/prometheus/alertmanager/template#Data).

To quickly test Sachet is working you can also run:
```bash
$ curl -H "Content-type: application/json" -X POST \
  -d '{"receiver": "team-sms", "status": "firing", "alerts": [{"status": "firing", "labels": {"alertname": "test-123"} }], "commonLabels": {"key": "value"}}' \
  http://localhost:9876/alert
```

## Alertmanager configuration

To enable Sachet you need to configure a webhook in Alertmanager. You can do that by adding a webhook receiver to your Alertmanager configuration.

```yaml
receivers:
- name: 'team-sms'
  webhook_configs:
  - url: 'http://localhost:9876/alert'
```

## Message templating

Sachet supports Alertmanager-like templates for message content. You can do that by simply copying Alertmanager templates to Sachet. Some templates examples can be found in [the Alertmanager documentation](https://prometheus.io/docs/alerting/notification_examples/) as well as [available variables](https://prometheus.io/docs/alerting/notifications/).

sachet.yml:
```yaml
templates:
- /etc/sachet/notifications.tmpl

receivers:
- name: 'team-telegram'
  provider: telegram
  text: '{{ template "telegram_message" . }}'
```
notifications.tmpl:
```
{{ define "telegram_title" }}[{{ .Status | toUpper }}{{ if eq .Status "firing" }}:{{ .Alerts.Firing | len }}{{ end }}] {{ .CommonLabels.alertname }} @ {{ .CommonLabels.identifier }} {{ end }}

{{ define "telegram_message" }}
{{ if gt (len .Alerts.Firing) 0 }}
*Alerts Firing:*
{{ range .Alerts.Firing }}• {{ .Labels.instance }}: {{ .Annotations.description }}
{{ end }}{{ end }}
{{ if gt (len .Alerts.Resolved) 0 }}
*Alerts Resolved:*
{{ range .Alerts.Resolved }}• {{ .Labels.instance }}: {{ .Annotations.description }}
{{ end }}{{ end }}{{ end }}

{{ define "telegram_text" }}{{ template "telegram_title" .}}
{{ template "telegram_message" . }}{{ end }}
```

## License

sachet

File Explorer

Today's picks

Was this content helpful?

Recent Feedback

sachet

File Explorer

Today's picks

Was this content helpful?

Recent Feedback

Download README