[Controls] Change Copy for Options List Run Past Timeout

[bhavyarm]

Kibana version: 8.3.0 BC3

Elasticsearch version: 8.3.0 BC3

Browser version: chrome latest

Describe the bug: Run past timeout toggle button on controls isn't helping the user. The docs say https://www.elastic.co/guide/en/kibana/master/add-controls.html#create-and-add-controls

To populate the entire list of options, even when the Options list takes longer to populate than expected, select Run past timeout

It will be be really helpful to explain that to the user using either the copy on the toggle button or a tooltip.

[elasticmachine]

Pinging @elastic/kibana-presentation (Team:Presentation)

[teresaalvarezsoler]

Totally agree, is not clear at all what this option does. I'm even thinking why we need to expose this complexity to the user, @ThomThomson are they any drawbacks enabling this option? Why don't we have it enabled by default and remove it from here?

[ThomThomson]

This option was added specifically because of all of the issues raised relating to the Incomplete terms list warning in the experimental input controls.

Basically what happens is the following:
Because autocomplete needs to happen as the user types, it needs to be fast. To speed up the autocomplete, Kibana has two options timeout and terminateAfter which basically lose a little bit of accuracy in return for a large speed up.

Some users have certain fields in their data set up in such a way (high cardinality, bad sharding) that makes some options not show up in the results. That was super frustrating for the user. They know that Amsterdam is in their data, but because of the timeout options, it never shows up even when they search for it.

In the old experimental controls, the only way to fix this was to change the timeout and terminateAfter settings globally, which would slow down all of the input controls, even though only one field may be problematic. I ran into this on discuss forums, and in github many times.

In the new Controls, I added this run past timeout option to solve this problem. Now, individual controls can ignore those settings, making just the one control slower, but ensuring that all options properly appear.

All this to say, we can't remove this feature entirely because it is required in some edge cases. We can't turn it on by default because it would slow down the controls drastically.

Something we could do, is maybe hide it under an advanced section and explain it better with a question mark icon.

[teresaalvarezsoler]

thanks for the explanation @ThomThomson. Adding a question mark icon to explain it better seems the best option, btw is it on by default?

[ThomThomson]

It's off by default, because in ~80% of cases the settings work well and don't cause any issues.

[teresaalvarezsoler]

makes sense

[ThomThomson]

@KOTungseth, for the fix of this issue, we may need some copy help! It's a pretty complicated concept we're trying to get across here.

[KOTungseth]

@KOTungseth, for the fix of this issue, we may need some copy help! It's a pretty complicated concept we're trying to get across here.

How about:

Label: Display all options
Tooltip: Wait to display all options when they take longer to generate than expected.

[teresaalvarezsoler]

What about:

Label: Remove timeout for displaying values
Tooltip: When the control values take longer to retrieve, wait the necessary time instead of throwing a timeout. This option is useful for big volumes of data since users will always find the value they are searching for but it will also make the values retrieval significantly slower.

[kellyemurphy]

@ThomThomson I really like the idea of having an advanced section - would that contain both the items that are currently under "additional settings"? (feels logical to me, but I don't know how frequently the other setting is used)

@teresaalvarezsoler I see where you're going here and think we can tighten it up some more to make it more scannable/faster to read.

Label: Ignore timeout for results
Tooltip: Wait to display results until the list is complete. This setting is useful for large data sets, but the results might take longer to populate.

[teresaalvarezsoler]

Thanks you @kellyemurphy! Looks good to me :)