StackPulse Playbooks
StackPulse automates and orchestrates incident response and management, empowering SREs and developers to reduce toil, fix issues faster and deliver reliable software services. This repository contains a set of ready-to-use resources, created by StackPulse together with our partners and the community of our users, that will help you get started with managing and improving the reliability of your services.
To learn more about StackPulse, please refer to our platform description or to our product documentation. For your conveniece, playbooks presented in this repository are arranged by use case.
Use-Cases
Alert Enrichment and System Diagnostics
Playbooks in this section enrich, analyze and triage alerts in real-time. They highlight the important data to be use for remediation by the on-caller engineers. Utilizing them in the incident response routine improves MTTR (Mean Time to Resolve) across all teams and personnel, as well as helps leveraging best diagnostics / troubleshooting practices for each system component regardless of the on-call engineers expertise level.
|
Kubernetes Rollback This playbook enables an operator to easily and safely scale a service deployment by changing Kubernetes Horizontal Pod Autoscaler (HPA) settings. Executing the playbook will get the new HPA range from the user and issue both the scale command and create a pull request to solidify the change in a GitOps repo. 
|
|
|
Kubernetes Service Scale This playbook enables an operator to easily and properly rollback a Kubernetes deployment using a GitOps FluxCD. Executing the playbook will interactively retrieve the list of services to the user and then the commit history for the selected service. Once the correct target tag is chosen, the playbook continues to safely rollback the service and lock the CD pipeline.
|
|
|
Kubernetes Job Failed This playbook extracts logs from a failed Kubernetes job, sending them as a snippet to Slack, and optionally allows to delete or rerun, asking via Slack.
|
|
|
Java Memory Dump This playbook takes a heap memory dump of a java application running in a Kubernetes pod, and ask the user interactively whether to restart the pod after the dump.
|
|
|
Kubernetes Pod Restarting This playbook solves consistent Pod Restarting events in a Kubernetes cluster. It gets the latest started pods in the namespace provided either by alert or by the user, then gets the current and previous (if exists) logs of the relevant container.
|
|
Postgres Long Running Sessions This playbook collects all non-idle long running sessions from PostgresSQL instance and send it to Slack recipients.
|
|
RabbitMQ Queues Overview This playbook collects an overview about RabbitMQ instance and classify it's most consumption queues by: messages, unacknowledged messages, messages bytes and memory and send it to Slack recipients.
|
|
Elasticsearch Get Stats This playbook collects diagnostic information, stats and metrics from an Elasticsearch cluster and sends it to specified recepients in Slack. 
|
|
Redis Get Big Keys This playbook queries a Redis host and retrieves the current big keys. It then sends that output to Slack recipients of your choice as a snippet. 
|
|
|
Redis Diagnostics This playbook collects Redis cluster diagnostics that focus on common factors to high memory consumption and performance issues. It then sends that output via Slack.
|
|
Linux Diagnostics This playbook queries utilization of CPU, memory and storage for a given host and sends the output to Slack recipients of choice. 
|
|
Auto Scaling Group Execute Command This playbook executes a command on each instance of an AWS Auto Scaling Group and and then verifies its health. 
|
Incident Management and Orchestration
Playbooks in this section help automate incident management and communication flows across the organization or specific per teams and services.
|
Create Incident War-room (Slack) This playbook creates a Slack Incident War Room when an incident is created, invites the relevant participants (based on incident details or other logic).
|
|
|
Create Incident War-room (Slack, Zoom, PagerDuty) Playbook that creates Incident War Room in Slack (and/or Video Conferencing software) when an incident is created, invites the relevant participants based on incident details (and/or on on-call rotation schedules).
|
|
|
Create Incident War-room (Slack, Zoom, OpsGenie) Playbook that creates Incident War Room in Slack (and/or Video Conferencing software) when an incident is created, invites the relevant participants based on incident details (and/or on on-call rotation schedules).
|
|
|
Archive Incident War Room (Slack) Playbook that runs upon incident resolution and asks the incident commander whether to archive the Slack War-room that belonged to the incident.
|