Skip to content

Commit

Permalink
Merge pull request #51 from DrDroidLab/docs_updation
Browse files Browse the repository at this point in the history
updating docs. demo video pending.
  • Loading branch information
dimittal authored Apr 26, 2024
2 parents 765b41b + 05bb5fd commit fb4aadb
Showing 1 changed file with 38 additions and 24 deletions.
62 changes: 38 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,47 +1,61 @@


<p align="center">
<img src="https://drdroid-public-content.s3.us-west-2.amazonaws.com/github-cover-image.png" alt="Doctor Droid Logo" width="70%" height="50%">
<img src="https://drdroid-public-content.s3.us-west-2.amazonaws.com/github-cover-image.png" alt="Doctor Droid Logo" width="50%" height="50%">

</p>
<center>

[Docs](https://docs.drdroid.io) | [Sandbox](https://sandbox.drdroid.io) | [Templates](https://github.com/DrDroidLab/PlayBooks/tree/main/playbooks-templates) | [Changelog](https://docs.drdroid.io/changelog) | [Community](https://join.slack.com/t/doctor-droid-demo/shared_invite/zt-2h6eap61w-Bmz76OEU6IykmDy673R1qQ)
[Docs](https://docs.drdroid.io) | [Sandbox](https://sandbox.drdroid.io) | [Community](https://join.slack.com/t/doctor-droid-demo/shared_invite/zt-2h6eap61w-Bmz76OEU6IykmDy673R1qQ)

</center>

The PlayBooks framework enables you to setup automation workflows for investigation of issues in your systems.
<br>

tl;dr Enrich your Slack alerts with contextual observability data, helping on-call engineer investigate faster.

## Accelerate triaging and automate diagnosis with Playbooks
<p align="center">
<img src="https://drdroid-public-content.s3.us-west-2.amazonaws.com/before-after.png" alt="Doctor Droid Logo" width="100%" height="90%">
## About PlayBooks
PlayBooks are executable notebooks designed to *Automate Preliminary Investigations in Production* for engineers.
{Demo Video}
### **Automating Playbook Executions**
1. Define a playbook with your enrichment logic
2. Configure the playbook to auto-trigger basis a Slack alert received in a channel
3. Receive automated investigation summary in the Slack thread for the same alert

</p>
### Playground:
* Explore the [sandbox](https://sandbox.drdroid.io/) to get a sense of how the playbooks work.
* You can also check out the [#demo-alerts channel](https://join.slack.com/t/doctor-droid-demo/shared_invite/zt-2h6eap61w-Bmz76OEU6IykmDy673R1qQ) in community Slack workspace to see how automated replies are received for alerts.

## Capabilities
- **Enrichment library**: The tool currently supports fetching 50+ types of enrichment data from metric sources (Datadog, New Relic, Grafana+Prometheus, Cloudwatch Metrics), Logs & Events (Cloudwatch Logs, EKS) and Databases (PostgreSQL DB, Clickhouse DB)

## Create Playbooks & automate investigations:
- Fetch observability data from Datadog, Cloudwatch, New Relic, Grafana, PostgreSQL and more. Full list [here](https://docs.drdroid.io/docs/integrations).
- Triggers: Auto-trigger a playbook from an alert in Slack.
- Auto-investigation: Receive response after a playbook run in your Slack channel or your alerting tool with the investigation data published.
- **Past Executions**: See the historical runs of a playbook and go back to an investigation from a specific point in time.

- **Continuous monitoring**: Setup continuous monitoring cron for specific use-cases (e.g. post deployment, peak hours, post bug-fix). Read [docs](https://docs.drdroid.io/docs/setting-up-slack-alert-enrichment-on-self-hosted-playbooks) for list of allowed configurations.

### What can you automate with Playbooks?
- Continous monitoring of critical user workflows and metrics every [5] minutes for [12] hours after a new deployment.
- Automatically enrich a Slack alert with a preliminary investigation summary that can help a reader investigate faster.
- Create & share playbooks with debugging strategy for parts of the system that you understand well.
- See the investigation data from the previous time a similar alert was seen in your system.
- Have a preliminary investigation ready for you in Slack even before you open an alert.

### Coming Soon:
- **Interpretation Layer**: Configure ML modules which can analyse & interpret data from your investigation playbooks.
- **Templates**: Common investigation & troubleshooting logics which can be used out of the box.
- **Conditionals**: Create decision trees in your playbooks basis evaluation of a playbook step.
- **More integrations**: Find something missing? Request [here](https://github.com/DrDroidLab/PlayBooks/issues/new).

### Learn more:
* Explore [sandbox](https://sandbox.drdroid.io/).
* Here's a [demo video](https://www.youtube.com/watch?v=8PEZlZbb6Fs) about how playbooks work.


## Getting Started with alert enrichment
#### Self-hosting:
**Step 1:** We currently support setup using docker.
Run the below command and signup on [localhost](http://localhost:80) to start creating playbooks.

### Getting Started:
Refer to Docker based setup instructions [here](/setup/Docker.md).
```
git clone git@github.com:DrDroidLab/PlayBooks.git
```
```
docker-compose -f playbooks.docker-compose.yaml up -d
```
**Step 2:** Follow this [Step-by-Step guide](https://docs.drdroid.io/docs/setting-up-slack-alert-enrichment-on-self-hosted-playbooks) to do your first alert enrichment.

#### [Cloud Signup](https://playbooks.drdroid.io/signup)

## Have queries?
Asks questions in the [community](https://join.slack.com/t/doctor-droid-demo/shared_invite/zt-2h6eap61w-Bmz76OEU6IykmDy673R1qQ) or write to us at founders [at] drdroid [dot] io
## Have feedback or queries?
Asks questions in the [Slack Community](https://join.slack.com/t/doctor-droid-demo/shared_invite/zt-2h6eap61w-Bmz76OEU6IykmDy673R1qQ) or write to us at founders [at] drdroid [dot] io

0 comments on commit fb4aadb

Please sign in to comment.