Skip to content

Commit

Permalink
updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
sidPhoenix17 committed Apr 24, 2024
1 parent 1b5e3c9 commit 7d471d0
Showing 1 changed file with 22 additions and 21 deletions.
43 changes: 22 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,46 +1,47 @@

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

</p>

<center>

[Docs](https://docs.drdroid.io) | [Sandbox](https://sandbox.drdroid.io) | [Templates](https://github.com/DrDroidLab/PlayBooks/playbooks-templates/README.md) | [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) | [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)

</center>

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


## 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%">

</p>


## Using Doctor Droid playbooks, you can create & run automated investigations, spanning across your observability data.
## 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).
- Setup triggers: Trigger a playbook from an alert in Slack.
- [ ] Add support for PagerDuty / OpsGenie / Datadog.
- Sequence: Create sequence of multiple metrics / logs to be fetched in one-go from different tools.
- 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.
- [ ] Interpretation layer: Add a layer of interpretation to the data fetched using Outlier detection models & Vision AI.
- [ ] Saving past executions.
- [ ] Enable conditional trees to be created within playbooks
- [ ] Add support for custom API call from playbook.

Explore [sandbox](https://sandbox.drdroid.io/).

### 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.


### 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 Installation:
Refer to Docker based setup instructions [here](/setup/Docker.md).
- [ ] Run on Kubernetes (via Helm)


## Learn more
- Learn about [integrations](https://docs.drdroid.io/docs/integrations) on Doctor Droid
- Asks questions in the [community](https://join.slack.com/t/doctor-droid-demo/shared_invite/zt-2h6eap61w-Bmz76OEU6IykmDy673R1qQ)
- [Talk to us](https://calendly.com/dipesh-droid/integrations)
### Getting Started:
Refer to Docker based setup instructions [here](/setup/Docker.md).


## License
Playbooks is licensed under the [MIT License](https://github.com/DrDroidLab/PlayBooks/blob/main/LICENSE).
## 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

0 comments on commit 7d471d0

Please sign in to comment.