Way to "connect" UBI events with queries

[jzonthemtn]

Right now, we don't have an easy straightforward way to link events and queries. There isn't any "glue" other than the query_id that links the two and this might not be sufficient.

In opensearch-project/user-behavior-insights#34 I want to capture the index(es) that were searched in the UBI queries index, but this might not be appropriate for all use-cases. A more granular approach is likely needed.

We should consider the addition of an application field that both queries and events can use to form this linking. The application can be provided in the query's ext block, and application can be used in the event schema. Having application on both would provide a low-level way to connect queries and events.

[epugh]

FYI: the ext block is the specific way we add UBI to OpenSearch JSON based query DSL .

[epugh]

Are you suggesting that we should have an explicit application field added to the query_attributes and event_attributes???

I can imagine that you would have a typeahead and a global search, and you would want to distingush between these two sources of queries, when generating personlaization inputs or implicit judgement etc...

Is application the right word? source? origin???

[jzonthemtn]

Question for everyone - is application the most appropriate name for the field?

[alexeyrodriguez]

Something that can help with naming. What are possible values of application? Types of search experience/feature: type-ahead or global-search. Will it also be used to separate multiple shops that an Open Search installation is supporting? The last two types can also mix of course. Any other?

@epugh I suppose you mean adding it to queries, since events already has application.

[wrigleyDan]

If we already have the application field in the events schema I'd vote for that name.

At least if that does not have any other meaning in the events schema? It feels like a field that should be present for both schemas.

[epugh]

Thanks for feedback team. I'm going to use application and try to provide some nicer examples in the spec...!

[jzonthemtn]

We should capture application from the ext in queries in the plugin, also. Care to write that issue in the plugin repo?

[epugh]

Here is two examples of application being on events and queries.

[epugh]

We should capture application from the ext in queries in the plugin, also. Care to write that issue in the plugin repo?

opensearch-project/user-behavior-insights#40