mirror of
https://github.com/elastic/kibana.git
synced 2025-04-24 09:48:58 -04:00
Your window into the Elastic Stack
442330ad94
# Backport This will backport the following commits from `main` to `8.x`: - [🌊 Streams: Selectors for derived samples (#213638)](https://github.com/elastic/kibana/pull/213638) <!--- Backport version: 9.6.6 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sorenlouv/backport) <!--BACKPORT [{"author":{"name":"Joe Reuter","email":"johannes.reuter@elastic.co"},"sourceCommit":{"committedDate":"2025-04-01T09:47:31Z","message":"🌊 Streams: Selectors for derived samples (#213638)\n\nSimplified massively from first state and just plugging in reselect in\nplaces where that's suitable (here to calculate the currently relevant\nsample documents).\n\nAlso does a drive-by layout fix.\n\n~Introduces a new xstate helper for derived data.~\n\n~In most cases, the actor and state machine model of xstate is great,\nbut for derived data using pure functions, the semantics of the\n`useMemo` hook with defined dependencies is often easier to understand\nand eliminates the risk of forgetting to update the derived data\ncorrectly in some cases.~\n\n~It's about using the right tool for the right job - you don't need to\nchoose between the dependency list of useMemo and the actor model of\nxstate, you can use what fits the case, without compromising\nperformance.~\n\n~This is the API:~\n```ts\nconst myActorContext = withMemoizedSelectors(\n createActorContext(myMachine),\n {\n derivedView: createSelector(\n [\n (ctx: MyContextType) => {\n return ctx.dependency1;\n },\n (ctx: MyContextType) =>\n ctx.dependency2,\n ],\n (dependency1, dependency2) => {\n return // expensive calculation only running when necessary\n }\n ),\n },\n (context) => (context.subMachine ? [context.subMachine] : []) // optional subscribe to changes of submachines as well\n);\n\n\n// in react use useMemoizedSelector hook\n// this will cause the component to rerender if the selector is returning a new value\nmyActorContext.useMemoizedSelector('derivedView')\n```\n\n~This is using reselect to declare the dependencies similar to a react\nuseMemo hook - the actual selector will only run if the dependencies\nchange, leading to similar semantics as useMemo, with the additional\nbenefit that if the value is used in multiple places, it's still just\ncalculated once. The component calling `withMemoizedSelectors` only\nre-renders if the value returned by the selector changes. The selector\nitself only re-runs if one of the declared dependencies changes.~\n\n~Everything is type-safe by capturing the types of the reselect selector\nobject via inferred type param and using it in the `useMemoizedSelector`\ntype.~","sha":"c5e0b05454b124949de754556ec8ba5289445ab3","branchLabelMapping":{"^v9.1.0$":"main","^v8.19.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","Team:obs-ux-logs","backport:version","Feature:Streams","v9.1.0","v8.19.0"],"title":"🌊 Streams: Selectors for derived samples","number":213638,"url":"https://github.com/elastic/kibana/pull/213638","mergeCommit":{"message":"🌊 Streams: Selectors for derived samples (#213638)\n\nSimplified massively from first state and just plugging in reselect in\nplaces where that's suitable (here to calculate the currently relevant\nsample documents).\n\nAlso does a drive-by layout fix.\n\n~Introduces a new xstate helper for derived data.~\n\n~In most cases, the actor and state machine model of xstate is great,\nbut for derived data using pure functions, the semantics of the\n`useMemo` hook with defined dependencies is often easier to understand\nand eliminates the risk of forgetting to update the derived data\ncorrectly in some cases.~\n\n~It's about using the right tool for the right job - you don't need to\nchoose between the dependency list of useMemo and the actor model of\nxstate, you can use what fits the case, without compromising\nperformance.~\n\n~This is the API:~\n```ts\nconst myActorContext = withMemoizedSelectors(\n createActorContext(myMachine),\n {\n derivedView: createSelector(\n [\n (ctx: MyContextType) => {\n return ctx.dependency1;\n },\n (ctx: MyContextType) =>\n ctx.dependency2,\n ],\n (dependency1, dependency2) => {\n return // expensive calculation only running when necessary\n }\n ),\n },\n (context) => (context.subMachine ? [context.subMachine] : []) // optional subscribe to changes of submachines as well\n);\n\n\n// in react use useMemoizedSelector hook\n// this will cause the component to rerender if the selector is returning a new value\nmyActorContext.useMemoizedSelector('derivedView')\n```\n\n~This is using reselect to declare the dependencies similar to a react\nuseMemo hook - the actual selector will only run if the dependencies\nchange, leading to similar semantics as useMemo, with the additional\nbenefit that if the value is used in multiple places, it's still just\ncalculated once. The component calling `withMemoizedSelectors` only\nre-renders if the value returned by the selector changes. The selector\nitself only re-runs if one of the declared dependencies changes.~\n\n~Everything is type-safe by capturing the types of the reselect selector\nobject via inferred type param and using it in the `useMemoizedSelector`\ntype.~","sha":"c5e0b05454b124949de754556ec8ba5289445ab3"}},"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/213638","number":213638,"mergeCommit":{"message":"🌊 Streams: Selectors for derived samples (#213638)\n\nSimplified massively from first state and just plugging in reselect in\nplaces where that's suitable (here to calculate the currently relevant\nsample documents).\n\nAlso does a drive-by layout fix.\n\n~Introduces a new xstate helper for derived data.~\n\n~In most cases, the actor and state machine model of xstate is great,\nbut for derived data using pure functions, the semantics of the\n`useMemo` hook with defined dependencies is often easier to understand\nand eliminates the risk of forgetting to update the derived data\ncorrectly in some cases.~\n\n~It's about using the right tool for the right job - you don't need to\nchoose between the dependency list of useMemo and the actor model of\nxstate, you can use what fits the case, without compromising\nperformance.~\n\n~This is the API:~\n```ts\nconst myActorContext = withMemoizedSelectors(\n createActorContext(myMachine),\n {\n derivedView: createSelector(\n [\n (ctx: MyContextType) => {\n return ctx.dependency1;\n },\n (ctx: MyContextType) =>\n ctx.dependency2,\n ],\n (dependency1, dependency2) => {\n return // expensive calculation only running when necessary\n }\n ),\n },\n (context) => (context.subMachine ? [context.subMachine] : []) // optional subscribe to changes of submachines as well\n);\n\n\n// in react use useMemoizedSelector hook\n// this will cause the component to rerender if the selector is returning a new value\nmyActorContext.useMemoizedSelector('derivedView')\n```\n\n~This is using reselect to declare the dependencies similar to a react\nuseMemo hook - the actual selector will only run if the dependencies\nchange, leading to similar semantics as useMemo, with the additional\nbenefit that if the value is used in multiple places, it's still just\ncalculated once. The component calling `withMemoizedSelectors` only\nre-renders if the value returned by the selector changes. The selector\nitself only re-runs if one of the declared dependencies changes.~\n\n~Everything is type-safe by capturing the types of the reselect selector\nobject via inferred type param and using it in the `useMemoizedSelector`\ntype.~","sha":"c5e0b05454b124949de754556ec8ba5289445ab3"}},{"branch":"8.x","label":"v8.19.0","branchLabelMappingKey":"^v8.19.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}] BACKPORT--> Co-authored-by: Joe Reuter <johannes.reuter@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.