Skip to main content

Getting started

When something breaks in your Kubernetes cluster, kwatch tells you what broke, why, and what to do, in Slack, Discord, email and 50+ other channels.

kwatch runs inside your cluster, traces every failure back to what started it, and sends one message: what broke, why, who changed it, and what to do next.

๐Ÿงญ New to Kubernetes?โ€‹

Kubernetes (often called K8s) runs your applications in containers. It keeps them running, moves them between machines, and starts new ones when needed. That also means many moving parts: a container can run out of memory, a rollout can get stuck, or a service can lose its healthy backends.

If a word below is unfamiliar, the glossary explains it in one line: cluster, node, pod, namespace, CrashLoopBackOff, OOMKilled, RBAC, Helm and CRD.

โœจ Why kwatchโ€‹

BenefitWhat it means
Root cause firstkwatch follows a failure upstream and names the one cause.
Quiet by defaultOne message, then silence until something new is true.
Who changed whatSee who changed what, and when.
The next stepEvery message ends with the command to run.
50+ channelsSlack, Teams, PagerDuty, email, webhooks and more.
Your data stays in your clusterOne pod. No kwatch cloud.

โš™๏ธ How it works in 30 secondsโ€‹

  1. Install. Run one command. It asks a few questions.
  2. It watches. kwatch runs as one small pod in your cluster and keeps a live map of what depends on what.
  3. You hear. When something breaks you get one clear message: what broke, why, and what to do.

๐ŸŽฏ What an alert looks likeโ€‹

Instead of only seeing CrashLoopBackOff, you get a message like:

๐Ÿšจ OOMKilled โ€” production / orders-api
Pod: orders-api-7ffc9d4f9-x9p4t
Node: worker-3 ยท severity: high

๐Ÿ’ก Cause: the container exceeded its 512Mi memory limit.
โžก๏ธ Next step: increase limits.memory or reduce memory usage.

๐Ÿ“„ Recent logs and Kubernetes events are included.

๐Ÿ”Ž What does kwatch catch?โ€‹

Community covers the failures that page you most. Pro, marked below, adds the rest.

SignalWhat kwatch explainsEdition
Pod crashes and OOM killsCrash reason, restarts, root-cause headline and a next stepCommunity
Pending podsWhy the scheduler cannot place a podCommunity
NodesNotReady nodesCommunity
Node pressure, draining and usageDisk or memory pressure and drainingPro
Rollouts, readinessStuck rollouts and unavailable replicasPro
Jobs and CronJobs, HPAs, PDBsFailed, suspended or missed work, stuck autoscalers, blocked disruptionPro
StorageClaim, volume and attachment failures, volumes nearly fullPro
Services, Ingress, network policyMissing or unhealthy backendsPro
Certificates, admission, quotaExpiring certificates, webhook failures, exhausted quotaPro
Control planeAPI server, etcd, DNS, scheduler and controller-managerPro

Pro also adds full root-cause proof, who changed what, impact, log excerpts, routing and threads. Active probes and the heartbeat monitor are opt-in. See Community vs Pro, the configuration guide, or the complete configuration reference. Pair kwatch with Prometheus, Grafana, or Loki for long-term metrics and logs.

๐Ÿš€ Installโ€‹

One command, and it walks you through it.

1. Check your toolsโ€‹

You need Bash, kubectl, curl, and cluster install permissions. Confirm that kubectl can reach your cluster:

kubectl cluster-info

2. Run the installerโ€‹

/bin/bash -c "$(curl -fsSL https://kwatch.dev/kwatch.sh)"

The installer asks where alerts should go, stores credentials safely in a Secret, installs kwatch, and verifies the installation.

3. Check the resultโ€‹

kubectl get pods -n kwatch

You should see one kwatch pod with STATUS Running and READY 1/1. kwatch runs as a single replica with its state on a small volume. If the pod or its node fails, Kubernetes restarts it. Running more than one replica for high availability is a Pro feature.

4. Optional: add Proโ€‹

Pro is free during early access. Get a key, then run the same command again and choose License / Pro, then Add or replace key. See License.

Already use Helm? See Installation.

๐Ÿ”’ Your data stays in your clusterโ€‹

kwatch is one pod with no kwatch cloud. It sends alerts only to the channels you configure, and redacts secrets from logs and messages.

What nextโ€‹

You can run the installer again later to configure, upgrade, check, or uninstall kwatch.