# Monlet

Monlet is a lightweight event and check monitoring system.

It is split into three independent applications:

- `agent/` - a small Go binary installed on monitored hosts.
- `server/` - a Python/FastAPI backend that owns inventory, state, incidents, and notifications.
- `web/` - a read-only Next.js dashboard.

The first project phase is documentation and planning bootstrap only. Core business logic is intentionally not implemented yet.

## MVP

Monlet v1 focuses on local checks, central state, and simple read-only visibility:

- agents run local checks from TOML config;
- agents expose Prometheus metrics and/or push facts to the server;
- server ingests heartbeats and check events idempotently;
- server owns current state, incident lifecycle, and notifier retries;
- web UI reads server APIs and does not mutate state.

## Non-goals for v1

- remote command execution;
- remote config push;
- full RBAC;
- multi-tenant enterprise model;
- complex silences or inhibition engine;
- Grafana replacement;
- long-term log storage;
- full incident management platform;
- Kubernetes operator;
- plugin marketplace;
- distributed server cluster.

## Repository Map

- `docs/` - architecture, ADRs, development, and operations docs.
- `plan/` - stage workflow and exit checkpoints.
- `api/` - versioned OpenAPI contract.
- `agent/` - Go agent placeholder and deployment notes.
- `server/` - Python backend placeholder.
- `web/` - Next.js frontend placeholder.
- `deploy/` - local and observability deployment examples.
- `examples/` - example checks and configs.

## Start Here

Read in this order:

1. `docs/README.md`
2. `docs/architecture/overview.md`
3. `ROADMAP.md`
4. `TODO.md`
5. `plan/README.md`
6. `AGENTS.md`
7. `CLAUDE.md`

## Current Status

Stage 0 is the only active stage: documentation bootstrap. Do not start agent, server, or web core logic until Stage 0 exits and the API contract is reviewed.