Docs
Operations

Health and preflight

Check that 3AM is up, that its host is fit, and that it can reach every tool.

Is it up?

GET /health answers {"status": "ok"} without signing in. Use it from your load balancer or monitoring:

curl -s http://127.0.0.1:8700/health

The container's own health check runs 3am-core health, which needs no curl.

GET /v1/status (also without signing in) says which mode 3AM is in: setup (no valid licence yet) or operating, and why.

Preflight

3am-core preflight            # host, licence, disk, accelerator, and a TCP connect to every configured tool
3am-core preflight --deep     # also asks each connector for its health (credentials, permissions)
3am-core preflight --json     # for automation

Each line is ok, warn or fail, and the command exits non-zero on any fail. Run it after install, after every upgrade, and whenever a tool changes its address or credentials.

Connectors

3am-core connectors list      # every connector kind in this build, and its capabilities
3am-core connectors check     # health of each configured connector

The console's Connectors page shows the same, with the last problem each connector reported.

Monitoring 3AM itself

WatchHow
The serviceGET /health every minute; alert after three failures
DiskThe data volume (/var/lib/3am): the audit log grows with incidents. Alert at 80%
The licenceGET /v1/status: licence.expires_at, and licence.in_grace once it has expired
The audit logledger-verify weekly (Logs and the audit log)

On this page