[APM] proposing new text for the overflow message #153676
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
|
Pinging @elastic/apm-ui (Team:APM) |
🤖 GitHub commentsExpand to view the GitHub comments
Just comment with:
|
|
Hi @achyutjhunjhunwala, I would recommend the following:
and, for the second,
Let me know if you have any issues or questions! |
|
@mdbirnstiehl Thanks for copy here. I will move forward with the changes then. |
achyutjhunjhunwala
changed the title
|
@mdbirnstiehl Post copy update Service Inventory Page
Service Overview Page
|
dgieselaar
reviewed
Mar 29, 2023
...k/plugins/apm/public/components/shared/links/apm/service_link/service_max_groups_message.tsx
Outdated
Show resolved
Hide resolved
|
@achyutjhunjhunwala - Here are alternate text proposals for both sections. Service Inventory Page - The APM server has reached the maximum capacity that it can currently handle in terms of showing individual services. Please consider scaling-up your APM server capacity and/or tuning the application instrumentation in order to view all of the data. Service Overview Page - The APM server has reached the maximum capacity that it can currently handle in terms of showing individual transaction groups. Please consider scaling-up your APM server capacity and/or tuning the application instrumentation in order to view all of the data. In the next release, we can also add a link to the relevant Docs in the tooltip, as they probably don't exist at the moment. |
yngrdyn
approved these changes
Mar 30, 2023
💚 Build Succeeded
Metrics [docs]Async chunks
Unknown metric groupsESLint disabled line counts
Total ESLint disabled count
History
To update your PR or re-run it, just comment with: |
kibanamachine
pushed a commit
to kibanamachine/kibana
that referenced
this pull request
Mar 30, 2023
Original Implementation PR - elastic#148641 Original Pitch - elastic/apm-dev#893 ## Summary Change overflow bucket tooltip message The existing message provides an incorrect information to the users due to various reasons. 1. They are not missing as they are part of the overflow bucket. So the word missing is a bit misleading. 2. We should not call them services or transaction groups but rather metric groups. Transaction groups at least the for the UI Team means transactions with same name. So you can have 10 transactions with the same name and they will be grouped under 1 Transaction Group. Where as the referred Transaction Group here is actually the group of those transaction groups where each group had same transaction name. So i propose to call them Transaction Metric Groups. 1 Transaction Metric Group can have `X` Transaction Groups where 1 Transaction group will consist of `Y` transactions all with the same name. 3. The overflow can happen due to multiple reasons, as there are multiple settings which can trigger the overflow, like `max_groups per metrics`, `max_services` and `max_transaction_groups_per_services` for Tx metrics and similarly for other metrics. ### Text for Service Inventory Page #### Existing Message `Number of services that have been instrumented has reached the current max. capacity that can be handled by the APM server. There are at least 7 services missing in this list. Please increase the memory allocated to APM server.` #### Proposed Message `Number of service metrics groups that have been instrumented has reached the current max. capacity that can be handled by the APM server. There is/are at least (1 service metric group)/(7 service metric groups) in this list which is/are bucketed under a common bucket present at the top of the list.` ### Text for Service Overview page - #### Existing Message `Current APM server capacity for handling unique transaction groups has been reached. There are at least 12 transactions missing in this list. Please decrease the number of transaction groups in your service or increase the memory allocated to APM server.` #### Proposed Message `Current APM server capacity for handling unique metrics groups has been reached. There is/are at least (1 transaction metric group)//20 transaction metric groups in this list which is/are bucketed under a common bucket present at the top of this list.` ### Screenshots with Old Messages Service Inventory Page <img width="1345" alt="image" src="https://user-images.githubusercontent.com/7416358/227572843-af50587d-bf3f-4934-ab1c-9bf0c4b85e3c.png"> Service Overview Page <img width="1221" alt="image" src="https://user-images.githubusercontent.com/7416358/227572962-da571300-82b1-41e5-a823-412be12a8ab1.png"> P.S. **I propose to remove the remedy on how to fix this, as the complexity of the remedy is very high unless the implementation details are literally explained.** (cherry picked from commit 75344c8)
💚 All backports created successfully
Note: Successful backport PRs will be merged automatically after passing CI. Questions ?Please refer to the Backport tool documentation |
jgowdyelastic
pushed a commit
to jgowdyelastic/kibana
that referenced
this pull request
Mar 30, 2023
Original Implementation PR - elastic#148641 Original Pitch - elastic/apm-dev#893 ## Summary Change overflow bucket tooltip message The existing message provides an incorrect information to the users due to various reasons. 1. They are not missing as they are part of the overflow bucket. So the word missing is a bit misleading. 2. We should not call them services or transaction groups but rather metric groups. Transaction groups at least the for the UI Team means transactions with same name. So you can have 10 transactions with the same name and they will be grouped under 1 Transaction Group. Where as the referred Transaction Group here is actually the group of those transaction groups where each group had same transaction name. So i propose to call them Transaction Metric Groups. 1 Transaction Metric Group can have `X` Transaction Groups where 1 Transaction group will consist of `Y` transactions all with the same name. 3. The overflow can happen due to multiple reasons, as there are multiple settings which can trigger the overflow, like `max_groups per metrics`, `max_services` and `max_transaction_groups_per_services` for Tx metrics and similarly for other metrics. ### Text for Service Inventory Page #### Existing Message `Number of services that have been instrumented has reached the current max. capacity that can be handled by the APM server. There are at least 7 services missing in this list. Please increase the memory allocated to APM server.` #### Proposed Message `Number of service metrics groups that have been instrumented has reached the current max. capacity that can be handled by the APM server. There is/are at least (1 service metric group)/(7 service metric groups) in this list which is/are bucketed under a common bucket present at the top of the list.` ### Text for Service Overview page - #### Existing Message `Current APM server capacity for handling unique transaction groups has been reached. There are at least 12 transactions missing in this list. Please decrease the number of transaction groups in your service or increase the memory allocated to APM server.` #### Proposed Message `Current APM server capacity for handling unique metrics groups has been reached. There is/are at least (1 transaction metric group)//20 transaction metric groups in this list which is/are bucketed under a common bucket present at the top of this list.` ### Screenshots with Old Messages Service Inventory Page <img width="1345" alt="image" src="https://user-images.githubusercontent.com/7416358/227572843-af50587d-bf3f-4934-ab1c-9bf0c4b85e3c.png"> Service Overview Page <img width="1221" alt="image" src="https://user-images.githubusercontent.com/7416358/227572962-da571300-82b1-41e5-a823-412be12a8ab1.png"> P.S. **I propose to remove the remedy on how to fix this, as the complexity of the remedy is very high unless the implementation details are literally explained.**
kibanamachine
added a commit
that referenced
this pull request
Mar 30, 2023
…54041) # Backport This will backport the following commits from `main` to `8.7`: - [[APM] proposing new text for the overflow message (#153676)](#153676) <!--- Backport version: 8.9.7 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport) <!--BACKPORT [{"author":{"name":"Achyut Jhunjhunwala","email":"achyut.jhunjhunwala@elastic.co"},"sourceCommit":{"committedDate":"2023-03-30T11:27:08Z","message":"[APM] proposing new text for the overflow message (#153676)\n\nOriginal Implementation PR -\r\nhttps://github.com//pull/148641\r\nOriginal Pitch - elastic/apm-dev#893 Summary\r\n\r\nChange overflow bucket tooltip message\r\n\r\nThe existing message provides an incorrect information to the users due\r\nto various reasons.\r\n\r\n\r\n1. They are not missing as they are part of the overflow bucket. So the\r\nword missing is a bit misleading.\r\n\r\n2. We should not call them services or transaction groups but rather\r\nmetric groups. Transaction groups at least the for the UI Team means\r\ntransactions with same name. So you can have 10 transactions with the\r\nsame name and they will be grouped under 1 Transaction Group. Where as\r\nthe referred Transaction Group here is actually the group of those\r\ntransaction groups where each group had same transaction name. So i\r\npropose to call them Transaction Metric Groups. 1 Transaction Metric\r\nGroup can have `X` Transaction Groups where 1 Transaction group will\r\nconsist of `Y` transactions all with the same name.\r\n\r\n3. The overflow can happen due to multiple reasons, as there are\r\nmultiple settings which can trigger the overflow, like `max_groups per\r\nmetrics`, `max_services` and `max_transaction_groups_per_services` for\r\nTx metrics and similarly for other metrics.\r\n\r\n\r\n### Text for Service Inventory Page\r\n\r\n#### Existing Message\r\n\r\n`Number of services that have been instrumented has reached the current\r\nmax. capacity that can be handled by the APM server. There are at least\r\n7 services missing in this list. Please increase the memory allocated to\r\nAPM server.`\r\n\r\n#### Proposed Message\r\n\r\n`Number of service metrics groups that have been instrumented has\r\nreached the current max. capacity that can be handled by the APM server.\r\nThere is/are at least (1 service metric group)/(7 service metric groups)\r\nin this list which is/are bucketed under a common bucket present at the\r\ntop of the list.`\r\n\r\n### Text for Service Overview page - \r\n\r\n#### Existing Message\r\n\r\n`Current APM server capacity for handling unique transaction groups has\r\nbeen reached. There are at least 12 transactions missing in this list.\r\nPlease decrease the number of transaction groups in your service or\r\nincrease the memory allocated to APM server.`\r\n\r\n#### Proposed Message\r\n\r\n`Current APM server capacity for handling unique metrics groups has been\r\nreached. There is/are at least (1 transaction metric group)//20\r\ntransaction metric groups in this list which is/are bucketed under a\r\ncommon bucket present at the top of this list.`\r\n\r\n\r\n### Screenshots with Old Messages\r\n\r\nService Inventory Page\r\n<img width=\"1345\" alt=\"image\"\r\nsrc=\"https://user-images.githubusercontent.com/7416358/227572843-af50587d-bf3f-4934-ab1c-9bf0c4b85e3c.png\">\r\n\r\n\r\nService Overview Page\r\n<img width=\"1221\" alt=\"image\"\r\nsrc=\"https://user-images.githubusercontent.com/7416358/227572962-da571300-82b1-41e5-a823-412be12a8ab1.png\">\r\n\r\n\r\nP.S. **I propose to remove the remedy on how to fix this, as the\r\ncomplexity of the remedy is very high unless the implementation details\r\nare literally explained.**","sha":"75344c88e7ff0cc635645be8fb6f051e5134f1a1","branchLabelMapping":{"^v8.8.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:fix","Team:APM","v8.8.0","v8.7.1"],"number":153676,"url":"#153676 proposing new text for the overflow message (#153676)\n\nOriginal Implementation PR -\r\nhttps://github.com//pull/148641\r\nOriginal Pitch - elastic/apm-dev#893 Summary\r\n\r\nChange overflow bucket tooltip message\r\n\r\nThe existing message provides an incorrect information to the users due\r\nto various reasons.\r\n\r\n\r\n1. They are not missing as they are part of the overflow bucket. So the\r\nword missing is a bit misleading.\r\n\r\n2. We should not call them services or transaction groups but rather\r\nmetric groups. Transaction groups at least the for the UI Team means\r\ntransactions with same name. So you can have 10 transactions with the\r\nsame name and they will be grouped under 1 Transaction Group. Where as\r\nthe referred Transaction Group here is actually the group of those\r\ntransaction groups where each group had same transaction name. So i\r\npropose to call them Transaction Metric Groups. 1 Transaction Metric\r\nGroup can have `X` Transaction Groups where 1 Transaction group will\r\nconsist of `Y` transactions all with the same name.\r\n\r\n3. The overflow can happen due to multiple reasons, as there are\r\nmultiple settings which can trigger the overflow, like `max_groups per\r\nmetrics`, `max_services` and `max_transaction_groups_per_services` for\r\nTx metrics and similarly for other metrics.\r\n\r\n\r\n### Text for Service Inventory Page\r\n\r\n#### Existing Message\r\n\r\n`Number of services that have been instrumented has reached the current\r\nmax. capacity that can be handled by the APM server. There are at least\r\n7 services missing in this list. Please increase the memory allocated to\r\nAPM server.`\r\n\r\n#### Proposed Message\r\n\r\n`Number of service metrics groups that have been instrumented has\r\nreached the current max. capacity that can be handled by the APM server.\r\nThere is/are at least (1 service metric group)/(7 service metric groups)\r\nin this list which is/are bucketed under a common bucket present at the\r\ntop of the list.`\r\n\r\n### Text for Service Overview page - \r\n\r\n#### Existing Message\r\n\r\n`Current APM server capacity for handling unique transaction groups has\r\nbeen reached. There are at least 12 transactions missing in this list.\r\nPlease decrease the number of transaction groups in your service or\r\nincrease the memory allocated to APM server.`\r\n\r\n#### Proposed Message\r\n\r\n`Current APM server capacity for handling unique metrics groups has been\r\nreached. There is/are at least (1 transaction metric group)//20\r\ntransaction metric groups in this list which is/are bucketed under a\r\ncommon bucket present at the top of this list.`\r\n\r\n\r\n### Screenshots with Old Messages\r\n\r\nService Inventory Page\r\n<img width=\"1345\" alt=\"image\"\r\nsrc=\"https://user-images.githubusercontent.com/7416358/227572843-af50587d-bf3f-4934-ab1c-9bf0c4b85e3c.png\">\r\n\r\n\r\nService Overview Page\r\n<img width=\"1221\" alt=\"image\"\r\nsrc=\"https://user-images.githubusercontent.com/7416358/227572962-da571300-82b1-41e5-a823-412be12a8ab1.png\">\r\n\r\n\r\nP.S. **I propose to remove the remedy on how to fix this, as the\r\ncomplexity of the remedy is very high unless the implementation details\r\nare literally explained.**","sha":"75344c88e7ff0cc635645be8fb6f051e5134f1a1"}},"sourceBranch":"main","suggestedTargetBranches":["8.7"],"targetPullRequestStates":[{"branch":"main","label":"v8.8.0","labelRegex":"^v8.8.0$","isSourceBranch":true,"state":"MERGED","url":"#153676 proposing new text for the overflow message (#153676)\n\nOriginal Implementation PR -\r\nhttps://github.com//pull/148641\r\nOriginal Pitch - elastic/apm-dev#893 Summary\r\n\r\nChange overflow bucket tooltip message\r\n\r\nThe existing message provides an incorrect information to the users due\r\nto various reasons.\r\n\r\n\r\n1. They are not missing as they are part of the overflow bucket. So the\r\nword missing is a bit misleading.\r\n\r\n2. We should not call them services or transaction groups but rather\r\nmetric groups. Transaction groups at least the for the UI Team means\r\ntransactions with same name. So you can have 10 transactions with the\r\nsame name and they will be grouped under 1 Transaction Group. Where as\r\nthe referred Transaction Group here is actually the group of those\r\ntransaction groups where each group had same transaction name. So i\r\npropose to call them Transaction Metric Groups. 1 Transaction Metric\r\nGroup can have `X` Transaction Groups where 1 Transaction group will\r\nconsist of `Y` transactions all with the same name.\r\n\r\n3. The overflow can happen due to multiple reasons, as there are\r\nmultiple settings which can trigger the overflow, like `max_groups per\r\nmetrics`, `max_services` and `max_transaction_groups_per_services` for\r\nTx metrics and similarly for other metrics.\r\n\r\n\r\n### Text for Service Inventory Page\r\n\r\n#### Existing Message\r\n\r\n`Number of services that have been instrumented has reached the current\r\nmax. capacity that can be handled by the APM server. There are at least\r\n7 services missing in this list. Please increase the memory allocated to\r\nAPM server.`\r\n\r\n#### Proposed Message\r\n\r\n`Number of service metrics groups that have been instrumented has\r\nreached the current max. capacity that can be handled by the APM server.\r\nThere is/are at least (1 service metric group)/(7 service metric groups)\r\nin this list which is/are bucketed under a common bucket present at the\r\ntop of the list.`\r\n\r\n### Text for Service Overview page - \r\n\r\n#### Existing Message\r\n\r\n`Current APM server capacity for handling unique transaction groups has\r\nbeen reached. There are at least 12 transactions missing in this list.\r\nPlease decrease the number of transaction groups in your service or\r\nincrease the memory allocated to APM server.`\r\n\r\n#### Proposed Message\r\n\r\n`Current APM server capacity for handling unique metrics groups has been\r\nreached. There is/are at least (1 transaction metric group)//20\r\ntransaction metric groups in this list which is/are bucketed under a\r\ncommon bucket present at the top of this list.`\r\n\r\n\r\n### Screenshots with Old Messages\r\n\r\nService Inventory Page\r\n<img width=\"1345\" alt=\"image\"\r\nsrc=\"https://user-images.githubusercontent.com/7416358/227572843-af50587d-bf3f-4934-ab1c-9bf0c4b85e3c.png\">\r\n\r\n\r\nService Overview Page\r\n<img width=\"1221\" alt=\"image\"\r\nsrc=\"https://user-images.githubusercontent.com/7416358/227572962-da571300-82b1-41e5-a823-412be12a8ab1.png\">\r\n\r\n\r\nP.S. **I propose to remove the remedy on how to fix this, as the\r\ncomplexity of the remedy is very high unless the implementation details\r\nare literally explained.**","sha":"75344c88e7ff0cc635645be8fb6f051e5134f1a1"}},{"branch":"8.7","label":"v8.7.1","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"}]}] BACKPORT--> Co-authored-by: Achyut Jhunjhunwala <achyut.jhunjhunwala@elastic.co>
|
This didn't make it on time into |
![https://user-images.githubusercontent.com/7416358/227572843-af50587d-bf3f-4934-ab1c-9bf0c4b85e3c.png\">\r\n\r\n\r\nService](https://user-images.githubusercontent.com/7416358/227572843-af50587d-bf3f-4934-ab1c-9bf0c4b85e3c.png\">\r\n\r\n\r\nService){kind=link}
![https://user-images.githubusercontent.com/7416358/227572962-da571300-82b1-41e5-a823-412be12a8ab1.png\">\r\n\r\n\r\nP.S](https://user-images.githubusercontent.com/7416358/227572962-da571300-82b1-41e5-a823-412be12a8ab1.png\">\r\n\r\n\r\nP.S){kind=link}
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.
Original Implementation PR - #148641
Original Pitch - https://github.com/elastic/apm-dev/issues/893
Summary
Change overflow bucket tooltip message
The existing message provides an incorrect information to the users due to various reasons.
They are not missing as they are part of the overflow bucket. So the word missing is a bit misleading.
We should not call them services or transaction groups but rather metric groups. Transaction groups at least the for the UI Team means transactions with same name. So you can have 10 transactions with the same name and they will be grouped under 1 Transaction Group. Where as the referred Transaction Group here is actually the group of those transaction groups where each group had same transaction name. So i propose to call them Transaction Metric Groups. 1 Transaction Metric Group can have
XTransaction Groups where 1 Transaction group will consist ofYtransactions all with the same name.The overflow can happen due to multiple reasons, as there are multiple settings which can trigger the overflow, like
max_groups per metrics,max_servicesandmax_transaction_groups_per_servicesfor Tx metrics and similarly for other metrics.Text for Service Inventory Page
Existing Message
Number of services that have been instrumented has reached the current max. capacity that can be handled by the APM server. There are at least 7 services missing in this list. Please increase the memory allocated to APM server.Proposed Message
Number of service metrics groups that have been instrumented has reached the current max. capacity that can be handled by the APM server. There is/are at least (1 service metric group)/(7 service metric groups) in this list which is/are bucketed under a common bucket present at the top of the list.Text for Service Overview page -
Existing Message
Current APM server capacity for handling unique transaction groups has been reached. There are at least 12 transactions missing in this list. Please decrease the number of transaction groups in your service or increase the memory allocated to APM server.Proposed Message
Current APM server capacity for handling unique metrics groups has been reached. There is/are at least (1 transaction metric group)//20 transaction metric groups in this list which is/are bucketed under a common bucket present at the top of this list.Screenshots with Old Messages
Service Inventory Page
Service Overview Page
P.S. I propose to remove the remedy on how to fix this, as the complexity of the remedy is very high unless the implementation details are literally explained.