rokwire / illinois-app

Source code repository of "Illinois" App - the official mobile app of the University of Illinois.
https://app.illinois.edu/
Apache License 2.0
23 stars 20 forks source link

[FEATURE] Add Illinois App logs for search terms #4305

Open yoonlees opened 1 month ago

yoonlees commented 1 month ago

Is your feature request related to a problem? Please describe. There is no problem with the current Illinois app logging, but we want to enrich more.

Describe the solution you'd like Add new logs to be ingested into Splunk for search terms related to events, groups, building locations, etc.

Describe alternatives you've considered None

Additional context None

@cschwin2, please feel free to add more comments to help.

cschwin2 commented 1 month ago

Thank you, @yoonlees.

For some additional context, we are wanting to see the actual text that a user searched within various features of the app. As an example, I went to Events > All Events and then typed "speaker" into the search bar. Here is the relevant log associated with the action of tapping the search icon:

event: feature: Events name: select page: Event2SearchPanel source: null target: Search target_feature: null

The requested additional field could look something like:

search_text: speaker

We would ideally have this for every page in the app that has a search/text input option, such as Groups, Events, Illinois Assistant, etc.

Thank you!

mihail-varbanov commented 1 month ago

Hi @cschwin2,

I think that adding this data to the select event attributes is not such a good idea. The primary purpose of this event is to inform Splunk about some user action - taping on a UI control. If the search edit control contains empty text we will send the select event but will not perform any search. This is not a real case in the Illinois app but theoretically search operation can be performed not only on tapping a particular button. For example, search could be performed synchronously as the user types. So my suggestion is to post separate event every time a search operation is performed, e.g.:

name: search
term: abracadabra
page: Event2SearchPanel
feature: Events

Does this sounds good to you?

cschwin2 commented 1 month ago

@mihail-varbanov, that makes sense and sounds good to me. Thank you!

mihail-varbanov commented 1 month ago

@cschwin2, great, the new search event is added in app version 6.1.7. Please contact @pmarkhennessy if you need a developer build of this version.

cschwin2 commented 1 month ago

@mihail-varbanov, fantastic, thank you very much! I don't think a developer build is necessary at this time, but I will contact him if that changes.