Documentation
The Pinggy knowledge base is published here, server-rendered and readable without an account, and describes Pinggy p10.0.0-era. It covers every monitor type this build evaluates, the state and consensus vocabulary, deployment, day-to-day operation, security, and the HTTP API.
Monitor types
- HTTP monitors
Checking a URL over HTTP or HTTPS, including the keyword and content assertion.
- ICMP monitors
Checking that a host answers an ICMP echo request.
- TCP monitors
Checking that a TCP port accepts a connection.
- TLS monitors
Checking a TLS handshake and the remaining lifetime of the certificate it presents.
Concepts
Deploy
- Installing Pinggy
Running the control plane and its PostgreSQL store, and applying schema migrations.
- Enrolling nodes
Enrolling a node, how the control plane places monitors on it, and node health.
Operate
- Incidents
How a confirmed state change opens and recovers an incident.
- Notification channels
Delivering a confirmed incident to a notification channel, and delivery retries.
- Maintenance
Announcing a maintenance window so it is recorded rather than paged.
- Status pages
Publishing a status page covering the components an operator chooses.
- Draining and retiring nodes
Draining or retiring several nodes in one operation without losing quorum.
- Cloud provisioning
Creating monitoring nodes in OpenStack, how a new node is admitted, and when Pinggy may delete what it created.
Security
- Security considerations
What a Pinggy installation stores, publishes, and never publishes.
API
- The HTTP API
The versioned automation API, its envelope, and the OpenAPI document.
Troubleshooting
- Common issues
Reading UNKNOWN, under-replication, and a monitor that never leaves PENDING.
Also published
About this documentation
Every article is part of this repository and is served by the same binary, so what you read here is the documentation for the version you are running.