mirror of
https://github.com/elastic/kibana.git
synced 2025-06-27 10:40:07 -04:00
Your window into the Elastic Stack
ea18158480
## Summary
This pull request introduces a new feature to group dependency usage by
package directories, alongside existing options for grouping by owner or
source. It includes updates to the CLI, dependency graph logic, and new
utility functions and tests to support the feature.
### CLI updates:
* Enhanced the `group-by` option in `configureYargs` to allow grouping
by `package` in addition to `owner` and `source`.
(`packages/kbn-dependency-usage/src/cli.ts`,
[packages/kbn-dependency-usage/src/cli.tsL50-R51](diffhunk://#diff-ef89f6725b6dde85fbfea1050625607f583373da328165c575070f0579e5f23aL50-R51))
### Dependency graph logic:
* Added the `groupByPackage` function to group dependencies by package
directories, and integrated it into the
`identifyDependencyUsageWithCruiser` method.
(`packages/kbn-dependency-usage/src/dependency_graph/providers/cruiser.ts`,
[[1]](diffhunk://#diff-19e7d98370cc898df6e0a28a61575490b35a0ff6013a8c5080aa8c9fa0065e71R17)
[[2]](diffhunk://#diff-19e7d98370cc898df6e0a28a61575490b35a0ff6013a8c5080aa8c9fa0065e71R120-R123)
### Utility functions:
* Implemented `groupByPackage` utility to identify package directories
based on the presence of `kibana.jsonc` files and group dependencies
accordingly.
(`packages/kbn-dependency-usage/src/lib/group_by_package.ts`,
[packages/kbn-dependency-usage/src/lib/group_by_package.tsR1-R80](diffhunk://#diff-4e2be55a320215ee636cd352393c09c0e90524a5b6121b034d1360a6afed4d67R1-R80))
### Unit tests:
* Added comprehensive tests for `groupByPackage`, covering scenarios
such as nested directories, missing package files, and handling of empty
dependencies.
(`packages/kbn-dependency-usage/src/lib/group_by_package.test.ts`,
[packages/kbn-dependency-usage/src/lib/group_by_package.test.tsR1-R231](diffhunk://#diff-69398d48b1e5a2ea0ed52ca35fc2d877e143a6dcefd71d2399931ba242b962b5R1-R231))
### Example usage
```sh
(base) ➜ kibana git:(dep-usage/group-by-package) ✗ ./scripts/dependency_usage.sh -c 20 -g package -p x-pack/solutions/security
Searching for dependencies in paths: x-pack/solutions/security
Dependencies will be collapsed to depth: 20
cruiser is used for building dependency graph
Successfully built dependency graph using cruiser. Analyzing...
No output file specified, displaying results below:
{
"x-pack/solutions/security/packages/connectors": [
"minimatch",
"@elastic/eui",
"@emotion/react",
"@testing-library/react",
"react",
"lodash"
],
"x-pack/solutions/security/packages/data-stream-adapter": [
"lodash"
],
"x-pack/solutions/security/packages/data-table": [
"io-ts",
"enzyme",
"lodash",
"react",
"@elastic/eui",
"@hello-pangea/dnd",
"@tanstack/react-query",
"react-redux",
"redux",
"styled-components",
"@testing-library/react",
"memoize-one",
"typescript-fsa",
"typescript-fsa-reducers",
"reselect"
],
"x-pack/solutions/security/packages/distribution-bar": [
"@elastic/eui",
"react",
"@testing-library/react",
"@elastic/numeral",
"@emotion/react"
],
"x-pack/solutions/security/packages/ecs-data-quality-dashboard": [
"minimatch",
"react",
"@testing-library/react",
"@testing-library/user-event",
"@elastic/eui",
"@emotion/react",
"@elastic/ecs",
"@elastic/numeral",
"lodash",
"@emotion/styled",
"moment-timezone",
"moment",
"@elastic/charts",
"uuid",
"@tanstack/react-query",
"rxjs",
"@testing-library/jest-dom"
],
"x-pack/solutions/security/packages/expandable-flyout": [
"@testing-library/react",
"react",
"@elastic/eui",
"@emotion/react",
"lodash",
"@testing-library/user-event",
"@emotion/css",
"react-router-dom",
"rxjs",
"react-redux",
"@reduxjs/toolkit",
"react-fast-compare",
"reselect"
],
"x-pack/solutions/security/packages/features": [
"minimatch"
],
"x-pack/solutions/security/packages/index-adapter": [
"@elastic/elasticsearch",
"lodash",
"@elastic/ecs",
"rxjs"
],
"x-pack/solutions/security/packages/kbn-cloud-security-posture/graph": [
"babel-jest",
"@emotion/react",
"react",
"@storybook/addon-actions",
"rxjs",
"@tanstack/react-query",
"webpack-merge",
"@storybook/manager-api",
"@storybook/theming",
"@testing-library/jest-dom",
"@elastic/eui",
"@testing-library/react",
"react-use",
"@xyflow/react",
"lodash",
"@emotion/styled",
"polished",
"@storybook/react",
"@testing-library/user-event",
"expect",
"@dagrejs/dagre"
],
"x-pack/solutions/security/packages/kbn-cloud-security-posture/public": [
"@elastic/eui",
"@emotion/react",
"react",
"react-dom",
"@testing-library/react",
"@tanstack/react-query",
"rxjs",
"react-router-dom"
],
"x-pack/solutions/security/packages/kbn-securitysolution-autocomplete": [
"@testing-library/jest-dom",
"@testing-library/react",
"react",
"@elastic/eui",
"enzyme",
"lodash",
"moment"
],
"x-pack/solutions/security/packages/kbn-securitysolution-exception-list-components": [
"@testing-library/jest-dom",
"@testing-library/react",
"react",
"@elastic/eui",
"@emotion/react",
"@emotion/css",
"@emotion/styled"
],
"x-pack/solutions/security/packages/kbn-securitysolution-hook-utils": [
"@testing-library/react",
"react",
"rxjs"
],
"x-pack/solutions/security/packages/kbn-securitysolution-io-ts-alerting-types": [
"io-ts",
"fp-ts",
"uuid"
],
"x-pack/solutions/security/packages/kbn-securitysolution-io-ts-list-types": [
"fp-ts",
"io-ts"
],
"x-pack/solutions/security/packages/kbn-securitysolution-list-api": [
"fp-ts"
],
"x-pack/solutions/security/packages/kbn-securitysolution-list-hooks": [
"fp-ts",
"react",
"@tanstack/react-query",
"@testing-library/react"
],
"x-pack/solutions/security/packages/kbn-securitysolution-list-utils": [
"lodash",
"uuid"
],
"x-pack/solutions/security/packages/kbn-securitysolution-t-grid": [
"lodash"
],
"x-pack/solutions/security/packages/kbn-securitysolution-utils": [
"uuid",
"axios",
"p-limit"
],
"x-pack/solutions/security/packages/navigation": [
"minimatch",
"react",
"@elastic/eui",
"@emotion/react",
"@testing-library/react"
],
"x-pack/solutions/security/packages/side-nav": [
"minimatch",
"@elastic/eui",
"@emotion/react",
"react",
"@emotion/css",
"@testing-library/react",
"classnames",
"@testing-library/user-event",
"lodash"
],
"x-pack/solutions/security/packages/storybook/config": [
"@storybook/addon-actions",
"@storybook/manager-api",
"@storybook/theming",
"jest-mock"
],
"x-pack/solutions/security/packages/upselling": [
"minimatch",
"@elastic/eui",
"react",
"@testing-library/react",
"@emotion/react",
"@emotion/styled",
"rxjs"
],
"x-pack/solutions/security/plugins/cloud_security_posture": [
"react",
"@testing-library/react",
"history",
"@tanstack/react-query",
"react-router-dom",
"@elastic/eui",
"@emotion/react",
"lodash",
"react-use",
"chance",
"@emotion/css",
"uuid",
"@testing-library/user-event",
"semver",
"@testing-library/jest-dom",
"moment",
"@elastic/charts",
"msw",
"rxjs",
"io-ts",
"@testing-library/dom",
"@elastic/elasticsearch"
],
"x-pack/solutions/security/plugins/ecs_data_quality_dashboard": [
"minimatch",
"rxjs",
"moment-timezone",
"fp-ts",
"io-ts"
],
"x-pack/solutions/security/plugins/elastic_assistant": [
"@elastic/elasticsearch",
"axios",
"p-limit",
"yargs",
"@langchain/core",
"langchain",
"globby",
"uuid",
"lodash",
"p-retry",
"rxjs",
"js-yaml",
"langsmith",
"@langchain/langgraph",
"moment",
"@elastic/ecs",
"p-map",
"@testing-library/react",
"elastic-apm-node",
"moment-timezone",
"expect"
],
"x-pack/solutions/security/plugins/lists": [
"moment",
"react",
"@elastic/eui",
"enzyme",
"styled-components",
"@storybook/addon-actions",
"@testing-library/react",
"fast-deep-equal",
"@tanstack/react-query",
"uuid",
"lodash",
"io-ts",
"fp-ts",
"elastic-apm-node",
"sinon",
"@hapi/boom",
"mustache",
"p-retry"
],
"x-pack/solutions/security/plugins/security_solution_ess": [
"react",
"rxjs",
"@testing-library/react",
"@elastic/eui"
],
"x-pack/solutions/security/plugins/security_solution_serverless": [
"react",
"@elastic/eui",
"@emotion/react",
"@testing-library/react",
"rxjs",
"@emotion/styled",
"chance",
"lodash",
"node-fetch"
],
"x-pack/solutions/security/plugins/security_solution": [
"lodash",
"io-ts",
"fp-ts",
"seedrandom",
"uuid",
"semver",
"moment",
"axios",
"ipaddr.js",
"rxjs",
"@emotion/react",
"@elastic/eui",
"react",
"copy-to-clipboard",
"@testing-library/react",
"react-router-dom",
"react-redux",
"react-use",
"react-reverse-portal",
"styled-components",
"react-dom",
"@elastic/charts",
"@testing-library/user-event",
"@tanstack/react-query",
"@testing-library/dom",
"@emotion/css",
"@testing-library/jest-dom",
"remark-parse-no-trim",
"unified",
"@emotion/styled",
"react-router-dom-v5-compat",
"d3",
"minimatch",
"enzyme",
"deepmerge",
"fast-deep-equal",
"@emotion/jest",
"@elastic/numeral",
"polished",
"@hello-pangea/dnd",
"use-resize-observer",
"jest-styled-components",
"moment-timezone",
"classnames",
"react-hook-form",
"query-string",
"fetch-mock",
"@storybook/addon-actions",
"react-markdown",
"reselect",
"redux",
"mustache",
"memoize-one",
"history",
"react-router",
"typescript-fsa",
"typescript-fsa-reducers",
"@reduxjs/toolkit",
"immer",
"reduce-reducers",
"redux-devtools-extension",
"redux-thunk",
"@formatjs/intl-utils",
"react-diff-view",
"unidiff",
"diff",
"json-stable-stringify",
"sinon",
"dedent",
"object-hash",
"papaparse",
"d3-scale",
"i18n-iso-countries",
"@elastic/ecs",
"@cypress/grep",
"cypress-data-session",
"cypress-recurse",
"execa",
"p-retry",
"@cypress/debugging-proxy",
"p-map",
"pretty-ms",
"@elastic/apm-rum",
"ts-easing",
"rbush",
"suricata-sid-db",
"react-window",
"formik",
"extract-zip",
"js-yaml",
"tar",
"chalk",
"@hapi/hapi",
"node-fetch",
"strip-ansi",
"inquirer",
"@elastic/elasticsearch",
"yargs",
"minimist",
"del",
"globby",
"xml2js",
"@langchain/core",
"cypress",
"find-cypress-specs",
"cli-table3",
"@babel/generator",
"@babel/parser",
"@langchain/langgraph",
"langchain",
"node-diff3",
"snakecase-keys",
"@hapi/boom",
"elastic-apm-node",
"set-value",
"murmurhash",
"js-sha256",
"fastest-levenshtein",
"langsmith",
"adm-zip",
"camelcase-keys"
],
"x-pack/solutions/security/plugins/session_view": [
"react",
"@elastic/eui",
"@emotion/react",
"@testing-library/user-event",
"@testing-library/react",
"lodash",
"uuid",
"memoize-one",
"@tanstack/react-query",
"byte-size",
"react-use",
"xterm",
"use-resize-observer",
"strip-ansi",
"history"
],
"x-pack/solutions/security/test": [
"moment",
"chance",
"lodash",
"expect",
"fast-deep-equal",
"@mswjs/http-middleware",
"msw",
"uuid"
]
}
```
---------
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 | ||
| 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 | ||
| updatecli-compose.yaml | ||
| 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.