kibana/dev_docs/tutorials/performance
Dzmitry Lemechko f5975d28fa
[performance] support triggering subset of journeys against KIbana PR in CI (#193175)
## Summary

It’s common request for Dev teams to run specific journeys on a PR to
compare performance metrics against the `main` branch. These requests
usually focus on a particular area, such as the Dashboard or Discover
app.

To streamline the process, this PR groups relevant journeys into
categories that can be triggered through an environment variable. For
example, setting `JOURNEYS_GROUP=dashboard` will execute only the three
dashboard-specific journeys, which are (usually) sufficient for
evaluating the performance impact of code changes within the Dashboard
app.

Current Process for Triggering Performance Builds:
- Create a new kibana-single-user-performance
[build](https://buildkite.com/elastic/kibana-single-user-performance#new)
- Provide the following arguments:

Branch: `refs/pull/<PR_number>/head`
Under Options, set the environment variable:
`JOURNEYS_GROUP=<group_name>`

Currently supported journey groups:
- kibanaStartAndLoad
- crud
- dashboard
- discover
- maps
- ml

[Build example

](https://buildkite.com/elastic/kibana-single-user-performance/builds/14427)
Each group focuses on a specific set of journeys tied to its respective
area in Kibana, allowing for more targeted performance testing. Since
running group takes ~5-10 min on bare metal worker, it should not delay
the regular (every 3h) runs against `main` branch


test locally with `node scripts/run_performance.js --group <group_name>`
2024-09-18 14:53:02 +02: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 [performance] support triggering subset of journeys against KIbana PR in CI (#193175) 2024-09-18 14:53:02 +02: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