Installation

Install the CLI

Linux (amd64)

wget  https://github.com/flanksource/canary-checker/releases/latest/download/canary-checker_linux_amd64   \
  -O /usr/bin/canary-checker && \
  chmod +x /usr/bin/canary-checker

Linux (arm64)

wget  https://github.com/flanksource/canary-checker/releases/latest/download/canary-checker_linux_arm64  \
  -O /usr/bin/canary-checker && \
  chmod +x /usr/bin/canary-checker

MacOSX (amd64)

wget https://github.com/flanksource/canary-checker/releases/latest/download/canary-checker_darwin_amd64  \
  -O /usr/local/bin/canary-checker && \
  chmod +x /usr/local/bin/canary-checker

MacOSX (arm64)

wget https://github.com/flanksource/canary-checker/releases/latest/download/canary-checker_darwin_arm64  \
  -O /usr/local/bin/canary-checker && \
  chmod +x /usr/local/bin/canary-checker

Makefile

OS = $(shell uname -s | tr '[:upper:]' '[:lower:]')
ARCH = $(shell uname -m | sed 's/x86_64/amd64/')
wget -nv -nc https://github.com/flanksource/canary-checker/releases/latest/download/canary-checker_$(OS)_$(ARCH)  \\
  -O /usr/local/bin/canary-checker && \\
  chmod +x /usr/local/bin/canary-checker

Windows

wget -nv -nc -O https://github.com/flanksource/canary-checker/releases/latest/download/canary-checker.exe

Create a canary definition

canary.yaml
apiVersion: canaries.flanksource.com/v1
kind: Canary
metadata:
  name: http-check
spec:
  interval: 30
  http:
    - name: basic-check
      url: https://httpbin.demo.aws.flanksource.com/status/200
    - name: failing-check
      url: https://httpbin.demo.aws.flanksource.com/status/500

Run the check locally

canary-checker run canary.yaml