Documentation
Everything about Pulsimo
Install it, point it at your services, and learn how checks, metrics, logs, incidents and alerts work together. Every page follows the product as it ships today.
Install
Run Pulsimo on your server with Docker Compose.
Quick start
First endpoint, alert channel and metrics in ten minutes.
Architecture
The services, the data stores, and how an alert is born.
Browse by topic
Get started
- InstallationRun Pulsimo on your own server with Docker Compose, from published images or from source.
- Quick startFrom an empty install to your first endpoint, alert channel and metric source in about ten minutes.
- Your first projectGroup endpoints into a project, set a reliability target and see it on the status board.
- ArchitectureThe services that make up Pulsimo, where data lives and how a check becomes an alert.
- ConfigurationEvery .env value: what it controls, which service reads it, defaults, ranges and recipes.
Services and checks
- Projects and overviewThe live status board, project reliability against targets and error budgets, and project analytics.
- Endpoints and checksWhat Pulsimo can check, every endpoint setting, and how a check decides Up, Degraded or Down.
- Monitoring from metricsHealth from the app's own metrics (5xx, p95, traffic) instead of, or as well as, calling it.
- Service analyticsResponse times, Apdex and anomalies, network phases and certificates for every endpoint.
- DependenciesA live map of which service needs which, suggestions with evidence, and impact on incidents.
Metrics and dashboards
- Metric sourcesTell Pulsimo where /metrics lives and it pulls on a schedule.
- Metrics ExplorerGraph anything with PromQL or a point-and-click builder.
- DashboardsGrafana-style dashboards with an editor, variables and Grafana JSON import.
- Connected monitoringOne service, one place: endpoint checks, its metrics and its dashboards together.
- Discovered servicesAPIs, databases, hosts and containers found in your metrics, ready to monitor.
Logs
Infrastructure
Incidents and reliability
- Incidents and evidenceWhat the metrics showed, saved with the incident, and impact computed for you.
- Probable causeRanked causes from changes, logs and metrics. Confirm, resolve, and see what happened before.
- SLOsError budgets, burn-rate alerts and real-user Apdex.
- Change markersDeploys, restarts and new routes drawn on every chart.
- Capacity and anomalies"Disk full in about 3 days" and "traffic 70% below last week".
Alerting
- Alarms and rulesRules for logs, traffic, metrics, incidents and checks; acknowledging, routing and maintenance windows.
- Channels and deliverySlack, Discord, Teams, Google Chat, email and webhooks, with tests, a delivery log and muting.
- Routing, digests and deploy graceThe right channel, fewer pages during deploys, and one digest for the small stuff.
Administration
- Users and accessRoles, who needs attention, safe administration, and access that changes at once.
- Settings and API keysOrganization, sign-in security, API keys, integrations and configuration backup.
- API metrics and Event trailHow Pulsimo's API answers per route, and who did what, with filters and export.
Pulsimo's own health
API
Guides
- Running in productionSecrets, HTTPS, firewall, backups, retention and upgrades.
- Best practicesHow to set up checks, alerts and projects so the right people hear about the right things.
- TroubleshootingFixes for sign-in, checks, email, logs and metrics problems.
- FAQShort answers to common questions.
- Release notesWhat changed in recent releases.
Something not working?
The troubleshooting guide covers sign-in, checks, email, logs and metrics.