mirror of
https://github.com/elastic/kibana.git
synced 2025-04-25 02:09:32 -04:00
2089267d9d
# Backport This will backport the following commits from `main` to `8.x`: - [@kbn/profiler-cli: collect and display CPU profiles (#216356)](https://github.com/elastic/kibana/pull/216356) <!--- Backport version: 9.6.6 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sorenlouv/backport) <!--BACKPORT [{"author":{"name":"Dario Gieselaar","email":"dario.gieselaar@elastic.co"},"sourceCommit":{"committedDate":"2025-04-02T06:47:33Z","message":"@kbn/profiler-cli: collect and display CPU profiles (#216356)\n\n# @kbn/profiler-cli\n\nProfile Kibana while it's running, and open the CPU profile in\nSpeedscope.\n\n## Usage\n\nRun a command by either preceding it with the profiler script:\n`node scripts/profile.js -- $command`\n\nOr by piping it in:\n`$command | node scripts/profile.js`\n\nYou can also just run it until SIGINT:\n\n`node scripts/profile.js`\n\nOr with a timeout:\n\n`node scripts/profile.js --timeout=10000`\n\n## Examples\n\n### Commands\n\nYou can copy a curl request from the browser, and place it after the\ncommand:\n\n`node scripts/profile.js --connections=10 --amount=50 -- curl ...`\n\nYou can also use stdin for this, for example:\n\n`pbpaste | node scripts/profile.js`\n\nWhen using stdin, take into consideration that there is some lag between\nstarting the script and connecting the profiler, so the profiler might\nmiss the first second or so of the running process.\n\nYou can also use any other command, like `autocannon`, `sleep` or\n`xargs`.\n\n### SigInt\n\nBy default, the profiler will run until the process exits:`node\nscripts/profile.js`. This is useful when you have a long running process\nrunning separately and you want to collect the profile over a longer\ntime period. Be aware that this might cause memory issues because the\nprofile will get huge. When you press Cmd+C, the profiler will\ngracefully exit and first write the profile to disk and open Speedscope.\n\n---------\n\nCo-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>","sha":"d1493b98e71db3a66014e29ba3264fcf21155f2e","branchLabelMapping":{"^v9.1.0$":"main","^v8.19.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","backport:version","v9.1.0","v8.19.0"],"title":"@kbn/profiler-cli: collect and display CPU profiles","number":216356,"url":"https://github.com/elastic/kibana/pull/216356","mergeCommit":{"message":"@kbn/profiler-cli: collect and display CPU profiles (#216356)\n\n# @kbn/profiler-cli\n\nProfile Kibana while it's running, and open the CPU profile in\nSpeedscope.\n\n## Usage\n\nRun a command by either preceding it with the profiler script:\n`node scripts/profile.js -- $command`\n\nOr by piping it in:\n`$command | node scripts/profile.js`\n\nYou can also just run it until SIGINT:\n\n`node scripts/profile.js`\n\nOr with a timeout:\n\n`node scripts/profile.js --timeout=10000`\n\n## Examples\n\n### Commands\n\nYou can copy a curl request from the browser, and place it after the\ncommand:\n\n`node scripts/profile.js --connections=10 --amount=50 -- curl ...`\n\nYou can also use stdin for this, for example:\n\n`pbpaste | node scripts/profile.js`\n\nWhen using stdin, take into consideration that there is some lag between\nstarting the script and connecting the profiler, so the profiler might\nmiss the first second or so of the running process.\n\nYou can also use any other command, like `autocannon`, `sleep` or\n`xargs`.\n\n### SigInt\n\nBy default, the profiler will run until the process exits:`node\nscripts/profile.js`. This is useful when you have a long running process\nrunning separately and you want to collect the profile over a longer\ntime period. Be aware that this might cause memory issues because the\nprofile will get huge. When you press Cmd+C, the profiler will\ngracefully exit and first write the profile to disk and open Speedscope.\n\n---------\n\nCo-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>","sha":"d1493b98e71db3a66014e29ba3264fcf21155f2e"}},"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/216356","number":216356,"mergeCommit":{"message":"@kbn/profiler-cli: collect and display CPU profiles (#216356)\n\n# @kbn/profiler-cli\n\nProfile Kibana while it's running, and open the CPU profile in\nSpeedscope.\n\n## Usage\n\nRun a command by either preceding it with the profiler script:\n`node scripts/profile.js -- $command`\n\nOr by piping it in:\n`$command | node scripts/profile.js`\n\nYou can also just run it until SIGINT:\n\n`node scripts/profile.js`\n\nOr with a timeout:\n\n`node scripts/profile.js --timeout=10000`\n\n## Examples\n\n### Commands\n\nYou can copy a curl request from the browser, and place it after the\ncommand:\n\n`node scripts/profile.js --connections=10 --amount=50 -- curl ...`\n\nYou can also use stdin for this, for example:\n\n`pbpaste | node scripts/profile.js`\n\nWhen using stdin, take into consideration that there is some lag between\nstarting the script and connecting the profiler, so the profiler might\nmiss the first second or so of the running process.\n\nYou can also use any other command, like `autocannon`, `sleep` or\n`xargs`.\n\n### SigInt\n\nBy default, the profiler will run until the process exits:`node\nscripts/profile.js`. This is useful when you have a long running process\nrunning separately and you want to collect the profile over a longer\ntime period. Be aware that this might cause memory issues because the\nprofile will get huge. When you press Cmd+C, the profiler will\ngracefully exit and first write the profile to disk and open Speedscope.\n\n---------\n\nCo-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>","sha":"d1493b98e71db3a66014e29ba3264fcf21155f2e"}},{"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> |
||
|---|---|---|
| .. | ||
| codeql | ||
| archive_migration_functions.sh | ||
| backport.js | ||
| build.js | ||
| build_api_docs.js | ||
| build_kibana_platform_plugins.js | ||
| build_plugin_list_docs.js | ||
| build_product_doc_artifacts.js | ||
| capture_oas_snapshot.js | ||
| check_file_casing.js | ||
| check_ftr_code_owners.js | ||
| check_ftr_configs.js | ||
| check_jest_configs.js | ||
| check_licenses.js | ||
| check_mappings_update.js | ||
| check_prod_native_modules.js | ||
| chromium_version.js | ||
| classify_source.js | ||
| create_observability_rules.js | ||
| delete_kibana_indices.sh | ||
| dependency_usage.sh | ||
| dev_docs.sh | ||
| docs.js | ||
| download_pr_list.js | ||
| enabled_ftr_configs.js | ||
| es.js | ||
| es_archiver.js | ||
| eslint.js | ||
| eslint_with_types.js | ||
| extract_performance_testing_dataset.js | ||
| find_babel_runtime_helpers_in_use.js | ||
| find_node_libs_browser_polyfills_in_use.js | ||
| functional_test_runner.js | ||
| functional_tests.js | ||
| functional_tests_server.js | ||
| generate.js | ||
| generate_console_definitions.js | ||
| generate_openapi.js | ||
| generate_plugin.js | ||
| generate_team_assignments.js | ||
| i18n_check.js | ||
| i18n_extract.js | ||
| i18n_integrate.js | ||
| ingest_coverage.js | ||
| jest.js | ||
| jest_integration.js | ||
| kbn.js | ||
| kbn_archiver.js | ||
| kibana.js | ||
| kibana_encryption_keys.js | ||
| kibana_keystore.js | ||
| kibana_plugin.js | ||
| kibana_setup.js | ||
| kibana_verification_code.js | ||
| licenses_csv_report.js | ||
| lint_packages.js | ||
| lint_ts_projects.js | ||
| makelogs.js | ||
| manifest.js | ||
| notice.js | ||
| plugin_check.js | ||
| plugin_helpers.js | ||
| precommit_hook.js | ||
| prettier_topology_check.js | ||
| profile.js | ||
| quick_checks.js | ||
| read_jest_help.mjs | ||
| README.md | ||
| register_git_hook.js | ||
| relocate.js | ||
| report_failed_tests.js | ||
| report_performance_metrics.js | ||
| rewrite_buildkite_definitions.js | ||
| run_performance.js | ||
| run_scalability.js | ||
| saved_objs_info.js | ||
| scout.js | ||
| ship_ci_stats.js | ||
| snapshot_plugin_types.js | ||
| spec_to_console.js | ||
| storybook.js | ||
| styled_components_mapping.js | ||
| stylelint.js | ||
| synthtrace.js | ||
| telemetry_check.js | ||
| telemetry_extract.js | ||
| test_hardening.js | ||
| type_check.js | ||
| update_prs.js | ||
| update_vscode_config.js | ||
| validate_next_docs.js | ||
| whereis_pkg.js | ||
| yarn_deduplicate.js | ||
Kibana Dev Scripts
This directory contains scripts useful for interacting with Kibana tools in development. Use the node executable and --help flag to learn about how they work:
node scripts/{{script name}} --help
For Developers
This directory is excluded from the build and tools within it should help users discover their capabilities. Each script in this directory must:
- require
src/setup_node_envto bootstrap NodeJS environment - call out to source code in the
srcorpackagesdirectories - react to the
--helpflag - run everywhere OR check and fail fast when a required OS or toolchain is not available
Functional Test Scripts
node scripts/functional_tests [--config src/platform/test/functional/config.base.js --config test/api_integration/config.js]
Runs all the functional tests: selenium tests and api integration tests. List configs with multiple --config arguments. Uses the @kbn/test library to run Elasticsearch and Kibana servers and tests against those servers, for multiple server+test setups. In particular, calls out to runTests(). Can be run on a single config.
node scripts/functional_tests_server [--config src/platform/test/functional/config.base.js]
Starts just the Elasticsearch and Kibana servers given a single config, i.e. via --config src/platform/test/functional/config.base.js or --config test/api_integration/config. Allows the user to start just the servers with this script, and keep them running while running tests against these servers. The idea is that the same config file configures both Elasticsearch and Kibana servers. Uses the startServers() method from @kbn/test library.
Example. Start servers and run tests, separately, but using the same config:
# Just the servers
node scripts/functional_tests_server --config path/to/config
In another terminal:
# Just the tests--against the running servers
node scripts/functional_test_runner --config path/to/config
For details on how the internal methods work, read this readme.
ES archiver
Loading data
If you wish to load up specific es archived data for your test, you can do so via:
node scripts/es_archiver.js load <archive> [--es-url=http://username:password@localhost:9200] [--kibana-url=http://username:password@localhost:5601/{basepath?}]
That will load the specified archive located in the archive directory specified by the default functional config file, located in src/platform/test/functional/config.base.js. To load archives from other function config files you can pass --config path/to/config.js.
Note: The --es-url and --kibana-url options may or may not be neccessary depending on your current Kibana configuration settings, and their values
may also change based on those settings (for example if you are not running with security you will not need the username:password portion).
Saving data
You can save existing data into an archive by using the save command:
node scripts/es_archiver.js save <archive name for kibana data> [space separated list of index patterns to include]
You may want to store the .kibana index separate from data. Since adding a lot of data will bloat our repo size, we have many tests that reuse the same
data indices but use their own .kibana index.