mirror of
https://github.com/elastic/kibana.git
synced 2025-04-24 17:59:23 -04:00
Your window into the Elastic Stack
3fddba179f
# Backport This will backport the following commits from `main` to `8.x`: - [[ResponseOps][Rules] Create Rules APIs package (#214187)](https://github.com/elastic/kibana/pull/214187) <!--- Backport version: 9.6.6 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sorenlouv/backport) <!--BACKPORT [{"author":{"name":"Umberto Pepato","email":"umbopepato@users.noreply.github.com"},"sourceCommit":{"committedDate":"2025-03-26T09:01:51Z","message":"[ResponseOps][Rules] Create Rules APIs package (#214187)\n\n## Summary\n\n- Creates a `@kbn/response-ops-rules-apis` package, following the\nproposed structure for ResponseOps Management Experiences package.\n- Moves relevant rules API fetchers and react-query hooks to the new\npackage.\n- Adds an internal variant of the `/api/alerting/rule_types` endpoint\n(`/internal/alerting/_rule_types`), that returns the same value as the\npublic one + the newly added internal [`solution`\nfield](https://github.com/elastic/kibana/issues/212017), that we don't\nwant to expose publicly.\n\n## Verification steps\n\n1. Create rules that fire alerts\n2. Verify the usages of the moved/changed hooks, with limited privileges\nas well (i.e. only `Rules Settings` but not `Stack Rules`):\n2.1. Stack management and Observability rules, rule details and alerts\npages\n2.2. Rules tab in the Connector editor flyout\n2.3. Alerts table row actions (••• icon)\n2.4. Tags filter in the rules list page\n3. Using the DevTools, compare the response of the public and internal\n`rule_types` endpoins:\n ```\n GET kbn:/api/alerting/rule_types\n GET kbn:/internal/alerting/_rule_types\n ```\nChecking that the `solution` field is present only in the internal one\n\n## References \n\nCloses #213059 \n\n### Checklist\n\n- [x] [Unit or functional\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\nwere updated or added to match the most common scenarios\n\n---------\n\nCo-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>","sha":"7aac590af4e245049f3865ea23ed88a179a80a28","branchLabelMapping":{"^v9.1.0$":"main","^v8.19.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","Team:ResponseOps","Team:obs-ux-management","backport:version","v9.1.0","v8.19.0"],"title":"[ResponseOps][Rules] Create Rules APIs package","number":214187,"url":"https://github.com/elastic/kibana/pull/214187","mergeCommit":{"message":"[ResponseOps][Rules] Create Rules APIs package (#214187)\n\n## Summary\n\n- Creates a `@kbn/response-ops-rules-apis` package, following the\nproposed structure for ResponseOps Management Experiences package.\n- Moves relevant rules API fetchers and react-query hooks to the new\npackage.\n- Adds an internal variant of the `/api/alerting/rule_types` endpoint\n(`/internal/alerting/_rule_types`), that returns the same value as the\npublic one + the newly added internal [`solution`\nfield](https://github.com/elastic/kibana/issues/212017), that we don't\nwant to expose publicly.\n\n## Verification steps\n\n1. Create rules that fire alerts\n2. Verify the usages of the moved/changed hooks, with limited privileges\nas well (i.e. only `Rules Settings` but not `Stack Rules`):\n2.1. Stack management and Observability rules, rule details and alerts\npages\n2.2. Rules tab in the Connector editor flyout\n2.3. Alerts table row actions (••• icon)\n2.4. Tags filter in the rules list page\n3. Using the DevTools, compare the response of the public and internal\n`rule_types` endpoins:\n ```\n GET kbn:/api/alerting/rule_types\n GET kbn:/internal/alerting/_rule_types\n ```\nChecking that the `solution` field is present only in the internal one\n\n## References \n\nCloses #213059 \n\n### Checklist\n\n- [x] [Unit or functional\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\nwere updated or added to match the most common scenarios\n\n---------\n\nCo-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>","sha":"7aac590af4e245049f3865ea23ed88a179a80a28"}},"sourceBranch":"main","suggestedTargetBranches":["8.x"],"targetPullRequestStates":[{"branch":"main","label":"v9.1.0","branchLabelMappingKey":"^v9.1.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/214187","number":214187,"mergeCommit":{"message":"[ResponseOps][Rules] Create Rules APIs package (#214187)\n\n## Summary\n\n- Creates a `@kbn/response-ops-rules-apis` package, following the\nproposed structure for ResponseOps Management Experiences package.\n- Moves relevant rules API fetchers and react-query hooks to the new\npackage.\n- Adds an internal variant of the `/api/alerting/rule_types` endpoint\n(`/internal/alerting/_rule_types`), that returns the same value as the\npublic one + the newly added internal [`solution`\nfield](https://github.com/elastic/kibana/issues/212017), that we don't\nwant to expose publicly.\n\n## Verification steps\n\n1. Create rules that fire alerts\n2. Verify the usages of the moved/changed hooks, with limited privileges\nas well (i.e. only `Rules Settings` but not `Stack Rules`):\n2.1. Stack management and Observability rules, rule details and alerts\npages\n2.2. Rules tab in the Connector editor flyout\n2.3. Alerts table row actions (••• icon)\n2.4. Tags filter in the rules list page\n3. Using the DevTools, compare the response of the public and internal\n`rule_types` endpoins:\n ```\n GET kbn:/api/alerting/rule_types\n GET kbn:/internal/alerting/_rule_types\n ```\nChecking that the `solution` field is present only in the internal one\n\n## References \n\nCloses #213059 \n\n### Checklist\n\n- [x] [Unit or functional\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\nwere updated or added to match the most common scenarios\n\n---------\n\nCo-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>","sha":"7aac590af4e245049f3865ea23ed88a179a80a28"}},{"branch":"8.x","label":"v8.19.0","branchLabelMappingKey":"^v8.19.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}] BACKPORT--> --------- Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com> Co-authored-by: Alex Szabo <alex.szabo@elastic.co> |
||
|---|---|---|
| .buildkite | ||
| .devcontainer | ||
| .github | ||
| api_docs | ||
| config | ||
| dev_docs | ||
| docs | ||
| examples | ||
| kbn_pm | ||
| legacy_rfcs | ||
| licenses | ||
| oas_docs | ||
| packages | ||
| plugins | ||
| scripts | ||
| src | ||
| 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.