mirror of
https://github.com/elastic/kibana.git
synced 2025-04-24 09:48:58 -04:00
Your window into the Elastic Stack
96dc2a5104
## 🍒 Summary This PR adds a rule dependency feature to the SLO Burn Rate rule to enable rule suppression when one of the dependencies meets the suppression criteria. ### 📟 Use case When you add a rule dependency to your SLO Burn Rate rule, you will also choose which action groups you want to suppress on. For example, if you have rule `A` which depends on rule `B` and you want to suppress the actions of rule `A` when rule `B` is triggering `Critical` or `High`, you'd add rule `B` and pick the action groups `Critical` and `High`. When rule `B` is triggering either of those action groups, ALL of the actions for rule `A` will be suppressed. When an action is suppressed, we will trigger a `Suppressed` action group an set the context variable `{context.suppressedAction}` to the action that would have been trigger if they rule wasn't suppressed. This will allow users to create an "action" for `Suppressed` alerts so they can still create notification without waking up the team for a `Critical` or `High` severity alert. If you have 2 rules that use a group by, then the suppression will happen on the intersection of the `slo.instanceId`. For example, imagine we have a Nginx Proxy in front of an Node.js web service and we've created an availability SLO based on `status_code < 500` for both, grouped-by `url.domain`. When the Node.js app responds with a `500`, the Nginx Proxy's SLO will start to degrade because of the Node.js service. The admins for the Nginx Proxy would like to only receive alerts if the Node.js web services is "healthy" so they've listed the Node.js burn rate rule as a dependency to suppress on `Critical` or `High` burn rates. When one of the domains, `you-got.mail`, starts to throw 500's and the burn rate becomes `High`, the rule will suppress the alert for the `you-got.mail` Nginx Proxy instance. If one of the other domains, `box.mail`, for Nginx started throwing `502` because of a mis-configuration, the alert would trigger normally because the `box.mail` instance of the rule dependency for the Node.js web service is still healthy (or not triggering `Critical` or `High`). The suppression between group-by SLOs and non-group-by SLOs works like this: - SLO with a group-by depends on a non-grouped-by SLO, all the instances of the group by will be suppressed. - SLO without a group-by depends on an SLO with a group-by, the non-grouped SLO will be suppressed if ANY of the instances of the group-by are triggering the "suppress on" action groups. ### 💻 Screenshots Adding a rule dependency for MongoDB to a Node.js web app <img width="764" alt="image" src=" |
||
|---|---|---|
| .buildkite | ||
| .github | ||
| api_docs | ||
| config | ||
| dev_docs | ||
| docs | ||
| examples | ||
| kbn_pm | ||
| legacy_rfcs | ||
| licenses | ||
| packages | ||
| plugins | ||
| scripts | ||
| src | ||
| test | ||
| typings | ||
| x-pack | ||
| .backportrc.json | ||
| .bazelignore | ||
| .bazeliskversion | ||
| .bazelrc | ||
| .bazelrc.common | ||
| .bazelversion | ||
| .browserslistrc | ||
| .editorconfig | ||
| .eslintignore | ||
| .eslintrc.js | ||
| .gitattributes | ||
| .gitignore | ||
| .i18nrc.json | ||
| .node-version | ||
| .npmrc | ||
| .nvmrc | ||
| .prettierignore | ||
| .prettierrc | ||
| .puppeteerrc | ||
| .stylelintignore | ||
| .stylelintrc | ||
| .telemetryrc.json | ||
| .yarnrc | ||
| BUILD.bazel | ||
| catalog-info.yaml | ||
| CODE_OF_CONDUCT.md | ||
| CONTRIBUTING.md | ||
| FAQ.md | ||
| fleet_packages.json | ||
| github_checks_reporter.json | ||
| kibana.d.ts | ||
| LICENSE.txt | ||
| nav-kibana-dev.docnav.json | ||
| NOTICE.txt | ||
| package.json | ||
| preinstall_check.js | ||
| README.md | ||
| renovate.json | ||
| RISK_MATRIX.mdx | ||
| SECURITY.md | ||
| sonar-project.properties | ||
| STYLEGUIDE.mdx | ||
| tsconfig.base.json | ||
| tsconfig.browser.json | ||
| tsconfig.browser_bazel.json | ||
| tsconfig.json | ||
| TYPESCRIPT.md | ||
| versions.json | ||
| WORKSPACE.bazel | ||
| yarn.lock | ||
Kibana
Kibana is your window into the Elastic Stack. Specifically, it's a browser-based analytics and search dashboard for Elasticsearch.
- Getting Started
- Documentation
- Version Compatibility with Elasticsearch
- Questions? Problems? Suggestions?
Getting Started
If you just want to try Kibana out, check out the Elastic Stack Getting Started Page to give it a whirl.
If you're interested in diving a bit deeper and getting a taste of Kibana's capabilities, head over to the Kibana Getting Started Page.
Using a Kibana Release
If you want to use a Kibana release in production, give it a test run, or just play around:
- Download the latest version on the Kibana Download Page.
- Learn more about Kibana's features and capabilities on the Kibana Product Page.
- We also offer a hosted version of Kibana on our Cloud Service.
Building and Running Kibana, and/or Contributing Code
You might want to build Kibana locally to contribute some code, test out the latest features, or try out an open PR:
- CONTRIBUTING.md will help you get Kibana up and running.
- If you would like to contribute code, please follow our STYLEGUIDE.mdx.
- For all other questions, check out the FAQ.md and wiki.
Documentation
Visit Elastic.co for the full Kibana documentation.
For information about building the documentation, see the README in elastic/docs.
Version Compatibility with Elasticsearch
Ideally, you should be running Elasticsearch and Kibana with matching version numbers. If your Elasticsearch has an older version number or a newer major number than Kibana, then Kibana will fail to run. If Elasticsearch has a newer minor or patch number than Kibana, then the Kibana Server will log a warning.
Note: The version numbers below are only examples, meant to illustrate the relationships between different types of version numbers.
| Situation | Example Kibana version | Example ES version | Outcome |
|---|---|---|---|
| Versions are the same. | 7.15.1 | 7.15.1 | 💚 OK |
| ES patch number is newer. | 7.15.0 | 7.15.1 | ⚠️ Logged warning |
| ES minor number is newer. | 7.14.2 | 7.15.0 | ⚠️ Logged warning |
| ES major number is newer. | 7.15.1 | 8.0.0 | 🚫 Fatal error |
| ES patch number is older. | 7.15.1 | 7.15.0 | ⚠️ Logged warning |
| ES minor number is older. | 7.15.1 | 7.14.2 | 🚫 Fatal error |
| ES major number is older. | 8.0.0 | 7.15.1 | 🚫 Fatal error |
Questions? Problems? Suggestions?
- If you've found a bug or want to request a feature, please create a GitHub Issue. Please check to make sure someone else hasn't already created an issue for the same topic.
- Need help using Kibana? Ask away on our Kibana Discuss Forum and a fellow community member or Elastic engineer will be glad to help you out.