kee

Kee

Keep an Eye on Everything

Documentation

About

Kee is a CLI tool that helps operate backend systems and investigate issues. You customise it to your infrastructure, and it reports on the health of its components, across layers and providers.

Unlike centralised monitoring platforms, it is designed to run locally on your computer. While it doesn't replace monitoring and alerting services, it gives you the opportunity to aggregate all of them into one single convenient view. Kee supports a range of systems, providers and services through probe providers.

Kee is for DevOps and SREs who love TUIs configured with plaintext files. It is heavily inspired by k9s and Terraform.

If you're curious, you can read more about how this project started.

Setup

1. Install Go >= 1.24, and make sure to set your $PATH to include $GOPATH/bin
2. Run go install gitlab.com/mwwaa/kee@v1.4.0
3. Create and edit the following file: $HOME/.config/kee/config.hcl. See below for a configuration example.
4. Run kee

Configuration example

This is a quickstart configuration example. Customise to your own use and taste.

probe "http" "m.w.fr" {
  interval      = "30s"
  url           = "https://maxime.walzberg.fr/"
  search_string = "Maxime Walzberg"
}

probe "statuspage_status" "CloudFlare" {
  interval      = "30s"
  base_url      = "https://www.cloudflarestatus.com"
  curious = true
}

probe "dns" "w.fr.mx" {
  interval    = "30s"
  nameserver  = "beau.ns.cloudflare.com:53"
  name        = "walzberg.fr."
  record_type = "A"
  expected_values = [
    "172.67.160.104",
    "104.21.65.86",
  ]
  expect_all_values = true
}

probe "ping" "1111" {
  address  = "1.1.1.1"
  interval = "30s"
}

# This will only work if you have a "Minikube" running
probe "k8s_service" "Minikube" {
  interval = "10s"
  context  = "minikube"
  # Choose namespaces relevant to you
  namespaces = ["cats"]
}

# This will only work if you have AWS configuration and credentials setup, and have CloudWatch alarms configured
probe "aws_cloudwatch" "CloudWatch" {
  interval = "1m"
}

Configuration reference

The exhaustive configuration reference is available here.