📄️ Deployment modes
Peekaping runs in one of two modes. Both run the same code and have the same features. They differ in how the server's two parts, the API and the probe that runs the checks, are split into processes, and so in how far an install can scale.
📄️ Docker + PostgreSQL
Peekaping runs in one of two modes. See Deployment modes for what each one runs:
📄️ Docker + SQLite
For the stats storage upgrade, backups and optional disk-space reclamation, see Upgrading stats storage. If Peekaping stops at start because the SQLite quick check found corruption, see Recovering a corrupt SQLite database. Startup check shows how to choose the check Peekaping runs at start.
📄️ Kubernetes (Helm)
The Helm chart runs Peekaping in cluster mode. The API and the probe run as separate deployments. The API replicas share the database and talk to each other through Redis, and the probe pods connect to the API and run the checks. It needs a PostgreSQL database and a Redis.
📄️ Cluster user and permissions
The images of cluster mode run as a non-root user:
📄️ Remote probes
By default Peekaping checks every monitor from the machine it runs on. A remote probe lets a monitor be checked from another machine too, for example from another region, or from inside a network Peekaping can't reach.
📄️ Single-mode user and permissions
The single-mode image (0xfurai/peekaping) runs Peekaping as a non-root user, peekaping, with UID and GID 1000, whichever database it uses. The one process, peekaping, runs as that user. A startup script runs as root, sets up the user, runs the migrations and starts peekaping. With PostgreSQL, the database runs in a container of its own, the official postgres image, which this page doesn't change.
📄️ Upgrading to probes
This page takes a cluster on SQLite or PostgreSQL from the layout with a producer, a worker and an ingester to the layout with the API and probes. In the new layout, peekaping-probe instances check the local probe's monitors, and the API replicas store the results. See Deployment modes for the cluster, and Probe for what the probe does.
📄️ Upgrading to single mode
This page takes you from a SQLite or PostgreSQL bundle of release 0.0.44 to 0.0.47 to single mode. Those releases ran Peekaping's api, producer, worker and ingester processes, Redis and Caddy in one container, under supervisord. Single mode runs one process, peekaping, instead. See Deployment modes for the two modes.
📄️ Upgrading stats storage
The SQL stats upgrade separates minute, hour and day stats into three tables and rebuilds them from retained heartbeats. This fixes mixed time scales in response time charts and uptime percentages on SQLite and PostgreSQL.
📄️ Recovering a corrupt SQLite database
A SQLite database is corrupt when its file, peekaping.db, is damaged. Causes include disk and filesystem errors, a copy of the file taken while Peekaping was writing to it, and a crash or power loss on a disk or filesystem that doesn't honor fsync (the call that forces a write onto the disk).
📄️ Move off MongoDB storage
MongoDB storage was removed in this release. DBTYPE=mongo and DBTYPE=mongodb now stop every Peekaping binary with an error that points to this page, and no new peekaping-bundle-mongo image is published. 0.0.47 is the last release that ran on MongoDB. An install that keeps its data in MongoDB stays on 0.0.47 until it moves to SQLite or PostgreSQL with the bun db import-mongo of this release, as this guide describes, and only then starts this release. The MongoDB monitor type, which checks other MongoDB servers, is not affected.
📄️ Usage statistics and error reporting
Peekaping can send two kinds of anonymous data to the Peekaping project: