msergg / canary-checker Goto Github PK

Kubernetes operator for executing synthetic tests

Canary checker is a kubernetes-native platform for monitoring health across application and infrastructure using both passive and active (synthetic) mechanisms.

• Batteries Included - 35+ built-in check types
• Kubernetes Native - Health checks (or canaries) are CRD's that reflect health via the status field, making them compatible with GitOps, Flux Health Checks, Argo, Helm, etc..
• Secret Management - Leverage K8S secrets and configmaps for authentication and connection details
• Prometheus - Prometheus compatible metrics are exposed at /metrics. A Grafana Dashboard is also available.
• Dependency Free - Runs an embedded postgres instance by default, can also be configured to use an external database.
• JUnit Export (CI/CD) - Export health check results to JUnit format for integration into CI/CD pipelines
• JUnit Import (k6/newman/puppeter/etc) - Use any container that creates JUnit test results
• Scriptable - Go templates, Javascript and Expr can be used to:
  • Evaluate whether a check is passing and severity to use when failing
  • Extract a user friendly error message
  • Transform and filter check responses into individual check results
• Multi-Modal - While designed as a Kubernetes Operator, canary checker can also run as a CLI and a server without K8s

1. Install canary checker:

helm repo add flanksource https://flanksource.github.io/charts
helm repo update
helm install canary-checker

2. Create a new check:

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

2a. Run the check locally (Optional)

canary-checker run canary.yaml

kubectl apply -f canary.yaml

3. Check the status of the health check:

kubectl get canary

NAME               INTERVAL   STATUS   LAST CHECK   UPTIME 1H        LATENCY 1H   LAST TRANSITIONED
http-check.        30         Passed   13s          18/18 (100.0%)   480ms        13s

If you have any questions about canary checker:

• Read the docs
• Invite yourself to the CNCF community slackand join the #canary-checker channel.
• Check out the Youtube Playlist.
• File an issue - (We do provide user support via Github Issues, so don't worry if your issue a real bug or not)

Your feedback is always welcome!

Canary Checker core (the code in this repository) is licensed under Apache 2.0 and accepts contributions via GitHub pull requests after signing a CLA.

The UI (Dashboard) is free to use with canary checker under a license exception of Flanksource UI