-
Notifications
You must be signed in to change notification settings - Fork 304
more doc improvements #1952
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
more doc improvements #1952
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
03bc2b7
fixes
aantn 4b83b01
more improvements
aantn 219de12
update menu order
aantn a9ab949
Merge branch 'master' into more-docs-improvements
aantn 2f57b11
fixes
aantn 3c580fe
Merge branch 'more-docs-improvements' of https://github.com/robusta-d…
aantn 3b4ca83
Update docs/playbook-reference/index.rst
aantn File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 2 additions & 0 deletions
2
docs/playbook-reference/actions/develop-actions/loading-custom-actions.rst
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 2 additions & 0 deletions
2
docs/playbook-reference/actions/develop-actions/playbook-repositories.rst
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,5 @@ | ||
| .. _Creating Playbook Repositories: | ||
|
|
||
| Creating Playbook Repositories | ||
| ################################ | ||
|
|
||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,7 @@ | ||
| :hide-toc: | ||
|
|
||
| .. _Actions Reference: | ||
|
|
||
| Actions Reference | ||
| ================== | ||
|
|
||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,26 +1,60 @@ | ||
| .. _builtin-alert-enrichment: | ||
|
|
||
| Builtin Alert Enrichment | ||
| Alert Enrichment | ||
| ######################################## | ||
|
|
||
| Robusta takes Prometheus to the next level by correlating alerts with other observability data. | ||
| Ever feel overwhelmed by alerts that lack context? Robusta enriches alerts automatically and lets you create custom enrichment rules. | ||
|
|
||
| .. note:: | ||
|
|
||
| Testing out Prometheus alerts | ||
| **Looking for automatic AI enrichment?** Check out :doc:`HolmesGPT </configuration/holmesgpt/main-features>` for zero-configuration AI-powered alert enrichment that automatically investigates alerts and provides root cause analysis. | ||
|
|
||
| Builtin Alert Enrichment | ||
| ********************************* | ||
| 1. Deploy a broken pod that will be stuck in pending state: | ||
|
|
||
| Robusta automatically enriches Prometheus alerts with relevant Kubernetes context: | ||
|
|
||
| * **Pod events** - Recent events related to the affected pod | ||
| * **Pod logs** - Relevant log excerpts from crashing or failing containers | ||
| * **Resource metrics** - CPU, memory, and other resource usage data | ||
| * **Related Kubernetes objects** - Deployments, ReplicaSets, ConfigMaps, etc. | ||
|
|
||
| This happens automatically for common Prometheus alerts without any configuration. To extend it to your own Prometheus alerts you can define custom playbooks. | ||
|
|
||
| Testing Alert Enrichment | ||
| ^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
|
|
||
| 1. Deploy a broken pod: | ||
|
|
||
| .. code-block:: bash | ||
| :name: cb-apply-pendingpod | ||
|
|
||
| kubectl apply -f https://raw.githubusercontent.com/robusta-dev/kubernetes-demos/main/pending_pods/pending_pod_resources.yaml | ||
|
|
||
| 2. Trigger a Prometheus alert immediately, skipping the normal delays: | ||
| 2. Trigger a Prometheus alert immediately: | ||
|
|
||
| .. code-block:: bash | ||
| :name: cb-trigger-prometheus-alert | ||
|
|
||
| robusta playbooks trigger prometheus_alert alert_name=KubePodCrashLooping namespace=default pod_name=example-pod | ||
|
|
||
| .. admonition:: Example Slack Message | ||
| .. admonition:: Example Enriched Alert | ||
|
|
||
| .. image:: /images/simulatedprometheusalert.png | ||
|
|
||
| Custom Alert Enrichment | ||
| ********************************* | ||
|
|
||
| Create custom enrichment rules to: | ||
|
|
||
| * Reduce MTTR by automatically gathering system state and logs when alerts fire | ||
| * Make faster decisions on which team needs to investigate | ||
| * Link alerts to runbooks and documentation for better knowledge sharing | ||
|
|
||
| Get started with these examples: | ||
|
|
||
| .. toctree:: | ||
| :maxdepth: 1 | ||
|
|
||
| prometheus-examples/bash-alert-enrichment | ||
| prometheus-examples/link-alert-enrichment |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
docs/playbook-reference/defining-playbooks/creating-notifications.rst
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 2 additions & 0 deletions
2
docs/playbook-reference/defining-playbooks/external-playbook-repositories.rst
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,5 @@ | ||
| .. _Loading External Actions: | ||
|
|
||
| Loading External Actions | ||
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
|
|
||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.