mirror of
https://github.com/elastic/kibana.git
synced 2025-04-24 09:48:58 -04:00
Your window into the Elastic Stack
1c7e33a4c7
# Backport This will backport the following commits from `main` to `8.x`: - [[kbn-scout] initial package implementation (playwright-test POC) (#194006)](https://github.com/elastic/kibana/pull/194006) <!--- Backport version: 8.9.8 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport) <!--BACKPORT [{"author":{"name":"Dzmitry Lemechko","email":"dzmitry.lemechko@elastic.co"},"sourceCommit":{"committedDate":"2024-11-26T16:33:49Z","message":"[kbn-scout] initial package implementation (playwright-test POC) (#194006)\n\n## Summary\r\n\r\nThis PR introduces a new package, **kbn-scout**, designed to streamline\r\nthe setup and execution of Playwright tests for Kibana. The `kbn-scout`\r\npackage consolidates server management and testing capabilities by\r\nwrapping both the Kibana/Elasticsearch server launcher and the\r\nPlaywright test runner. It includes:\r\n\r\n- Test and worker-scoped fixtures for reliable setup across test suites\r\n- Page objects combined into the fixture for Kibana UI interactions\r\n- Configurations for seamless test execution in both local and CI\r\nenvironments (`Cloud` execution is out of scope)\r\n- This package aims to simplify test setup and enhance modularity,\r\nmaking it easier to create, run, and maintain deployment-agnostic tests,\r\nthat are located in the plugin they actually test.\r\n\r\nTests example is available in `x-pack/plugins/discover_enhanced` plugin\r\nunder `ui_tests` folder\r\n\r\nHow to run:\r\n1) As a single script (servers + tests): \r\n```\r\nnode scripts/scout_test.js --config=x-pack/plugins/discover_enhanced/ui_tests/playwright.config.ts --serverless=es\r\n```\r\n\r\n2) Start servers first\r\n```\r\nnode scripts/scout_start_servers.js --serverless=es\r\n```\r\nthen run tests:\r\n```\r\nnpx playwright test --config=x-pack/plugins/discover_enhanced/ui_tests/playwright.config.ts\r\n```\r\nif you have Playwright plugin in IDEA, just use it to run tests files\r\n\r\n---------\r\n\r\nCo-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>","sha":"310d922f137ed5c1117e2660ffa8af618810f350","branchLabelMapping":{"^v9.0.0$":"main","^v8.18.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","backport:skip","v9.0.0","test:scout"],"number":194006,"url":"https://github.com/elastic/kibana/pull/194006","mergeCommit":{"message":"[kbn-scout] initial package implementation (playwright-test POC) (#194006)\n\n## Summary\r\n\r\nThis PR introduces a new package, **kbn-scout**, designed to streamline\r\nthe setup and execution of Playwright tests for Kibana. The `kbn-scout`\r\npackage consolidates server management and testing capabilities by\r\nwrapping both the Kibana/Elasticsearch server launcher and the\r\nPlaywright test runner. It includes:\r\n\r\n- Test and worker-scoped fixtures for reliable setup across test suites\r\n- Page objects combined into the fixture for Kibana UI interactions\r\n- Configurations for seamless test execution in both local and CI\r\nenvironments (`Cloud` execution is out of scope)\r\n- This package aims to simplify test setup and enhance modularity,\r\nmaking it easier to create, run, and maintain deployment-agnostic tests,\r\nthat are located in the plugin they actually test.\r\n\r\nTests example is available in `x-pack/plugins/discover_enhanced` plugin\r\nunder `ui_tests` folder\r\n\r\nHow to run:\r\n1) As a single script (servers + tests): \r\n```\r\nnode scripts/scout_test.js --config=x-pack/plugins/discover_enhanced/ui_tests/playwright.config.ts --serverless=es\r\n```\r\n\r\n2) Start servers first\r\n```\r\nnode scripts/scout_start_servers.js --serverless=es\r\n```\r\nthen run tests:\r\n```\r\nnpx playwright test --config=x-pack/plugins/discover_enhanced/ui_tests/playwright.config.ts\r\n```\r\nif you have Playwright plugin in IDEA, just use it to run tests files\r\n\r\n---------\r\n\r\nCo-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>","sha":"310d922f137ed5c1117e2660ffa8af618810f350"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","labelRegex":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/194006","number":194006,"mergeCommit":{"message":"[kbn-scout] initial package implementation (playwright-test POC) (#194006)\n\n## Summary\r\n\r\nThis PR introduces a new package, **kbn-scout**, designed to streamline\r\nthe setup and execution of Playwright tests for Kibana. The `kbn-scout`\r\npackage consolidates server management and testing capabilities by\r\nwrapping both the Kibana/Elasticsearch server launcher and the\r\nPlaywright test runner. It includes:\r\n\r\n- Test and worker-scoped fixtures for reliable setup across test suites\r\n- Page objects combined into the fixture for Kibana UI interactions\r\n- Configurations for seamless test execution in both local and CI\r\nenvironments (`Cloud` execution is out of scope)\r\n- This package aims to simplify test setup and enhance modularity,\r\nmaking it easier to create, run, and maintain deployment-agnostic tests,\r\nthat are located in the plugin they actually test.\r\n\r\nTests example is available in `x-pack/plugins/discover_enhanced` plugin\r\nunder `ui_tests` folder\r\n\r\nHow to run:\r\n1) As a single script (servers + tests): \r\n```\r\nnode scripts/scout_test.js --config=x-pack/plugins/discover_enhanced/ui_tests/playwright.config.ts --serverless=es\r\n```\r\n\r\n2) Start servers first\r\n```\r\nnode scripts/scout_start_servers.js --serverless=es\r\n```\r\nthen run tests:\r\n```\r\nnpx playwright test --config=x-pack/plugins/discover_enhanced/ui_tests/playwright.config.ts\r\n```\r\nif you have Playwright plugin in IDEA, just use it to run tests files\r\n\r\n---------\r\n\r\nCo-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>","sha":"310d922f137ed5c1117e2660ffa8af618810f350"}}]}] 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.