mirror of
https://github.com/elastic/kibana.git
synced 2025-04-24 17:59:23 -04:00
Your window into the Elastic Stack
b059522911
# Backport This will backport the following commits from `main` to `8.x`: - [[Response Ops][Alerting] Adding ability to run actions for backfill rule runs (#200784)](https://github.com/elastic/kibana/pull/200784) <!--- Backport version: 9.6.4 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sorenlouv/backport) <!--BACKPORT [{"author":{"name":"Ying Mao","email":"ying.mao@elastic.co"},"sourceCommit":{"committedDate":"2025-01-20T15:03:33Z","message":"[Response Ops][Alerting] Adding ability to run actions for backfill rule runs (#200784)\n\nResolves https://github.com/elastic/response-ops-team/issues/251\r\n\r\n\r\n## Note\r\n\r\nThis PR includes some saved object schema changes that I will pull out\r\ninto their own separate PR in order to perform an intermediate release.\r\nI wanted to make sure all the schema changes made sense in the overall\r\ncontext of the PR before opening those separate PRs.\r\n\r\nUpdate: PR for intermediate release here:\r\nhttps://github.com/elastic/kibana/pull/203184 (Merged)\r\n\r\n## Summary\r\n\r\nAdds ability to run actions for backfill rule runs.\r\n\r\n- Updates schedule backfill API to accept `run_actions` parameter to\r\nspecify whether to run actions for backfill.\r\n- Schedule API accepts any action where `frequency.notifyWhen ===\r\n'onActiveAlert'`. If a rule has multiple actions where some are\r\n`onActiveAlert` and some are `onThrottleInterval`, the invalid actions\r\nwill be stripped and a warning returned in the schedule response but\r\nvalid actions will be scheduled.\r\n- Connector IDs are extracted and stored as references in the ad hoc run\r\nparams saved object\r\n- Any actions that result from a backfill task run are scheduled as low\r\npriority tasks\r\n\r\n## To Verify\r\n\r\n1. Create a detection rule. Make sure you have some past data that the\r\nrule can run over in order to generate actions. Make sure you add\r\nactions to the rule. For testing, I added some conditional actions so I\r\ncould see actions running only on backfill runs using\r\n`kibana.alert.rule.execution.type: \"manual\"`. Create actions with and\r\nwithout summaries.\r\n2. Schedule a backfill either directly via the API or using the\r\ndetection UI. Verify that actions are run for the backfill runs that\r\ngenerate alerts.\r\n\r\n---------\r\n\r\nCo-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>","sha":"075806bffa78cc4f42e61483dcbd24de3c87d3c8","branchLabelMapping":{"^v9.0.0$":"main","^v8.18.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Feature:Alerting","release_note:skip","Team:ResponseOps","v9.0.0","backport:prev-minor","ci:project-deploy-security","v8.18.0"],"title":"[Response Ops][Alerting] Adding ability to run actions for backfill rule runs","number":200784,"url":"https://github.com/elastic/kibana/pull/200784","mergeCommit":{"message":"[Response Ops][Alerting] Adding ability to run actions for backfill rule runs (#200784)\n\nResolves https://github.com/elastic/response-ops-team/issues/251\r\n\r\n\r\n## Note\r\n\r\nThis PR includes some saved object schema changes that I will pull out\r\ninto their own separate PR in order to perform an intermediate release.\r\nI wanted to make sure all the schema changes made sense in the overall\r\ncontext of the PR before opening those separate PRs.\r\n\r\nUpdate: PR for intermediate release here:\r\nhttps://github.com/elastic/kibana/pull/203184 (Merged)\r\n\r\n## Summary\r\n\r\nAdds ability to run actions for backfill rule runs.\r\n\r\n- Updates schedule backfill API to accept `run_actions` parameter to\r\nspecify whether to run actions for backfill.\r\n- Schedule API accepts any action where `frequency.notifyWhen ===\r\n'onActiveAlert'`. If a rule has multiple actions where some are\r\n`onActiveAlert` and some are `onThrottleInterval`, the invalid actions\r\nwill be stripped and a warning returned in the schedule response but\r\nvalid actions will be scheduled.\r\n- Connector IDs are extracted and stored as references in the ad hoc run\r\nparams saved object\r\n- Any actions that result from a backfill task run are scheduled as low\r\npriority tasks\r\n\r\n## To Verify\r\n\r\n1. Create a detection rule. Make sure you have some past data that the\r\nrule can run over in order to generate actions. Make sure you add\r\nactions to the rule. For testing, I added some conditional actions so I\r\ncould see actions running only on backfill runs using\r\n`kibana.alert.rule.execution.type: \"manual\"`. Create actions with and\r\nwithout summaries.\r\n2. Schedule a backfill either directly via the API or using the\r\ndetection UI. Verify that actions are run for the backfill runs that\r\ngenerate alerts.\r\n\r\n---------\r\n\r\nCo-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>","sha":"075806bffa78cc4f42e61483dcbd24de3c87d3c8"}},"sourceBranch":"main","suggestedTargetBranches":["8.x"],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","branchLabelMappingKey":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/200784","number":200784,"mergeCommit":{"message":"[Response Ops][Alerting] Adding ability to run actions for backfill rule runs (#200784)\n\nResolves https://github.com/elastic/response-ops-team/issues/251\r\n\r\n\r\n## Note\r\n\r\nThis PR includes some saved object schema changes that I will pull out\r\ninto their own separate PR in order to perform an intermediate release.\r\nI wanted to make sure all the schema changes made sense in the overall\r\ncontext of the PR before opening those separate PRs.\r\n\r\nUpdate: PR for intermediate release here:\r\nhttps://github.com/elastic/kibana/pull/203184 (Merged)\r\n\r\n## Summary\r\n\r\nAdds ability to run actions for backfill rule runs.\r\n\r\n- Updates schedule backfill API to accept `run_actions` parameter to\r\nspecify whether to run actions for backfill.\r\n- Schedule API accepts any action where `frequency.notifyWhen ===\r\n'onActiveAlert'`. If a rule has multiple actions where some are\r\n`onActiveAlert` and some are `onThrottleInterval`, the invalid actions\r\nwill be stripped and a warning returned in the schedule response but\r\nvalid actions will be scheduled.\r\n- Connector IDs are extracted and stored as references in the ad hoc run\r\nparams saved object\r\n- Any actions that result from a backfill task run are scheduled as low\r\npriority tasks\r\n\r\n## To Verify\r\n\r\n1. Create a detection rule. Make sure you have some past data that the\r\nrule can run over in order to generate actions. Make sure you add\r\nactions to the rule. For testing, I added some conditional actions so I\r\ncould see actions running only on backfill runs using\r\n`kibana.alert.rule.execution.type: \"manual\"`. Create actions with and\r\nwithout summaries.\r\n2. Schedule a backfill either directly via the API or using the\r\ndetection UI. Verify that actions are run for the backfill runs that\r\ngenerate alerts.\r\n\r\n---------\r\n\r\nCo-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>","sha":"075806bffa78cc4f42e61483dcbd24de3c87d3c8"}},{"branch":"8.x","label":"v8.18.0","branchLabelMappingKey":"^v8.18.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}] BACKPORT--> --------- Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com> |
||
|---|---|---|
| .buildkite | ||
| .devcontainer | ||
| .github | ||
| api_docs | ||
| config | ||
| dev_docs | ||
| docs | ||
| examples | ||
| kbn_pm | ||
| legacy_rfcs | ||
| licenses | ||
| oas_docs | ||
| 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 | ||
| NOTICE.txt | ||
| package.json | ||
| preinstall_check.js | ||
| README.md | ||
| renovate.json | ||
| RISK_MATRIX.mdx | ||
| run_fleet_setup_parallel.sh | ||
| 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.