Add documentation for the UBI plugin #7284

RasonJ · 2024-05-31T17:56:35Z

Description

This organizes User Behavior Insights documentation in the OS documentation repos

Issues Resolved

A dearth of UBI documentation

Version

2.14/2.15

Checklist

[ x] By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and subject to the Developers Certificate of Origin.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

hdhalter · 2024-06-06T19:46:27Z

Should we close #6625 in favor of this one?

epugh · 2024-06-07T19:35:00Z

Should we close #6625 in favor of this one?

Done

epugh · 2024-06-08T12:02:16Z

@RasonJ take a look at the changes.. I've taken a pass through the text, updated a lot of links to point to final repos, and tried to dedupe some content.

I put all the Chorus katas under one link, though I could see listing each one in that table to draw more attention to them?

epugh

Everything from my perspective looks good, however since I was involved in the project, I'd love another set of external eyes! I may be too close to the material.

kolchfa-aws · 2024-06-12T15:08:07Z

@RasonJ Could you please fix DCO and then I'll review the PR and will put it through editorial review? I assume this is still going into 2.15? Thanks!

kolchfa-aws · 2024-06-12T17:36:42Z

@RasonJ Thanks for fixing the DCO! It looks like you picked up several extraneous commits along the way. Could you resolve this?

kolchfa-aws · 2024-06-13T13:09:48Z

Almost there 😄 There are still some extraneous commits in the middle. Let me know when this is ready for review. Thanks!

Signed-off-by: RasonJ <[email protected]>

Signed-off-by: Heather Halter <[email protected]>

_search-plugins/ubi/sql-queries.md

_search-plugins/ubi/ubi-dashboard-tutorial.md

natebower · 2024-07-03T11:14:19Z

_search-plugins/ubi/schemas.md

+
+To summarize, the `query_id` signals the beginning of a unique search for a client tracked through a `client_id`. The search returns various objects, each with a unique `object_id`. The `action_name` specifies what action the user is performing and is connected to the objects, each with a specific `object_id`. You can differentiate between types of objects by inspecting the `object_id_field`.  
+
+Typically, you can infer the user's overall search history by retrieving all the data for the user's `client_id` and inspecting the individual `query_id` data. Each application decides what makes a search session by examining the data in the backend.


The meaning of the second sentence is unclear. Do we mean "Each application determines what constitutes a search session by examining the backend data"?

natebower · 2024-07-03T11:20:14Z

_search-plugins/ubi/sql-queries.md

+order by query_id, timestamp
+```
+
+The results are truncated to show a few sessions, as shown in the following table.


"a few" is ambiguous here. I would normally suggest "only a few", but there appear to be far more than that. Can we revise for clarity?

Revised to "sample"

_search-plugins/ubi/ubi-dashboard-tutorial.md

natebower · 2024-07-03T11:29:30Z

_search-plugins/ubi/ubi-dashboard-tutorial.md

+{: .note} 
+
+
+The resulting visualization may not be exactly what you're looking for. The `message` field is updated with every event, and as a result, it can contain error messages, debug messages, click information, and other unwanted data.


What do we mean by "may not be exactly what you're looking for"? Can we be a little more precise? Do we mean something like "may not appear as expected"?

natebower · 2024-07-03T11:29:58Z

_search-plugins/ubi/ubi-dashboard-tutorial.md

+
+
+The resulting visualization may not be exactly what you're looking for. The `message` field is updated with every event, and as a result, it can contain error messages, debug messages, click information, and other unwanted data.
+To view only search terms for query events, you need to add a filter to your visualization. Because the developer provided a `message_type` of `QUERY` for each search event, you can filter by that message type to isolate the specific users' searches. To do this, select **Add filter** and then select **QUERY** in the **Edit filter** panel, as shown in the following image. 


Who is "the developer"? Can we please remove/rephrase?

_search-plugins/ubi/schemas.md

Signed-off-by: kolchfa-aws <[email protected]>

_search-plugins/ubi/sql-queries.md

_search-plugins/ubi/ubi-dashboard-tutorial.md

Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: kolchfa-aws <[email protected]>

natebower

@hdhalter @epugh @RasonJ All requested changes appear to have been addressed, with the exception of line 326 in sql-queries.md. I am fine with any or no resolution on line 125 in schemas.md and line 168 in sql-queries.md. Otherwise, LGTM. Thanks!

Removed links on 'object_id' and 'query_id' Signed-off-by: Heather Halter <[email protected]>

removed a note tag and fixed line 326 Signed-off-by: Heather Halter <[email protected]>

One more table heading Signed-off-by: Heather Halter <[email protected]>

* gathering potential documentation attempts Signed-off-by: RasonJ <[email protected]> * considering the dashboard tutorial Signed-off-by: RasonJ <[email protected]> * place holder for js data structure usage Signed-off-by: RasonJ <[email protected]> * data-structures placeholder Signed-off-by: RasonJ <[email protected]> * Updating index links Signed-off-by: RasonJ <[email protected]> * adding old doc to be merged Signed-off-by: RasonJ <[email protected]> * Starting to link things together Signed-off-by: RasonJ <[email protected]> * fix broken link Signed-off-by: RasonJ <[email protected]> * respond to vale Signed-off-by: RasonJ <[email protected]> * more vale violations Signed-off-by: RasonJ <[email protected]> * name files consistently with docs site and fix links. Signed-off-by: RasonJ <[email protected]> * vale Signed-off-by: RasonJ <[email protected]> * Minor tweaks. Moved Ubi under SEARCH. Signed-off-by: RasonJ <[email protected]> * add label for versining of spec and OS version Signed-off-by: RasonJ <[email protected]> * try to sort out vale error Signed-off-by: RasonJ <[email protected]> * Converting mermaid diagrams to png's Signed-off-by: RasonJ <[email protected]> * Updating query_id mermaid code Signed-off-by: RasonJ <[email protected]> * Better way to ignore the mermaid scripts in the md files Signed-off-by: RasonJ <[email protected]> * description updates Signed-off-by: RasonJ <[email protected]> * schema.md updating (still need to update the mermaid diagram) Signed-off-by: RasonJ <[email protected]> * schema updates Signed-off-by: RasonJ <[email protected]> * updates Signed-off-by: RasonJ <[email protected]> * Rebuilding main Signed-off-by: RasonJ <[email protected]> * merging in images Signed-off-by: RasonJ <[email protected]> * Updating UBI spec number Signed-off-by: RasonJ <[email protected]> * Use released version Signed-off-by: Eric Pugh <[email protected]> * Update _search-plugins/index.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: RasonJ <[email protected]> * Update _search-plugins/ubi/index.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: RasonJ <[email protected]> * Update _search-plugins/ubi/index.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: RasonJ <[email protected]> * Update _search-plugins/ubi/ubi-dashboard-tutorial.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: RasonJ <[email protected]> * Update _search-plugins/ubi/ubi-dashboard-tutorial.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: RasonJ <[email protected]> * Update _search-plugins/ubi/ubi-dashboard-tutorial.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: RasonJ <[email protected]> * Addressing PR feedback Signed-off-by: RasonJ <[email protected]> * Update _search-plugins/ubi/ubi-dashboard-tutorial.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: RasonJ <[email protected]> * Update _search-plugins/ubi/data-structures.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: RasonJ <[email protected]> * Update _search-plugins/ubi/data-structures.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: RasonJ <[email protected]> * Update _search-plugins/ubi/data-structures.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: RasonJ <[email protected]> * Update _search-plugins/ubi/data-structures.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: RasonJ <[email protected]> * Adding dsl intro Signed-off-by: RasonJ <[email protected]> * Adding intro sentence Signed-off-by: RasonJ <[email protected]> * Title adjust Signed-off-by: RasonJ <[email protected]> * Apply suggestions from code review Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: RasonJ <[email protected]> * Apply suggestions from code review Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: RasonJ <[email protected]> * Apply suggestions from code review Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: RasonJ <[email protected]> * Apply suggestions from code review Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: RasonJ <[email protected]> * Apply suggestions from code review Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: RasonJ <[email protected]> * Apply suggestions from code review Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: RasonJ <[email protected]> * Apply suggestions from code review Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: RasonJ <[email protected]> * Addressing PR feedback Signed-off-by: RasonJ <[email protected]> * Update _search-plugins/ubi/ubi-dashboard-tutorial.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: RasonJ <[email protected]> * Addressing pr feedback Signed-off-by: RasonJ <[email protected]> * Addressing PR feedback Signed-off-by: RasonJ <[email protected]> * Fixing vale errors Signed-off-by: RasonJ <[email protected]> * Apply suggestions from code review Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: RasonJ <[email protected]> * Finishing initial pr feedback Signed-off-by: RasonJ <[email protected]> * Next round of PR feedback Signed-off-by: RasonJ <[email protected]> * Describing chorus workbench link Signed-off-by: RasonJ <[email protected]> * Adding captions for result tables Signed-off-by: RasonJ <[email protected]> * PR clean up Signed-off-by: RasonJ <[email protected]> * Apply suggestions from code review Co-authored-by: Heather Halter <[email protected]> Signed-off-by: RasonJ <[email protected]> * Adding a few more suggestions Signed-off-by: RasonJ <[email protected]> * Apply suggestions from code review Co-authored-by: Heather Halter <[email protected]> Signed-off-by: RasonJ <[email protected]> * Apply suggestions from code review Co-authored-by: Heather Halter <[email protected]> Signed-off-by: RasonJ <[email protected]> * Apply suggestions from code review Co-authored-by: Heather Halter <[email protected]> Signed-off-by: RasonJ <[email protected]> * Update _search-plugins/ubi/ubi-dashboard-tutorial.md Co-authored-by: Heather Halter <[email protected]> Signed-off-by: RasonJ <[email protected]> * Update _search-plugins/ubi/ubi-dashboard-tutorial.md Co-authored-by: Heather Halter <[email protected]> Signed-off-by: RasonJ <[email protected]> * Update _search-plugins/ubi/ubi-dashboard-tutorial.md Co-authored-by: Heather Halter <[email protected]> Signed-off-by: RasonJ <[email protected]> * Update _search-plugins/ubi/ubi-dashboard-tutorial.md Co-authored-by: Heather Halter <[email protected]> Signed-off-by: RasonJ <[email protected]> * Update _search-plugins/ubi/ubi-dashboard-tutorial.md Co-authored-by: Heather Halter <[email protected]> Signed-off-by: RasonJ <[email protected]> * Update _search-plugins/ubi/ubi-dashboard-tutorial.md Co-authored-by: Heather Halter <[email protected]> Signed-off-by: RasonJ <[email protected]> * Update _search-plugins/ubi/ubi-dashboard-tutorial.md Co-authored-by: Heather Halter <[email protected]> Signed-off-by: RasonJ <[email protected]> * updating query filter for laptos Signed-off-by: RasonJ <[email protected]> * Update _search-plugins/ubi/ubi-dashboard-tutorial.md Co-authored-by: Heather Halter <[email protected]> Signed-off-by: RasonJ <[email protected]> * Update _search-plugins/ubi/ubi-dashboard-tutorial.md Co-authored-by: Heather Halter <[email protected]> Signed-off-by: RasonJ <[email protected]> * Update _search-plugins/ubi/ubi-dashboard-tutorial.md Co-authored-by: Heather Halter <[email protected]> Signed-off-by: RasonJ <[email protected]> * PR feedback Signed-off-by: RasonJ <[email protected]> * Update _search-plugins/ubi/ubi-dashboard-tutorial.md Co-authored-by: Heather Halter <[email protected]> Signed-off-by: RasonJ <[email protected]> * PR feedback Signed-off-by: RasonJ <[email protected]> * Apply suggestions from code review Co-authored-by: Heather Halter <[email protected]> Signed-off-by: RasonJ <[email protected]> * Apply suggestions from code review Edits to all files to comply with OpenSearch standards; nav_order updates Signed-off-by: Heather Halter <[email protected]> * Apply suggestions from code review Missed a file - more commits to the sql-query topic Signed-off-by: Heather Halter <[email protected]> * Update _search-plugins/ubi/sql-queries.md Signed-off-by: Heather Halter <[email protected]> * Apply suggestions from code review Cleaned up the sample query topic Signed-off-by: Heather Halter <[email protected]> * Apply suggestions from code review Signed-off-by: Heather Halter <[email protected]> * Update _search-plugins/ubi/dsl-queries.md Signed-off-by: Heather Halter <[email protected]> * Update _search-plugins/ubi/dsl-queries.md Signed-off-by: Heather Halter <[email protected]> * Apply suggestions from code review Accepted editorial suggestions. Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Heather Halter <[email protected]> * Update index.md Reformatted table info Signed-off-by: Heather Halter <[email protected]> * Update _search-plugins/ubi/dsl-queries.md Signed-off-by: Heather Halter <[email protected]> * Apply suggestions from code review Signed-off-by: Heather Halter <[email protected]> * Update index.md Signed-off-by: Heather Halter <[email protected]> * Update schemas.md Signed-off-by: Heather Halter <[email protected]> * Update index.md Added a missing link and fixed the table. Signed-off-by: Heather Halter <[email protected]> * Update index.md Changed the bold to italics Signed-off-by: Heather Halter <[email protected]> * Update ubi-dashboard-tutorial.md Removed unnecessary note tag. Signed-off-by: Heather Halter <[email protected]> * Update schemas.md Inserted comma Signed-off-by: Heather Halter <[email protected]> * Update sql-queries.md Signed-off-by: Heather Halter <[email protected]> * Apply suggestions from code review There were some hidden comments that I found in this file. Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Heather Halter <[email protected]> * Update _search-plugins/ubi/sql-queries.md Signed-off-by: Heather Halter <[email protected]> * Update _search-plugins/ubi/sql-queries.md Signed-off-by: Heather Halter <[email protected]> * Apply suggestions from code review Signed-off-by: Heather Halter <[email protected]> * Update _search-plugins/ubi/schemas.md Signed-off-by: kolchfa-aws <[email protected]> * Apply suggestions from code review Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> * Update schemas.md Removed links on 'object_id' and 'query_id' Signed-off-by: Heather Halter <[email protected]> * Update sql-queries.md removed a note tag and fixed line 326 Signed-off-by: Heather Halter <[email protected]> * Update sql-queries.md One more table heading Signed-off-by: Heather Halter <[email protected]> --------- Signed-off-by: RasonJ <[email protected]> Signed-off-by: Eric Pugh <[email protected]> Signed-off-by: Heather Halter <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> Co-authored-by: Eric Pugh <[email protected]> Co-authored-by: kolchfa-aws <[email protected]> Co-authored-by: Heather Halter <[email protected]> Co-authored-by: Nathan Bower <[email protected]> (cherry picked from commit 5db02ca) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* gathering potential documentation attempts Signed-off-by: RasonJ <[email protected]> * considering the dashboard tutorial Signed-off-by: RasonJ <[email protected]> * place holder for js data structure usage Signed-off-by: RasonJ <[email protected]> * data-structures placeholder Signed-off-by: RasonJ <[email protected]> * Updating index links Signed-off-by: RasonJ <[email protected]> * adding old doc to be merged Signed-off-by: RasonJ <[email protected]> * Starting to link things together Signed-off-by: RasonJ <[email protected]> * fix broken link Signed-off-by: RasonJ <[email protected]> * respond to vale Signed-off-by: RasonJ <[email protected]> * more vale violations Signed-off-by: RasonJ <[email protected]> * name files consistently with docs site and fix links. Signed-off-by: RasonJ <[email protected]> * vale Signed-off-by: RasonJ <[email protected]> * Minor tweaks. Moved Ubi under SEARCH. Signed-off-by: RasonJ <[email protected]> * add label for versining of spec and OS version Signed-off-by: RasonJ <[email protected]> * try to sort out vale error Signed-off-by: RasonJ <[email protected]> * Converting mermaid diagrams to png's Signed-off-by: RasonJ <[email protected]> * Updating query_id mermaid code Signed-off-by: RasonJ <[email protected]> * Better way to ignore the mermaid scripts in the md files Signed-off-by: RasonJ <[email protected]> * description updates Signed-off-by: RasonJ <[email protected]> * schema.md updating (still need to update the mermaid diagram) Signed-off-by: RasonJ <[email protected]> * schema updates Signed-off-by: RasonJ <[email protected]> * updates Signed-off-by: RasonJ <[email protected]> * Rebuilding main Signed-off-by: RasonJ <[email protected]> * merging in images Signed-off-by: RasonJ <[email protected]> * Updating UBI spec number Signed-off-by: RasonJ <[email protected]> * Use released version Signed-off-by: Eric Pugh <[email protected]> * Update _search-plugins/index.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: RasonJ <[email protected]> * Update _search-plugins/ubi/index.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: RasonJ <[email protected]> * Update _search-plugins/ubi/index.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: RasonJ <[email protected]> * Update _search-plugins/ubi/ubi-dashboard-tutorial.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: RasonJ <[email protected]> * Update _search-plugins/ubi/ubi-dashboard-tutorial.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: RasonJ <[email protected]> * Update _search-plugins/ubi/ubi-dashboard-tutorial.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: RasonJ <[email protected]> * Addressing PR feedback Signed-off-by: RasonJ <[email protected]> * Update _search-plugins/ubi/ubi-dashboard-tutorial.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: RasonJ <[email protected]> * Update _search-plugins/ubi/data-structures.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: RasonJ <[email protected]> * Update _search-plugins/ubi/data-structures.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: RasonJ <[email protected]> * Update _search-plugins/ubi/data-structures.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: RasonJ <[email protected]> * Update _search-plugins/ubi/data-structures.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: RasonJ <[email protected]> * Adding dsl intro Signed-off-by: RasonJ <[email protected]> * Adding intro sentence Signed-off-by: RasonJ <[email protected]> * Title adjust Signed-off-by: RasonJ <[email protected]> * Apply suggestions from code review Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: RasonJ <[email protected]> * Apply suggestions from code review Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: RasonJ <[email protected]> * Apply suggestions from code review Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: RasonJ <[email protected]> * Apply suggestions from code review Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: RasonJ <[email protected]> * Apply suggestions from code review Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: RasonJ <[email protected]> * Apply suggestions from code review Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: RasonJ <[email protected]> * Apply suggestions from code review Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: RasonJ <[email protected]> * Addressing PR feedback Signed-off-by: RasonJ <[email protected]> * Update _search-plugins/ubi/ubi-dashboard-tutorial.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: RasonJ <[email protected]> * Addressing pr feedback Signed-off-by: RasonJ <[email protected]> * Addressing PR feedback Signed-off-by: RasonJ <[email protected]> * Fixing vale errors Signed-off-by: RasonJ <[email protected]> * Apply suggestions from code review Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: RasonJ <[email protected]> * Finishing initial pr feedback Signed-off-by: RasonJ <[email protected]> * Next round of PR feedback Signed-off-by: RasonJ <[email protected]> * Describing chorus workbench link Signed-off-by: RasonJ <[email protected]> * Adding captions for result tables Signed-off-by: RasonJ <[email protected]> * PR clean up Signed-off-by: RasonJ <[email protected]> * Apply suggestions from code review Co-authored-by: Heather Halter <[email protected]> Signed-off-by: RasonJ <[email protected]> * Adding a few more suggestions Signed-off-by: RasonJ <[email protected]> * Apply suggestions from code review Co-authored-by: Heather Halter <[email protected]> Signed-off-by: RasonJ <[email protected]> * Apply suggestions from code review Co-authored-by: Heather Halter <[email protected]> Signed-off-by: RasonJ <[email protected]> * Apply suggestions from code review Co-authored-by: Heather Halter <[email protected]> Signed-off-by: RasonJ <[email protected]> * Update _search-plugins/ubi/ubi-dashboard-tutorial.md Co-authored-by: Heather Halter <[email protected]> Signed-off-by: RasonJ <[email protected]> * Update _search-plugins/ubi/ubi-dashboard-tutorial.md Co-authored-by: Heather Halter <[email protected]> Signed-off-by: RasonJ <[email protected]> * Update _search-plugins/ubi/ubi-dashboard-tutorial.md Co-authored-by: Heather Halter <[email protected]> Signed-off-by: RasonJ <[email protected]> * Update _search-plugins/ubi/ubi-dashboard-tutorial.md Co-authored-by: Heather Halter <[email protected]> Signed-off-by: RasonJ <[email protected]> * Update _search-plugins/ubi/ubi-dashboard-tutorial.md Co-authored-by: Heather Halter <[email protected]> Signed-off-by: RasonJ <[email protected]> * Update _search-plugins/ubi/ubi-dashboard-tutorial.md Co-authored-by: Heather Halter <[email protected]> Signed-off-by: RasonJ <[email protected]> * Update _search-plugins/ubi/ubi-dashboard-tutorial.md Co-authored-by: Heather Halter <[email protected]> Signed-off-by: RasonJ <[email protected]> * updating query filter for laptos Signed-off-by: RasonJ <[email protected]> * Update _search-plugins/ubi/ubi-dashboard-tutorial.md Co-authored-by: Heather Halter <[email protected]> Signed-off-by: RasonJ <[email protected]> * Update _search-plugins/ubi/ubi-dashboard-tutorial.md Co-authored-by: Heather Halter <[email protected]> Signed-off-by: RasonJ <[email protected]> * Update _search-plugins/ubi/ubi-dashboard-tutorial.md Co-authored-by: Heather Halter <[email protected]> Signed-off-by: RasonJ <[email protected]> * PR feedback Signed-off-by: RasonJ <[email protected]> * Update _search-plugins/ubi/ubi-dashboard-tutorial.md Co-authored-by: Heather Halter <[email protected]> Signed-off-by: RasonJ <[email protected]> * PR feedback Signed-off-by: RasonJ <[email protected]> * Apply suggestions from code review Co-authored-by: Heather Halter <[email protected]> Signed-off-by: RasonJ <[email protected]> * Apply suggestions from code review Edits to all files to comply with OpenSearch standards; nav_order updates Signed-off-by: Heather Halter <[email protected]> * Apply suggestions from code review Missed a file - more commits to the sql-query topic Signed-off-by: Heather Halter <[email protected]> * Update _search-plugins/ubi/sql-queries.md Signed-off-by: Heather Halter <[email protected]> * Apply suggestions from code review Cleaned up the sample query topic Signed-off-by: Heather Halter <[email protected]> * Apply suggestions from code review Signed-off-by: Heather Halter <[email protected]> * Update _search-plugins/ubi/dsl-queries.md Signed-off-by: Heather Halter <[email protected]> * Update _search-plugins/ubi/dsl-queries.md Signed-off-by: Heather Halter <[email protected]> * Apply suggestions from code review Accepted editorial suggestions. Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Heather Halter <[email protected]> * Update index.md Reformatted table info Signed-off-by: Heather Halter <[email protected]> * Update _search-plugins/ubi/dsl-queries.md Signed-off-by: Heather Halter <[email protected]> * Apply suggestions from code review Signed-off-by: Heather Halter <[email protected]> * Update index.md Signed-off-by: Heather Halter <[email protected]> * Update schemas.md Signed-off-by: Heather Halter <[email protected]> * Update index.md Added a missing link and fixed the table. Signed-off-by: Heather Halter <[email protected]> * Update index.md Changed the bold to italics Signed-off-by: Heather Halter <[email protected]> * Update ubi-dashboard-tutorial.md Removed unnecessary note tag. Signed-off-by: Heather Halter <[email protected]> * Update schemas.md Inserted comma Signed-off-by: Heather Halter <[email protected]> * Update sql-queries.md Signed-off-by: Heather Halter <[email protected]> * Apply suggestions from code review There were some hidden comments that I found in this file. Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Heather Halter <[email protected]> * Update _search-plugins/ubi/sql-queries.md Signed-off-by: Heather Halter <[email protected]> * Update _search-plugins/ubi/sql-queries.md Signed-off-by: Heather Halter <[email protected]> * Apply suggestions from code review Signed-off-by: Heather Halter <[email protected]> * Update _search-plugins/ubi/schemas.md Signed-off-by: kolchfa-aws <[email protected]> * Apply suggestions from code review Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> * Update schemas.md Removed links on 'object_id' and 'query_id' Signed-off-by: Heather Halter <[email protected]> * Update sql-queries.md removed a note tag and fixed line 326 Signed-off-by: Heather Halter <[email protected]> * Update sql-queries.md One more table heading Signed-off-by: Heather Halter <[email protected]> --------- Signed-off-by: RasonJ <[email protected]> Signed-off-by: Eric Pugh <[email protected]> Signed-off-by: Heather Halter <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> Co-authored-by: Eric Pugh <[email protected]> Co-authored-by: kolchfa-aws <[email protected]> Co-authored-by: Heather Halter <[email protected]> Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: [email protected] <[email protected]>

* gathering potential documentation attempts Signed-off-by: RasonJ <[email protected]> * considering the dashboard tutorial Signed-off-by: RasonJ <[email protected]> * place holder for js data structure usage Signed-off-by: RasonJ <[email protected]> * data-structures placeholder Signed-off-by: RasonJ <[email protected]> * Updating index links Signed-off-by: RasonJ <[email protected]> * adding old doc to be merged Signed-off-by: RasonJ <[email protected]> * Starting to link things together Signed-off-by: RasonJ <[email protected]> * fix broken link Signed-off-by: RasonJ <[email protected]> * respond to vale Signed-off-by: RasonJ <[email protected]> * more vale violations Signed-off-by: RasonJ <[email protected]> * name files consistently with docs site and fix links. Signed-off-by: RasonJ <[email protected]> * vale Signed-off-by: RasonJ <[email protected]> * Minor tweaks. Moved Ubi under SEARCH. Signed-off-by: RasonJ <[email protected]> * add label for versining of spec and OS version Signed-off-by: RasonJ <[email protected]> * try to sort out vale error Signed-off-by: RasonJ <[email protected]> * Converting mermaid diagrams to png's Signed-off-by: RasonJ <[email protected]> * Updating query_id mermaid code Signed-off-by: RasonJ <[email protected]> * Better way to ignore the mermaid scripts in the md files Signed-off-by: RasonJ <[email protected]> * description updates Signed-off-by: RasonJ <[email protected]> * schema.md updating (still need to update the mermaid diagram) Signed-off-by: RasonJ <[email protected]> * schema updates Signed-off-by: RasonJ <[email protected]> * updates Signed-off-by: RasonJ <[email protected]> * Rebuilding main Signed-off-by: RasonJ <[email protected]> * merging in images Signed-off-by: RasonJ <[email protected]> * Updating UBI spec number Signed-off-by: RasonJ <[email protected]> * Use released version Signed-off-by: Eric Pugh <[email protected]> * Update _search-plugins/index.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: RasonJ <[email protected]> * Update _search-plugins/ubi/index.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: RasonJ <[email protected]> * Update _search-plugins/ubi/index.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: RasonJ <[email protected]> * Update _search-plugins/ubi/ubi-dashboard-tutorial.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: RasonJ <[email protected]> * Update _search-plugins/ubi/ubi-dashboard-tutorial.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: RasonJ <[email protected]> * Update _search-plugins/ubi/ubi-dashboard-tutorial.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: RasonJ <[email protected]> * Addressing PR feedback Signed-off-by: RasonJ <[email protected]> * Update _search-plugins/ubi/ubi-dashboard-tutorial.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: RasonJ <[email protected]> * Update _search-plugins/ubi/data-structures.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: RasonJ <[email protected]> * Update _search-plugins/ubi/data-structures.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: RasonJ <[email protected]> * Update _search-plugins/ubi/data-structures.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: RasonJ <[email protected]> * Update _search-plugins/ubi/data-structures.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: RasonJ <[email protected]> * Adding dsl intro Signed-off-by: RasonJ <[email protected]> * Adding intro sentence Signed-off-by: RasonJ <[email protected]> * Title adjust Signed-off-by: RasonJ <[email protected]> * Apply suggestions from code review Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: RasonJ <[email protected]> * Apply suggestions from code review Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: RasonJ <[email protected]> * Apply suggestions from code review Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: RasonJ <[email protected]> * Apply suggestions from code review Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: RasonJ <[email protected]> * Apply suggestions from code review Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: RasonJ <[email protected]> * Apply suggestions from code review Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: RasonJ <[email protected]> * Apply suggestions from code review Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: RasonJ <[email protected]> * Addressing PR feedback Signed-off-by: RasonJ <[email protected]> * Update _search-plugins/ubi/ubi-dashboard-tutorial.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: RasonJ <[email protected]> * Addressing pr feedback Signed-off-by: RasonJ <[email protected]> * Addressing PR feedback Signed-off-by: RasonJ <[email protected]> * Fixing vale errors Signed-off-by: RasonJ <[email protected]> * Apply suggestions from code review Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: RasonJ <[email protected]> * Finishing initial pr feedback Signed-off-by: RasonJ <[email protected]> * Next round of PR feedback Signed-off-by: RasonJ <[email protected]> * Describing chorus workbench link Signed-off-by: RasonJ <[email protected]> * Adding captions for result tables Signed-off-by: RasonJ <[email protected]> * PR clean up Signed-off-by: RasonJ <[email protected]> * Apply suggestions from code review Co-authored-by: Heather Halter <[email protected]> Signed-off-by: RasonJ <[email protected]> * Adding a few more suggestions Signed-off-by: RasonJ <[email protected]> * Apply suggestions from code review Co-authored-by: Heather Halter <[email protected]> Signed-off-by: RasonJ <[email protected]> * Apply suggestions from code review Co-authored-by: Heather Halter <[email protected]> Signed-off-by: RasonJ <[email protected]> * Apply suggestions from code review Co-authored-by: Heather Halter <[email protected]> Signed-off-by: RasonJ <[email protected]> * Update _search-plugins/ubi/ubi-dashboard-tutorial.md Co-authored-by: Heather Halter <[email protected]> Signed-off-by: RasonJ <[email protected]> * Update _search-plugins/ubi/ubi-dashboard-tutorial.md Co-authored-by: Heather Halter <[email protected]> Signed-off-by: RasonJ <[email protected]> * Update _search-plugins/ubi/ubi-dashboard-tutorial.md Co-authored-by: Heather Halter <[email protected]> Signed-off-by: RasonJ <[email protected]> * Update _search-plugins/ubi/ubi-dashboard-tutorial.md Co-authored-by: Heather Halter <[email protected]> Signed-off-by: RasonJ <[email protected]> * Update _search-plugins/ubi/ubi-dashboard-tutorial.md Co-authored-by: Heather Halter <[email protected]> Signed-off-by: RasonJ <[email protected]> * Update _search-plugins/ubi/ubi-dashboard-tutorial.md Co-authored-by: Heather Halter <[email protected]> Signed-off-by: RasonJ <[email protected]> * Update _search-plugins/ubi/ubi-dashboard-tutorial.md Co-authored-by: Heather Halter <[email protected]> Signed-off-by: RasonJ <[email protected]> * updating query filter for laptos Signed-off-by: RasonJ <[email protected]> * Update _search-plugins/ubi/ubi-dashboard-tutorial.md Co-authored-by: Heather Halter <[email protected]> Signed-off-by: RasonJ <[email protected]> * Update _search-plugins/ubi/ubi-dashboard-tutorial.md Co-authored-by: Heather Halter <[email protected]> Signed-off-by: RasonJ <[email protected]> * Update _search-plugins/ubi/ubi-dashboard-tutorial.md Co-authored-by: Heather Halter <[email protected]> Signed-off-by: RasonJ <[email protected]> * PR feedback Signed-off-by: RasonJ <[email protected]> * Update _search-plugins/ubi/ubi-dashboard-tutorial.md Co-authored-by: Heather Halter <[email protected]> Signed-off-by: RasonJ <[email protected]> * PR feedback Signed-off-by: RasonJ <[email protected]> * Apply suggestions from code review Co-authored-by: Heather Halter <[email protected]> Signed-off-by: RasonJ <[email protected]> * Apply suggestions from code review Edits to all files to comply with OpenSearch standards; nav_order updates Signed-off-by: Heather Halter <[email protected]> * Apply suggestions from code review Missed a file - more commits to the sql-query topic Signed-off-by: Heather Halter <[email protected]> * Update _search-plugins/ubi/sql-queries.md Signed-off-by: Heather Halter <[email protected]> * Apply suggestions from code review Cleaned up the sample query topic Signed-off-by: Heather Halter <[email protected]> * Apply suggestions from code review Signed-off-by: Heather Halter <[email protected]> * Update _search-plugins/ubi/dsl-queries.md Signed-off-by: Heather Halter <[email protected]> * Update _search-plugins/ubi/dsl-queries.md Signed-off-by: Heather Halter <[email protected]> * Apply suggestions from code review Accepted editorial suggestions. Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Heather Halter <[email protected]> * Update index.md Reformatted table info Signed-off-by: Heather Halter <[email protected]> * Update _search-plugins/ubi/dsl-queries.md Signed-off-by: Heather Halter <[email protected]> * Apply suggestions from code review Signed-off-by: Heather Halter <[email protected]> * Update index.md Signed-off-by: Heather Halter <[email protected]> * Update schemas.md Signed-off-by: Heather Halter <[email protected]> * Update index.md Added a missing link and fixed the table. Signed-off-by: Heather Halter <[email protected]> * Update index.md Changed the bold to italics Signed-off-by: Heather Halter <[email protected]> * Update ubi-dashboard-tutorial.md Removed unnecessary note tag. Signed-off-by: Heather Halter <[email protected]> * Update schemas.md Inserted comma Signed-off-by: Heather Halter <[email protected]> * Update sql-queries.md Signed-off-by: Heather Halter <[email protected]> * Apply suggestions from code review There were some hidden comments that I found in this file. Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Heather Halter <[email protected]> * Update _search-plugins/ubi/sql-queries.md Signed-off-by: Heather Halter <[email protected]> * Update _search-plugins/ubi/sql-queries.md Signed-off-by: Heather Halter <[email protected]> * Apply suggestions from code review Signed-off-by: Heather Halter <[email protected]> * Update _search-plugins/ubi/schemas.md Signed-off-by: kolchfa-aws <[email protected]> * Apply suggestions from code review Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> * Update schemas.md Removed links on 'object_id' and 'query_id' Signed-off-by: Heather Halter <[email protected]> * Update sql-queries.md removed a note tag and fixed line 326 Signed-off-by: Heather Halter <[email protected]> * Update sql-queries.md One more table heading Signed-off-by: Heather Halter <[email protected]> --------- Signed-off-by: RasonJ <[email protected]> Signed-off-by: Eric Pugh <[email protected]> Signed-off-by: Heather Halter <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> Co-authored-by: Eric Pugh <[email protected]> Co-authored-by: kolchfa-aws <[email protected]> Co-authored-by: Heather Halter <[email protected]> Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Sander van de Geijn <[email protected]>

kolchfa-aws self-assigned this Jun 5, 2024

RasonJ force-pushed the main branch from db74ac5 to 5a0d9b8 Compare June 6, 2024 16:38

RasonJ marked this pull request as ready for review June 6, 2024 16:39

RasonJ requested review from hdhalter, kolchfa-aws, Naarcha-AWS, vagimeli, AMoo-Miki, natebower, dlvenable, stephen-crawford and epugh as code owners June 6, 2024 16:39

hdhalter added 4 - Doc review PR: Doc review in progress v2.15.0 release-notes PR: Include this PR in the automated release notes labels Jun 6, 2024

hdhalter mentioned this pull request Jun 6, 2024

Adding initial User Behavior Insights documentation #6625

Closed

1 task

epugh approved these changes Jun 12, 2024

View reviewed changes

RasonJ force-pushed the main branch from 64d3073 to 326783b Compare June 12, 2024 16:25

RasonJ force-pushed the main branch from 326783b to bc7ee95 Compare June 12, 2024 20:58

RasonJ force-pushed the main branch from bc7ee95 to c9edc86 Compare June 13, 2024 16:28

gathering potential documentation attempts

29dabb9

Signed-off-by: RasonJ <[email protected]>

RasonJ force-pushed the main branch from 559d1b8 to 6f9c073 Compare June 13, 2024 18:13

RasonJ added 2 commits June 13, 2024 11:38

considering the dashboard tutorial

b2cce5b

Signed-off-by: RasonJ <[email protected]>

place holder for js data structure usage

f5c509b

Signed-off-by: RasonJ <[email protected]>

Apply suggestions from code review

510912b

Signed-off-by: Heather Halter <[email protected]>

natebower reviewed Jul 3, 2024

View reviewed changes

_search-plugins/ubi/sql-queries.md Outdated Show resolved Hide resolved

natebower reviewed Jul 3, 2024

View reviewed changes

_search-plugins/ubi/ubi-dashboard-tutorial.md Outdated Show resolved Hide resolved

natebower reviewed Jul 3, 2024

View reviewed changes

_search-plugins/ubi/ubi-dashboard-tutorial.md Outdated Show resolved Hide resolved

natebower reviewed Jul 3, 2024

View reviewed changes

kolchfa-aws reviewed Jul 3, 2024

View reviewed changes

_search-plugins/ubi/schemas.md Outdated Show resolved Hide resolved

Update _search-plugins/ubi/schemas.md

d2a7de0

Signed-off-by: kolchfa-aws <[email protected]>

kolchfa-aws reviewed Jul 3, 2024

View reviewed changes

_search-plugins/ubi/sql-queries.md Outdated Show resolved Hide resolved

kolchfa-aws reviewed Jul 3, 2024

View reviewed changes

_search-plugins/ubi/sql-queries.md Outdated Show resolved Hide resolved

kolchfa-aws reviewed Jul 3, 2024

View reviewed changes

_search-plugins/ubi/ubi-dashboard-tutorial.md Outdated Show resolved Hide resolved

kolchfa-aws reviewed Jul 3, 2024

View reviewed changes

_search-plugins/ubi/ubi-dashboard-tutorial.md Outdated Show resolved Hide resolved

Apply suggestions from code review

3a6ec38

Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: kolchfa-aws <[email protected]>

natebower approved these changes Jul 3, 2024

View reviewed changes

hdhalter added 3 commits July 3, 2024 14:00

Update schemas.md

409dcc0

Removed links on 'object_id' and 'query_id' Signed-off-by: Heather Halter <[email protected]>

Update sql-queries.md

fed4d79

removed a note tag and fixed line 326 Signed-off-by: Heather Halter <[email protected]>

Update sql-queries.md

b8d9bf6

One more table heading Signed-off-by: Heather Halter <[email protected]>

hdhalter changed the title ~~Initial UBI documentation~~ Add documentation for the UBI plugin Jul 3, 2024

hdhalter added 3 - Done Issue is done/complete and removed 5 - Editorial review PR: Editorial review in progress labels Jul 3, 2024

hdhalter merged commit 5db02ca into opensearch-project:main Jul 3, 2024
6 checks passed

opensearch-trigger-bot bot mentioned this pull request Jul 3, 2024

[Backport 2.15] Add documentation for the UBI plugin #7629

Merged

github-actions bot pushed a commit that referenced this pull request Jul 3, 2024

Add documentation for the UBI plugin (#7284) (#7629)

65ffb9c

jzonthemtn mentioned this pull request Jul 24, 2024

[On-boarding]: User Behavior Insights plugin opensearch-project/opensearch-build#4886

Open

kolchfa-aws mentioned this pull request Dec 4, 2024

Delete ruby version file #8879

Merged

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add documentation for the UBI plugin #7284

Add documentation for the UBI plugin #7284

RasonJ commented May 31, 2024

hdhalter commented Jun 6, 2024

epugh commented Jun 7, 2024

epugh commented Jun 8, 2024

epugh left a comment

kolchfa-aws commented Jun 12, 2024

kolchfa-aws commented Jun 12, 2024

kolchfa-aws commented Jun 13, 2024

natebower Jul 3, 2024

natebower Jul 3, 2024

kolchfa-aws Jul 3, 2024

natebower Jul 3, 2024

kolchfa-aws Jul 3, 2024

natebower Jul 3, 2024

kolchfa-aws Jul 3, 2024

natebower left a comment


		To summarize, the `query_id` signals the beginning of a unique search for a client tracked through a `client_id`. The search returns various objects, each with a unique `object_id`. The `action_name` specifies what action the user is performing and is connected to the objects, each with a specific `object_id`. You can differentiate between types of objects by inspecting the `object_id_field`.

		Typically, you can infer the user's overall search history by retrieving all the data for the user's `client_id` and inspecting the individual `query_id` data. Each application decides what makes a search session by examining the data in the backend.

		{: .note}


		The resulting visualization may not be exactly what you're looking for. The `message` field is updated with every event, and as a result, it can contain error messages, debug messages, click information, and other unwanted data.



		The resulting visualization may not be exactly what you're looking for. The `message` field is updated with every event, and as a result, it can contain error messages, debug messages, click information, and other unwanted data.
		To view only search terms for query events, you need to add a filter to your visualization. Because the developer provided a `message_type` of `QUERY` for each search event, you can filter by that message type to isolate the specific users' searches. To do this, select Add filter and then select QUERY in the Edit filter panel, as shown in the following image.

Add documentation for the UBI plugin #7284

Add documentation for the UBI plugin #7284

Conversation

RasonJ commented May 31, 2024

Description

Issues Resolved

Version

Checklist

hdhalter commented Jun 6, 2024

epugh commented Jun 7, 2024

epugh commented Jun 8, 2024

epugh left a comment

Choose a reason for hiding this comment

kolchfa-aws commented Jun 12, 2024

kolchfa-aws commented Jun 12, 2024

kolchfa-aws commented Jun 13, 2024

natebower Jul 3, 2024

Choose a reason for hiding this comment

natebower Jul 3, 2024

Choose a reason for hiding this comment

kolchfa-aws Jul 3, 2024

Choose a reason for hiding this comment

natebower Jul 3, 2024

Choose a reason for hiding this comment

kolchfa-aws Jul 3, 2024

Choose a reason for hiding this comment

natebower Jul 3, 2024

Choose a reason for hiding this comment

kolchfa-aws Jul 3, 2024

Choose a reason for hiding this comment

natebower left a comment

Choose a reason for hiding this comment