[APM] Add callout to inform users of high cardinality in unique transaction names

[formgeist]

Summary

Related to #67273. This involves only the design and copy of the callout. We'd need to set up the proper functionalities to display this only when we're detecting an explosion in transaction names, as described in the original issue.

We're looking to create an agent-agnostic documentation article that we can link to enable the user to fix their issues.

Tasks

• Show callout and message with link to related docs article
• Read the configuration from the agent remote config to indicate the value set
• Update the docs article link once it's ready [docs] apm:Add documentation for reducing the number of unique transaction names #67691

Checklist

Delete any items that are not applicable to this PR.

• Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support
• Documentation was added for features that require explanation or tutorials
• Unit or functional tests were updated or added to match the most common scenarios
• This was checked for keyboard-only and screenreader accessibility
• This renders correctly on smaller devices using a responsive layout. (You can test this in your browser
• This was checked for cross-browser compatibility, including a check against IE11

For maintainers

• This was checked for breaking API changes and was labeled appropriately

[elasticmachine]

Pinging @elastic/apm-ui (Team:apm)

[sorenlouv]

Thanks for starting this @formgeist. Looks great.

[smith]

@nehaduggal mentioned in our meeting that this should using danger styles since it can be a big problem and hide many transactions.

[formgeist]

@smith @nehaduggal Updated to use the danger callout type instead.

@bmorelli25 Maybe you have a minute to help me update the initial copy in the callout to fit with your documentation article? I wrote it just as a quick placeholder. TY!

[nehaduggal]

Love it!

For the copy can we add explicitly that number of unique transaction names detected exceeds the configured setting so the user is only seeing subset of all the reported transactions.

[bmorelli25]

Thanks for the ping. Gail and I bounced some ideas off of each other. Here are a few options we came up with. Any feedback is welcome.

---

This view shows a subset of reported transactions
The number of unique transaction names exceeds the configured value. Try reconfiguring your agents to group similar transactions. Learn more in the docs.

---

Too many unique transaction names
This view cannot display all transaction groups. You may need to reconfigure your agents to group similar transactions. Learn more in the docs.

---

In the docs we can then mention that the number of unique transaction names exceeds the value configured in xpack.apm.ui.transactionGroupBucketSize, and explain how to increase that. We can also link to Agent documentation for fixing this problem.

[sorenlouv]

We can access the configured limit so we could write something like:

---

This view shows a subset of reported transactions
The number of unique transaction names exceeds the configured value of 200. Try reconfiguring your agents to group similar transactions. Learn more in the docs.

---

I know we show the configuration name in the docs but I think it would be useful to also show it directly in the warning message:

---

This view shows a subset of reported transactions
The number of unique transaction names exceeds the configured value of 20. Try reconfiguring your agents to group similar transactions or increase the value ofxpack.apm.ui.transactionGroupBucketSize. Learn more in the docs.

---

[bmorelli25]

This view shows a subset of reported transactions
The number of unique transaction names exceeds the configured value of 200. Try reconfiguring your agents to group similar transactions or increase the value of xpack.apm.ui.transactionGroupBucketSize. Learn more in the docs.

Looks great.

[formgeist]

Great teamwork 👏 I've updated the copy and styling to match the suggested messaging. I suppose next step is for someone to make this real and read the configuration and change the link once the docs article is ready.

[kibanamachine]

💚 Build Succeeded

• continuous-integration/kibana-ci/pull-request
• Commit: ba23649

History

• 💔 Build #50531 failed 59a7248
• 💚 Build #50277 succeeded f968d61

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

[sorenlouv]

replaced by #69112