[performance] enable journey run against cloud deployments #156720
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
b1a469f to
ed0cb0c
Compare
ed0cb0c to
a4eb7bb
Compare
jbudz
reviewed
May 5, 2023
dev_docs/tutorials/performance/running_performance_journey_in_cloud.mdx
Outdated
Show resolved
Hide resolved
jbudz
reviewed
May 5, 2023
dev_docs/tutorials/performance/running_performance_journey_in_cloud.mdx
Outdated
Show resolved
Hide resolved
…cloud.mdx Co-authored-by: Jon <jon@budzenski.me>
💚 Build Succeeded
Metrics [docs]Unknown metric groupsESLint disabled line counts
Total ESLint disabled count
History
To update your PR or re-run it, just comment with: |
jbudz
approved these changes
May 8, 2023
wwang500
approved these changes
May 9, 2023
| As a way to better understand user experience with Kibana in cloud, we support running performance journeys against | ||
| Cloud deployments. | ||
| The process takes a few steps: | ||
| - Create a cloud deployment |
There was a problem hiding this comment.
Is there a minimum setting (RAM/zones) for Kibana? or the default kibana setting enough?
There was a problem hiding this comment.
I think deployment size is up to each team to decide as we probably would like to test different ones and compare. We might define some defaults later.
| Save changes and make sure cluster is restarted successfully. | ||
|
|
||
| #### Change Kibana configuration | ||
| Navigate to `Advanced Edit` page and change `Deployment Configuration` by adding the following JSON object to `resources.kibana.plan.kibana`: |
There was a problem hiding this comment.
"Advanced Edit" link wont be visible until "Edit" button is clicked. we could start the sentence like:
Navigate to Edit-> Advanced Edit page ...
| Secret: <SECRET_TOKEN> | ||
| ``` | ||
|
|
||
| Navigate to `Advanced Edit` page and change `Deployment Configuration` by adding the following JSON object to `resources.elasticsearch.plan.elasticsearch`: |
There was a problem hiding this comment.
"Advanced Edit" link wont be visible until "Edit" button is clicked. we could start the sentence like:
Navigate to Edit-> Advanced Edit page ...
|
|
||
| Note: DEPLOYMENT_ID and YOUR_JOURNEY_NAME values are optional labels to find the APM traces for your run. | ||
|
|
||
| Save changes and make sure cluster is restarted successfully. |
There was a problem hiding this comment.
Can the above kibana and elastic settings be changed together? In such way, the cluster is only needed to be restarted once.
There was a problem hiding this comment.
Yes, it is. Originally I thought it is easier to re-configure in steps to check if deployment still healthy. But since it is expected to work, I agree we better do it with 1 step and only single deployment restart makes things faster.
kibanamachine
pushed a commit
to kibanamachine/kibana
that referenced
this pull request
May 9, 2023
…56720) ## 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> (cherry picked from commit e55a92e)
kibanamachine
pushed a commit
to kibanamachine/kibana
that referenced
this pull request
May 9, 2023
…56720) ## 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> (cherry picked from commit e55a92e)
💚 All backports created successfully
Note: Successful backport PRs will be merged automatically after passing CI. Questions ?Please refer to the Backport tool documentation |
kibanamachine
added a commit
that referenced
this pull request
May 9, 2023
…6720) (#157122) # Backport This will backport the following commits from `main` to `8.7`: - [[performance] enable journey run against cloud deployments (#156720)](#156720) <!--- Backport version: 8.9.7 --> ### 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":"2023-05-09T03:35:43Z","message":"[performance] enable journey run against cloud deployments (#156720)\n\n## Summary\r\n\r\nThis PR adds changes and instructions how to run existing performance\r\njourneys against ESS instances.\r\n\r\nAs previously discussed with @pheyos , there are few manual steps to be\r\ndone before running the actual journey:\r\n1. Create cloud deployment and re-configure it the way APM traces are\r\nreported the monitoring cluster\r\n2. Check out the branch matching deployment version (main ->\r\n8.9.0-SNAPSHOT), create user with `superuser` role (we don't test\r\nfunctional features, only performance metrics)\r\n\r\nThen you can run the journey like a regular cloud test suite:\r\n```\r\nexport TEST_KIBANA_URL=https://<username>:<password>@<kibana_url>\r\nexport TEST_ES_URL=https://<username>:<password>@j<elasticsearch_url>:<port>\r\nexport TEST_CLOUD=1\r\nnode scripts/functional_test_runner.js --config x-pack/performance/journeys/$YOUR_JOURNEY_NAME.ts\r\n```\r\n\r\n<img width=\"1357\" alt=\"image\"\r\nsrc=\"https://user-images.githubusercontent.com/10977896/236499836-2738fecb-a5a9-4e58-a10b-915b962af037.png\">\r\n\r\n---------\r\n\r\nCo-authored-by: Jon <jon@budzenski.me>","sha":"e55a92eab0ae28799b51238fb76efa6026673e6e","branchLabelMapping":{"^v8.9.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","wg:performance","v8.7.2","v8.9.0","v8.8.1"],"number":156720,"url":"https://github.com/elastic/kibana/pull/156720","mergeCommit":{"message":"[performance] enable journey run against cloud deployments (#156720)\n\n## Summary\r\n\r\nThis PR adds changes and instructions how to run existing performance\r\njourneys against ESS instances.\r\n\r\nAs previously discussed with @pheyos , there are few manual steps to be\r\ndone before running the actual journey:\r\n1. Create cloud deployment and re-configure it the way APM traces are\r\nreported the monitoring cluster\r\n2. Check out the branch matching deployment version (main ->\r\n8.9.0-SNAPSHOT), create user with `superuser` role (we don't test\r\nfunctional features, only performance metrics)\r\n\r\nThen you can run the journey like a regular cloud test suite:\r\n```\r\nexport TEST_KIBANA_URL=https://<username>:<password>@<kibana_url>\r\nexport TEST_ES_URL=https://<username>:<password>@j<elasticsearch_url>:<port>\r\nexport TEST_CLOUD=1\r\nnode scripts/functional_test_runner.js --config x-pack/performance/journeys/$YOUR_JOURNEY_NAME.ts\r\n```\r\n\r\n<img width=\"1357\" alt=\"image\"\r\nsrc=\"https://user-images.githubusercontent.com/10977896/236499836-2738fecb-a5a9-4e58-a10b-915b962af037.png\">\r\n\r\n---------\r\n\r\nCo-authored-by: Jon <jon@budzenski.me>","sha":"e55a92eab0ae28799b51238fb76efa6026673e6e"}},"sourceBranch":"main","suggestedTargetBranches":["8.7","8.8"],"targetPullRequestStates":[{"branch":"8.7","label":"v8.7.2","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v8.9.0","labelRegex":"^v8.9.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/156720","number":156720,"mergeCommit":{"message":"[performance] enable journey run against cloud deployments (#156720)\n\n## Summary\r\n\r\nThis PR adds changes and instructions how to run existing performance\r\njourneys against ESS instances.\r\n\r\nAs previously discussed with @pheyos , there are few manual steps to be\r\ndone before running the actual journey:\r\n1. Create cloud deployment and re-configure it the way APM traces are\r\nreported the monitoring cluster\r\n2. Check out the branch matching deployment version (main ->\r\n8.9.0-SNAPSHOT), create user with `superuser` role (we don't test\r\nfunctional features, only performance metrics)\r\n\r\nThen you can run the journey like a regular cloud test suite:\r\n```\r\nexport TEST_KIBANA_URL=https://<username>:<password>@<kibana_url>\r\nexport TEST_ES_URL=https://<username>:<password>@j<elasticsearch_url>:<port>\r\nexport TEST_CLOUD=1\r\nnode scripts/functional_test_runner.js --config x-pack/performance/journeys/$YOUR_JOURNEY_NAME.ts\r\n```\r\n\r\n<img width=\"1357\" alt=\"image\"\r\nsrc=\"https://user-images.githubusercontent.com/10977896/236499836-2738fecb-a5a9-4e58-a10b-915b962af037.png\">\r\n\r\n---------\r\n\r\nCo-authored-by: Jon <jon@budzenski.me>","sha":"e55a92eab0ae28799b51238fb76efa6026673e6e"}},{"branch":"8.8","label":"v8.8.1","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"}]}] BACKPORT--> Co-authored-by: Dzmitry Lemechko <dzmitry.lemechko@elastic.co>
![https://user-images.githubusercontent.com/10977896/236499836-2738fecb-a5a9-4e58-a10b-915b962af037.png\">\r\n\r\n---------\r\n\r\nCo-authored-by](https://user-images.githubusercontent.com/10977896/236499836-2738fecb-a5a9-4e58-a10b-915b962af037.png\">\r\n\r\n---------\r\n\r\nCo-authored-by){kind=link}
kibanamachine
added a commit
that referenced
this pull request
May 9, 2023
…6720) (#157123) # Backport This will backport the following commits from `main` to `8.8`: - [[performance] enable journey run against cloud deployments (#156720)](#156720) <!--- Backport version: 8.9.7 --> ### 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":"2023-05-09T03:35:43Z","message":"[performance] enable journey run against cloud deployments (#156720)\n\n## Summary\r\n\r\nThis PR adds changes and instructions how to run existing performance\r\njourneys against ESS instances.\r\n\r\nAs previously discussed with @pheyos , there are few manual steps to be\r\ndone before running the actual journey:\r\n1. Create cloud deployment and re-configure it the way APM traces are\r\nreported the monitoring cluster\r\n2. Check out the branch matching deployment version (main ->\r\n8.9.0-SNAPSHOT), create user with `superuser` role (we don't test\r\nfunctional features, only performance metrics)\r\n\r\nThen you can run the journey like a regular cloud test suite:\r\n```\r\nexport TEST_KIBANA_URL=https://<username>:<password>@<kibana_url>\r\nexport TEST_ES_URL=https://<username>:<password>@j<elasticsearch_url>:<port>\r\nexport TEST_CLOUD=1\r\nnode scripts/functional_test_runner.js --config x-pack/performance/journeys/$YOUR_JOURNEY_NAME.ts\r\n```\r\n\r\n<img width=\"1357\" alt=\"image\"\r\nsrc=\"https://user-images.githubusercontent.com/10977896/236499836-2738fecb-a5a9-4e58-a10b-915b962af037.png\">\r\n\r\n---------\r\n\r\nCo-authored-by: Jon <jon@budzenski.me>","sha":"e55a92eab0ae28799b51238fb76efa6026673e6e","branchLabelMapping":{"^v8.9.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","wg:performance","v8.7.2","v8.9.0","v8.8.1"],"number":156720,"url":"https://github.com/elastic/kibana/pull/156720","mergeCommit":{"message":"[performance] enable journey run against cloud deployments (#156720)\n\n## Summary\r\n\r\nThis PR adds changes and instructions how to run existing performance\r\njourneys against ESS instances.\r\n\r\nAs previously discussed with @pheyos , there are few manual steps to be\r\ndone before running the actual journey:\r\n1. Create cloud deployment and re-configure it the way APM traces are\r\nreported the monitoring cluster\r\n2. Check out the branch matching deployment version (main ->\r\n8.9.0-SNAPSHOT), create user with `superuser` role (we don't test\r\nfunctional features, only performance metrics)\r\n\r\nThen you can run the journey like a regular cloud test suite:\r\n```\r\nexport TEST_KIBANA_URL=https://<username>:<password>@<kibana_url>\r\nexport TEST_ES_URL=https://<username>:<password>@j<elasticsearch_url>:<port>\r\nexport TEST_CLOUD=1\r\nnode scripts/functional_test_runner.js --config x-pack/performance/journeys/$YOUR_JOURNEY_NAME.ts\r\n```\r\n\r\n<img width=\"1357\" alt=\"image\"\r\nsrc=\"https://user-images.githubusercontent.com/10977896/236499836-2738fecb-a5a9-4e58-a10b-915b962af037.png\">\r\n\r\n---------\r\n\r\nCo-authored-by: Jon <jon@budzenski.me>","sha":"e55a92eab0ae28799b51238fb76efa6026673e6e"}},"sourceBranch":"main","suggestedTargetBranches":["8.7","8.8"],"targetPullRequestStates":[{"branch":"8.7","label":"v8.7.2","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v8.9.0","labelRegex":"^v8.9.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/156720","number":156720,"mergeCommit":{"message":"[performance] enable journey run against cloud deployments (#156720)\n\n## Summary\r\n\r\nThis PR adds changes and instructions how to run existing performance\r\njourneys against ESS instances.\r\n\r\nAs previously discussed with @pheyos , there are few manual steps to be\r\ndone before running the actual journey:\r\n1. Create cloud deployment and re-configure it the way APM traces are\r\nreported the monitoring cluster\r\n2. Check out the branch matching deployment version (main ->\r\n8.9.0-SNAPSHOT), create user with `superuser` role (we don't test\r\nfunctional features, only performance metrics)\r\n\r\nThen you can run the journey like a regular cloud test suite:\r\n```\r\nexport TEST_KIBANA_URL=https://<username>:<password>@<kibana_url>\r\nexport TEST_ES_URL=https://<username>:<password>@j<elasticsearch_url>:<port>\r\nexport TEST_CLOUD=1\r\nnode scripts/functional_test_runner.js --config x-pack/performance/journeys/$YOUR_JOURNEY_NAME.ts\r\n```\r\n\r\n<img width=\"1357\" alt=\"image\"\r\nsrc=\"https://user-images.githubusercontent.com/10977896/236499836-2738fecb-a5a9-4e58-a10b-915b962af037.png\">\r\n\r\n---------\r\n\r\nCo-authored-by: Jon <jon@budzenski.me>","sha":"e55a92eab0ae28799b51238fb76efa6026673e6e"}},{"branch":"8.8","label":"v8.8.1","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"}]}] BACKPORT--> Co-authored-by: Dzmitry Lemechko <dzmitry.lemechko@elastic.co>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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:
superuserrole (we don't test functional features, only performance metrics)Then you can run the journey like a regular cloud test suite: