zuse

A flexible high-performance uptime bot powered by async Rust with Telegram, SNS and Slack notification backends.

$ cargo install zuse
$ zuse -c tests.yml

Example configuration (tests.yml)

notifiers:
  - type: telegram
    auth:
      token: xxxx
    channels:
      - name: tg_chan
        # channel or group or user
        id: -1000000000000
  - type: sns
    auth:
      key: AKIXXXXXXXXXXXXXXXXX
      secret: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
      region: us-east-1
    channels:
      - name: sns_pavel
        phone: +491701234567
        # or
        target_arn: arn:aws:sns:us-east-1:XXXXXXXXXXXX:XXXXXXXX
        # or
        topic_arn: arn:aws:sns:us-east-1:XXXXXXXXXXXX:XXXXXXXX
  - type: slack
    auth:
      hook_url: https://hooks.slack.com/services/XXXXX/XXXX/XXXXXXXX
    channels:
      - name: slack_alrt
        channel: '#alrt'
        username: 'zuse'
        icon_emoji: ':warning:'

# optional, a group of notify targets
notify_groups:
  - name: infra_team
    notify:
      - sns_pavel
      - tg_chan

# optional, can also be on each test
defaults:
  retries: 3
  recovery: 3
  interval: 10
  timeout: 30

tests:
  - type: http_ok
    name: site-com-alive-cdn
    target: https://site.com/endpoint
    notify:
      - sns_pavel
      - tg_chan
      - slack_alrt
    # or
    notify_groups:
      - infra_team
  - type: tcp_ok
    name: server-smoke-test
    target: 127.0.0.1:3000
    notify_groups:
      - infra_team
  - type: http_match
    name: server-smoke-test
    target: 127.0.0.1:3000
    expect:
      status: 200
      text: 'Google'
    notify_groups:
      - infra_team

Notes

cargo requires a rust installation.

License

~~ MIT License ~~

Copyright (c) 2020 Kenan Sulayman

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.