kibana/dev_docs/tutorials/performance
Kibana Machine caa3c71956
[8.x] [performance] support triggering subset of journeys against KIbana PR in CI (#193175) (#193680)
# Backport

This will backport the following commits from `main` to `8.x`:
- [[performance] support triggering subset of journeys against KIbana PR
in CI (#193175)](https://github.com/elastic/kibana/pull/193175)

<!--- Backport version: 9.4.3 -->

### 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-09-18T12:53:02Z","message":"[performance]
support triggering subset of journeys against KIbana PR in CI
(#193175)\n\n## Summary\r\n\r\nIt’s common request for Dev teams to run
specific journeys on a PR to\r\ncompare performance metrics against the
`main` branch. These requests\r\nusually focus on a particular area,
such as the Dashboard or Discover\r\napp.\r\n\r\nTo streamline the
process, this PR groups relevant journeys into\r\ncategories that can be
triggered through an environment variable. For\r\nexample, setting
`JOURNEYS_GROUP=dashboard` will execute only the
three\r\ndashboard-specific journeys, which are (usually) sufficient
for\r\nevaluating the performance impact of code changes within the
Dashboard\r\napp.\r\n\r\nCurrent Process for Triggering Performance
Builds:\r\n- Create a new
kibana-single-user-performance\r\n[build](https://buildkite.com/elastic/kibana-single-user-performance#new)\r\n-
Provide the following arguments:\r\n\r\nBranch:
`refs/pull/<PR_number>/head`\r\nUnder Options, set the environment
variable:\r\n`JOURNEYS_GROUP=<group_name>`\r\n\r\nCurrently supported
journey groups:\r\n- kibanaStartAndLoad\r\n- crud\r\n- dashboard\r\n-
discover\r\n- maps\r\n- ml\r\n\r\n[Build
example\r\n\r\n](https://buildkite.com/elastic/kibana-single-user-performance/builds/14427)\r\nEach
group focuses on a specific set of journeys tied to its
respective\r\narea in Kibana, allowing for more targeted performance
testing. Since\r\nrunning group takes ~5-10 min on bare metal worker, it
should not delay\r\nthe regular (every 3h) runs against `main`
branch\r\n\r\n\r\ntest locally with `node scripts/run_performance.js
--group
<group_name>`","sha":"f5975d28fa06d6de6193d5e518084c45c65b5aed","branchLabelMapping":{"^v9.0.0$":"main","^v8.16.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","v9.0.0","v8.16.0","backport:version"],"title":"[performance]
support triggering subset of journeys against KIbana PR in
CI","number":193175,"url":"https://github.com/elastic/kibana/pull/193175","mergeCommit":{"message":"[performance]
support triggering subset of journeys against KIbana PR in CI
(#193175)\n\n## Summary\r\n\r\nIt’s common request for Dev teams to run
specific journeys on a PR to\r\ncompare performance metrics against the
`main` branch. These requests\r\nusually focus on a particular area,
such as the Dashboard or Discover\r\napp.\r\n\r\nTo streamline the
process, this PR groups relevant journeys into\r\ncategories that can be
triggered through an environment variable. For\r\nexample, setting
`JOURNEYS_GROUP=dashboard` will execute only the
three\r\ndashboard-specific journeys, which are (usually) sufficient
for\r\nevaluating the performance impact of code changes within the
Dashboard\r\napp.\r\n\r\nCurrent Process for Triggering Performance
Builds:\r\n- Create a new
kibana-single-user-performance\r\n[build](https://buildkite.com/elastic/kibana-single-user-performance#new)\r\n-
Provide the following arguments:\r\n\r\nBranch:
`refs/pull/<PR_number>/head`\r\nUnder Options, set the environment
variable:\r\n`JOURNEYS_GROUP=<group_name>`\r\n\r\nCurrently supported
journey groups:\r\n- kibanaStartAndLoad\r\n- crud\r\n- dashboard\r\n-
discover\r\n- maps\r\n- ml\r\n\r\n[Build
example\r\n\r\n](https://buildkite.com/elastic/kibana-single-user-performance/builds/14427)\r\nEach
group focuses on a specific set of journeys tied to its
respective\r\narea in Kibana, allowing for more targeted performance
testing. Since\r\nrunning group takes ~5-10 min on bare metal worker, it
should not delay\r\nthe regular (every 3h) runs against `main`
branch\r\n\r\n\r\ntest locally with `node scripts/run_performance.js
--group
<group_name>`","sha":"f5975d28fa06d6de6193d5e518084c45c65b5aed"}},"sourceBranch":"main","suggestedTargetBranches":["8.x"],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","branchLabelMappingKey":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/193175","number":193175,"mergeCommit":{"message":"[performance]
support triggering subset of journeys against KIbana PR in CI
(#193175)\n\n## Summary\r\n\r\nIt’s common request for Dev teams to run
specific journeys on a PR to\r\ncompare performance metrics against the
`main` branch. These requests\r\nusually focus on a particular area,
such as the Dashboard or Discover\r\napp.\r\n\r\nTo streamline the
process, this PR groups relevant journeys into\r\ncategories that can be
triggered through an environment variable. For\r\nexample, setting
`JOURNEYS_GROUP=dashboard` will execute only the
three\r\ndashboard-specific journeys, which are (usually) sufficient
for\r\nevaluating the performance impact of code changes within the
Dashboard\r\napp.\r\n\r\nCurrent Process for Triggering Performance
Builds:\r\n- Create a new
kibana-single-user-performance\r\n[build](https://buildkite.com/elastic/kibana-single-user-performance#new)\r\n-
Provide the following arguments:\r\n\r\nBranch:
`refs/pull/<PR_number>/head`\r\nUnder Options, set the environment
variable:\r\n`JOURNEYS_GROUP=<group_name>`\r\n\r\nCurrently supported
journey groups:\r\n- kibanaStartAndLoad\r\n- crud\r\n- dashboard\r\n-
discover\r\n- maps\r\n- ml\r\n\r\n[Build
example\r\n\r\n](https://buildkite.com/elastic/kibana-single-user-performance/builds/14427)\r\nEach
group focuses on a specific set of journeys tied to its
respective\r\narea in Kibana, allowing for more targeted performance
testing. Since\r\nrunning group takes ~5-10 min on bare metal worker, it
should not delay\r\nthe regular (every 3h) runs against `main`
branch\r\n\r\n\r\ntest locally with `node scripts/run_performance.js
--group
<group_name>`","sha":"f5975d28fa06d6de6193d5e518084c45c65b5aed"}},{"branch":"8.x","label":"v8.16.0","branchLabelMappingKey":"^v8.16.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->

Co-authored-by: Dzmitry Lemechko <dzmitry.lemechko@elastic.co>
2024-09-23 05:04:15 -05:00
..
adding_api_capacity_test.mdx [docs] escape code with curly brackets to fix docs build 2023-01-18 13:16:07 -07:00
adding_custom_performance_metrics.mdx [StdPerf] kibana:plugin_render_time custom metrics documentation (#190421) 2024-08-26 13:00:05 +00:00
adding_performance_journey.mdx [8.x] [performance] support triggering subset of journeys against KIbana PR in CI (#193175) (#193680) 2024-09-23 05:04:15 -05:00
running_performance_journey_in_cloud.mdx chore(NA): rename journeys folder into journeys_e2e inside x-pack/performance to correctly classify journey e2e files (#178340) 2024-03-14 21:15:57 +00:00