# Backport
This will backport the following commits from `main` to `8.18`:
- [[Performance] Refactor TTFMP query `from`, `to` fields
(#213911)](https://github.com/elastic/kibana/pull/213911)
<!--- Backport version: 9.6.6 -->
### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sorenlouv/backport)
<!--BACKPORT [{"author":{"name":"Abdul Wahab
Zahid","email":"awahab07@yahoo.com"},"sourceCommit":{"committedDate":"2025-03-20T10:40:24Z","message":"[Performance]
Refactor TTFMP query `from`, `to` fields (#213911)\n\nCurrently Kibana
forwards `query_range_secs` and `query_offset_secs` to\nmark the
selected time range when reporting TTFMP event. This format\ncaused some
challenges to identify `from`, `to` date offsets
in\nvisualizations.\n\nTo simplify, the PR renames and sends the three
fields explicitly:\n- `query_from_offset_secs` offset to `0` (now), with
-ve for past and\n+ve for future dates\n- `query_to_offset_secs` offset
to `0` (now), with -ve for past and +ve\nfor future dates\n-
`query_range_secs` same as previously sent\n\n_This approach is followed
after a discussion, and based on
the\n[gist](https://gist.github.com/andrewvc/1f04a57a336d768e4ec5ff2eff06ba54)\nexcerpt:_\n\n```\nEarliest
date -> QueryFrom\nNewest date -> QueryTo\nDuration ->
QueryRange\n```\n\n### Indexing\nThese fields then should be mapped in
the EBT indexer to ingest in the\ntop level of the document, eventually
removing the need to create\nruntime fields in data views for
visualizations.\n\nAlso, runtime fields in data views should be updated
to reflect this\nchange. For backward compatibility, the runtime fields
can cater both\nthe old and new field names conditionally.\n\n###
Testing\n- Ensure that the TTFMP events are correctly reporting the date
ranges.\n\n###
Example\n\n","sha":"e6e78ac6d83fe9c4a83785c717fb1b7f3fedbf0e","branchLabelMapping":{"^v9.1.0$":"main","^v8.19.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","backport
missing","v9.1.0","v8.19.0"],"title":"[Performance] Refactor TTFMP query
`from`, `to`
fields","number":213911,"url":"https://github.com/elastic/kibana/pull/213911","mergeCommit":{"message":"[Performance]
Refactor TTFMP query `from`, `to` fields (#213911)\n\nCurrently Kibana
forwards `query_range_secs` and `query_offset_secs` to\nmark the
selected time range when reporting TTFMP event. This format\ncaused some
challenges to identify `from`, `to` date offsets
in\nvisualizations.\n\nTo simplify, the PR renames and sends the three
fields explicitly:\n- `query_from_offset_secs` offset to `0` (now), with
-ve for past and\n+ve for future dates\n- `query_to_offset_secs` offset
to `0` (now), with -ve for past and +ve\nfor future dates\n-
`query_range_secs` same as previously sent\n\n_This approach is followed
after a discussion, and based on
the\n[gist](https://gist.github.com/andrewvc/1f04a57a336d768e4ec5ff2eff06ba54)\nexcerpt:_\n\n```\nEarliest
date -> QueryFrom\nNewest date -> QueryTo\nDuration ->
QueryRange\n```\n\n### Indexing\nThese fields then should be mapped in
the EBT indexer to ingest in the\ntop level of the document, eventually
removing the need to create\nruntime fields in data views for
visualizations.\n\nAlso, runtime fields in data views should be updated
to reflect this\nchange. For backward compatibility, the runtime fields
can cater both\nthe old and new field names conditionally.\n\n###
Testing\n- Ensure that the TTFMP events are correctly reporting the date
ranges.\n\n###
Example\n\n","sha":"e6e78ac6d83fe9c4a83785c717fb1b7f3fedbf0e"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"main","label":"v9.1.0","branchLabelMappingKey":"^v9.1.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/213911","number":213911,"mergeCommit":{"message":"[Performance]
Refactor TTFMP query `from`, `to` fields (#213911)\n\nCurrently Kibana
forwards `query_range_secs` and `query_offset_secs` to\nmark the
selected time range when reporting TTFMP event. This format\ncaused some
challenges to identify `from`, `to` date offsets
in\nvisualizations.\n\nTo simplify, the PR renames and sends the three
fields explicitly:\n- `query_from_offset_secs` offset to `0` (now), with
-ve for past and\n+ve for future dates\n- `query_to_offset_secs` offset
to `0` (now), with -ve for past and +ve\nfor future dates\n-
`query_range_secs` same as previously sent\n\n_This approach is followed
after a discussion, and based on
the\n[gist](https://gist.github.com/andrewvc/1f04a57a336d768e4ec5ff2eff06ba54)\nexcerpt:_\n\n```\nEarliest
date -> QueryFrom\nNewest date -> QueryTo\nDuration ->
QueryRange\n```\n\n### Indexing\nThese fields then should be mapped in
the EBT indexer to ingest in the\ntop level of the document, eventually
removing the need to create\nruntime fields in data views for
visualizations.\n\nAlso, runtime fields in data views should be updated
to reflect this\nchange. For backward compatibility, the runtime fields
can cater both\nthe old and new field names conditionally.\n\n###
Testing\n- Ensure that the TTFMP events are correctly reporting the date
ranges.\n\n###
Example\n\n","sha":"e6e78ac6d83fe9c4a83785c717fb1b7f3fedbf0e"}},{"branch":"8.x","label":"v8.19.0","branchLabelMappingKey":"^v8.19.0$","isSourceBranch":false,"url":"https://github.com/elastic/kibana/pull/217090","number":217090,"state":"OPEN"},{"url":"https://github.com/elastic/kibana/pull/217089","number":217089,"branch":"9.0","state":"OPEN"}]}]
BACKPORT-->
# Backport
This will backport the following commits from `main` to `8.x`:
- [Fix typo in documentation
(#204814)](https://github.com/elastic/kibana/pull/204814)
<!--- Backport version: 9.4.3 -->
### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)
<!--BACKPORT
[{"author":{"name":"Katerina","email":"aikaterini.patticha@elastic.co"},"sourceCommit":{"committedDate":"2024-12-19T00:20:59Z","message":"Fix
typo in documentation (#204814)\n\nFix typo introduced in
https://github.com/elastic/kibana/pull/204179#pullrequestreview-2512105404","sha":"7d4bf216ab59258a1d26dfd6c240978b00027c87","branchLabelMapping":{"^v9.0.0$":"main","^v8.18.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","v9.0.0","backport:prev-minor"],"title":"Fix
typo in
documentation","number":204814,"url":"https://github.com/elastic/kibana/pull/204814","mergeCommit":{"message":"Fix
typo in documentation (#204814)\n\nFix typo introduced in
https://github.com/elastic/kibana/pull/204179#pullrequestreview-2512105404","sha":"7d4bf216ab59258a1d26dfd6c240978b00027c87"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","branchLabelMappingKey":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/204814","number":204814,"mergeCommit":{"message":"Fix
typo in documentation (#204814)\n\nFix typo introduced in
https://github.com/elastic/kibana/pull/204179#pullrequestreview-2512105404","sha":"7d4bf216ab59258a1d26dfd6c240978b00027c87"}}]}]
BACKPORT-->
Co-authored-by: Katerina <aikaterini.patticha@elastic.co>
# Backport
This will backport the following commits from `main` to `8.x`:
- [[Performance] Update `onPageReady` documentation
(#204179)](https://github.com/elastic/kibana/pull/204179)
<!--- Backport version: 9.4.3 -->
### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)
<!--BACKPORT
[{"author":{"name":"Katerina","email":"aikaterini.patticha@elastic.co"},"sourceCommit":{"committedDate":"2024-12-18T15:06:54Z","message":"[Performance]
Update `onPageReady` documentation (#204179)\n\n## Summary\r\nRelated to
this: https://github.com/elastic/kibana/pull/202889\r\n\r\nUpdate the
documentation with the recent
changes","sha":"860d5b6b3599dcdf1a090923224b5c315156c1a5","branchLabelMapping":{"^v9.0.0$":"main","^v8.18.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","v9.0.0","backport:prev-minor"],"title":"[Performance]
Update `onPageReady`
documentation","number":204179,"url":"https://github.com/elastic/kibana/pull/204179","mergeCommit":{"message":"[Performance]
Update `onPageReady` documentation (#204179)\n\n## Summary\r\nRelated to
this: https://github.com/elastic/kibana/pull/202889\r\n\r\nUpdate the
documentation with the recent
changes","sha":"860d5b6b3599dcdf1a090923224b5c315156c1a5"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","branchLabelMappingKey":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/204179","number":204179,"mergeCommit":{"message":"[Performance]
Update `onPageReady` documentation (#204179)\n\n## Summary\r\nRelated to
this: https://github.com/elastic/kibana/pull/202889\r\n\r\nUpdate the
documentation with the recent
changes","sha":"860d5b6b3599dcdf1a090923224b5c315156c1a5"}}]}]
BACKPORT-->
Co-authored-by: Katerina <aikaterini.patticha@elastic.co>
# 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>
## Summary
Moving synthtrace clients init inside kbn-journeys:
esArchiver does not always solve the issue with data generation. We
already have afew journeys using Synthtrace instead and expect more to
come.
In order to simplify the process of creating new journeys, this PR moves
Synthtrace client initialisation into kbn-journey package and exposes a
way to define client type, generator function & its input arguments:
```
import { Journey, SynthtraceOptions } from '@kbn/journeys';
import { subj } from '@kbn/test-subj-selector';
import { generateApmData } from '../synthtrace_data/apm_data';
export const journey = new Journey({
synthtrace: {
type: 'apm',
generator: generateApmData,
options: {
from: new Date(Date.now() - 1000 * 60 * 15),
to: new Date(Date.now() + 1000 * 60 * 15),
},
},
})
```
PR also needs review from teams who use Synthtrace to understand if the implementation is matching expectations.
---------
Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
The source code classifier we currently have was incorrectly classifying
e2e journey files as `non-package` instead of `tests or mocks` as it was
not using the name standards we used for FTR files.
We could have created a `functional-tests` package for the performance
folder (which is what we want to do in the future) but because we don't
have the feature to create ownerless packages it would not be easy to
find a given owner for that folder.
As such I'm just opting for a second solution which is applying the same
name standards to this journeys folder as we have for FTR and changing a
little the classifier to recognise it.
This should fix the problem found at
https://github.com/elastic/kibana/pull/178017.
Co-authored-by: Alex Szabo <alex.szabo@elastic.co>
## Summary
I had to change `waitForRender` since `page.waitForFunction` tries to
run a script on page and it is not working due to CSP settings on Cloud.
Instead of injecting a script, we use a classical API to find
elements/attributes in the DOM.
Since `PUT /internal/core/_settings` is merged in 8.11.0, journeys run
on Cloud with on-fly labels update is supported starting deployments
8.11.0+. I added error message for 404 code just in case someone runs it
on earlier version.
`many_fields_discover` journey was update since on Cloud the data view
used by scenario is not selected by default.
How it works:
Create a deployment with QAF and re-configure it for journey run:
```
export EC_DEPLOYMENT_NAME=my-run-8.11
qaf elastic-cloud deployments create --stack-version 8.11.0-SNAPSHOT --environment staging --region gcp-us-central1
qaf elastic-cloud deployments configure-for-performance-journeys
```
Run any journey, e.g. many_fields_discover
```
TEST_CLOUD=1 TEST_ES_URL=https://username:pswd@es_url:443 TEST_KIBANA_URL=https://username:pswd@kibana-ur_url node scripts/functional_test_runner --config x-pack/performance/journeys/many_fields_discover.ts
```
You should see a log about labels being updated:
```
Updating telemetry & APM labels: {"testJobId":"local-a3272047-6724-44d1-9a61-5c79781b06a1","testBuildId":"local-d8edbace-f441-4ba9-ac83-5909be3acf2a","journeyName":"many_fields_discover","ftrConfig":"x-pack/performance/journeys/many_fields_discover.ts"}
```
And then able to find APM logs for the journey in
[Ops](https://kibana-ops-e2e-perf.kb.us-central1.gcp.cloud.es.io:9243/app/apm/services?comparisonEnabled=true&environment=ENVIRONMENT_ALL&kuery=labels.testJobId%20%3A%20%22local-d79a878c-cc7a-423b-b884-c9b6b1a8d781%22&latencyAggregationType=avg&offset=1d&rangeFrom=now-24h%2Fh&rangeTo=now&serviceGroup=&transactionType=request)
cluster
## Summary
This PR adds changes and instructions how to run existing performance
journeys against ESS instances.
As previously discussed with @pheyos , there are few manual steps to be
done before running the actual journey:
1. Create cloud deployment and re-configure it the way APM traces are
reported the monitoring cluster
2. Check out the branch matching deployment version (main ->
8.9.0-SNAPSHOT), create user with `superuser` role (we don't test
functional features, only performance metrics)
Then you can run the journey like a regular cloud test suite:
```
export TEST_KIBANA_URL=https://<username>:<password>@<kibana_url>
export TEST_ES_URL=https://<username>:<password>@j<elasticsearch_url>:<port>
export TEST_CLOUD=1
node scripts/functional_test_runner.js --config x-pack/performance/journeys/$YOUR_JOURNEY_NAME.ts
```
<img width="1357" alt="image"
src="https://user-images.githubusercontent.com/10977896/236499836-2738fecb-a5a9-4e58-a10b-915b962af037.png">
---------
Co-authored-by: Jon <jon@budzenski.me>
This PR updates docs around Kibana performance effort:
- how to create single user performance journeys, custom metrics with
EBT and review test results
- how to create api capacity test and where to find its test results
