You are browsing a read-only backup copy of Wikitech. The live site can be found at wikitech.wikimedia.org

Runbook: Difference between revisions

From Wikitech-static
Jump to navigation Jump to search
imported>Filippo Giunchedi
(Add service-specific entry and explanation/context)
imported>Filippo Giunchedi
(Backfill runbooks from service::catalog)
Line 15: Line 15:
[[Category:Runbooks| ]]
[[Category:Runbooks| ]]
[[Category:Monitoring]]
[[Category:Monitoring]]
== helm-charts:443 ==
This is the service powered by chartmuseum, see also https://wikitech.wikimedia.org/wiki/ChartMuseum
== releases:443 ==
See also https://wikitech.wikimedia.org/wiki/Releases.wikimedia.org
== puppetdb-api:8090 ==
See also https://wikitech.wikimedia.org/wiki/Puppet#Micro_Service
== graphite:443 ==
See also https://wikitech.wikimedia.org/wiki/Graphite
== grafana:443 ==
See also https://wikitech.wikimedia.org/wiki/Grafana.wikimedia.org
== librenms:443 ==
See also https://wikitech.wikimedia.org/wiki/LibreNMS
== apt:80 ==
See also https://wikitech.wikimedia.org/wiki/APT_repository
== puppetboard:443 ==
See also https://wikitech.wikimedia.org/wiki/Puppet
== netbox:443 ==
See also https://wikitech.wikimedia.org/wiki/Netbox

Revision as of 08:13, 25 July 2022

A runbook is a set of instructions for a human what to do. More specifically what to do when a certain monitoring alert triggers.

Prometheus alerting rules link to this page in a service-specific anchor based on the service name itself; from the service entry you can give more context, next actions, and link to other resources such as more runbooks, service dashboards, etc.

Pages that contain runbooks are linked from Icinga checks in puppet using the notes_url parameter, or alertmanager rules with the runbook annotation.

There is a Category:Runbooks for pages with runbooks.

Compare to cookbooks which are programs running in spicerack/cumin to do maintenance tasks.

service-name:port

This is the entry linked from generic alerts for service-name:port, for example ProbeDown will link here when network probes for service-name fail. See also bug T312947.

helm-charts:443

This is the service powered by chartmuseum, see also https://wikitech.wikimedia.org/wiki/ChartMuseum

releases:443

See also https://wikitech.wikimedia.org/wiki/Releases.wikimedia.org

puppetdb-api:8090

See also https://wikitech.wikimedia.org/wiki/Puppet#Micro_Service

graphite:443

See also https://wikitech.wikimedia.org/wiki/Graphite

grafana:443

See also https://wikitech.wikimedia.org/wiki/Grafana.wikimedia.org

librenms:443

See also https://wikitech.wikimedia.org/wiki/LibreNMS

apt:80

See also https://wikitech.wikimedia.org/wiki/APT_repository

puppetboard:443

See also https://wikitech.wikimedia.org/wiki/Puppet

netbox:443

See also https://wikitech.wikimedia.org/wiki/Netbox