[APM] Improve support for Cross Cluster Search in Indices settings

[formgeist]

Related design issue #41366

Summary

We want to allow the user to configure each index pattern in the Indices settings for Cross Cluster Search enabling a user who has several data indices across multiple clusters to include that data in a single instance of APM UI.

Design solution

Building on top of the existing indices settings page, we're extending the existing layout and adding a new option to convert the already input indices to cross cluster search compatible references.

• Convert existing rows to the EuiDescribedFormGroup component in order to add an explanatory description to each index so it's clearer for the user what each index does.
• Add option to add CCS parameter.
• Convert the "Add CSS" button to a text EuiButtonEmpty style with a checkmark icon since the input parameters have been generated.
• When we show the "Added CCS" button, we will additionally put a small helper text underneath the option to explain the syntax of what we've added.
  
• If an index has CSS index parameters already, we will not show the generate option.
• Show tooltip by the generate button with copy that explains what Cross Cluster Search means; If you have multiple clusters storing your data, you can enable APM UI to search for those as well.

Prototype & screens

Figma prototype

[elasticmachine]

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

[sorenlouv]

@formgeist Before users can use ccs in APM they have to setup the remote clusters in the management section.

It might be possible for us to detect if they've done this. And also detect the names of the remote clusters. This is perhaps v.2 but might be worth thinking about how we can make the integration even smoother (eg. only suggest ccs if they've setup a remote cluster; and in that case suggest specific cluster names)

[formgeist]

@sqren Alright, thanks for the heads up. If users add the CCS parameters in the inputs, will it break if they haven't enabled remote clusters? I want to avoid having too many callouts and notifications to the users in our UI.

[sorenlouv]

If users add the CCS parameters in the inputs, will it break if they haven't enabled remote clusters? I want to avoid having too many callouts and notifications to the users in our UI.

It wont break as such if the user adds apm-*,*:apm-* and they haven't added any remote clusters. But OTOH it won't work as expected either. It'll just search on the local cluster.

Suggestions for phase 2:

• only show "Add Cross Cluster Indices" link if at least one remote cluster has been added
• warn the user if they manually type *:apm-* without having added any remote clusters
• warn the user if they manually type mycluster1:apm-* if they only have a remote cluster named mycluster2.

Similarly we could add a warning if no indices matches the specified pattern.

[formgeist]

Suggestions for phase 2:

• only show "Add Cross Cluster Indices" link if at least one remote cluster has been added
• warn the user if they manually type :apm- without having added any remote clusters
• warn the user if they manually type mycluster1:apm-* if they only have a remote cluster named - mycluster2.
• Similarly we could add a warning if no indices matches the specified pattern.

I agree with those suggestions. I'll incorporate them in my next revisions and post an update 👍

[formgeist]

Opened a new design issue to handle those improvements elastic/apm#189

[botelastic]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[sorenlouv]

Closing due to inactivity