Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add telemetry for offline freetext searching #9489

Open
jkuester opened this issue Oct 2, 2024 · 0 comments · May be fixed by #9525
Open

Add telemetry for offline freetext searching #9489

jkuester opened this issue Oct 2, 2024 · 0 comments · May be fixed by #9525
Assignees
Labels
Type: Feature Add something new
Milestone

Comments

@jkuester
Copy link
Contributor

jkuester commented Oct 2, 2024

Is your feature request related to a problem? Please describe.

During our research for #9293 it has become clear that we currently cannot make any changes to the offline freetext search experience without potentially affecting user workflows because we simply have no way to be sure how users are actually interacting with the freetext search (for both contacts and reports).

For example, in interviews with users, they mention searching by contact name. However, in practice we know that contact names are often de-normalized into various custom fields on both contacts and reports. So, simply indexing the name fields on contacts may not be enough to support user workflows. Most importantly, we just do not have any way to know the answer here one way or the other. The users, themselves, are probably not aware of the exact field structure on the documents they are searching for.

Describe the solution you'd like

One reason we are not currently collecting any search telemetry data is because it is likely that the search terms provided by the user will contain PII and we want to avoid logging PII in telemetry docs.

The proposal here is to add telemetry that is more holistically focused on the search workflow. Instead of merely logging what terms the user searches for, we want to focus on the whole process whereby a user searches for something and then actually selects ones of the filtered reports/contacts. Once a user chooses a report/contact to navigate to, we do a comparison between the contents of the report/contact with the user's search term and find the doc fields that were matched by the search query. Then we can log telemetry indicating a search happened (but do not include the exact search terms). Instead we can include information about the report/contact that the user ended up selecting and espeically the names of the doc fields that were matched by the search query. In this way, we avoid including PII in the telemetry, but can still construct an (imperfect) image of the kinds of things users are searching for....

Describe alternatives you've considered

Not collecting any telemetry means that any changes we make to offline freetext search functionality will be done without any way of realistically quantifying their impact.

OTOH, if we log PII in telemetry, it would make it more difficult to collect telemetry data from partners. Extra care must be taken when storing/transmitting this kind of info.

@jkuester jkuester added the Type: Feature Add something new label Oct 2, 2024
@m5r m5r added this to the 4.13.0 milestone Oct 9, 2024
@m5r m5r linked a pull request Oct 10, 2024 that will close this issue
5 tasks
@m5r m5r modified the milestones: 4.13.0, 4.14.0 Oct 16, 2024
@m5r m5r linked a pull request Oct 16, 2024 that will close this issue
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Feature Add something new
Projects
Status: This Week's commitments
Development

Successfully merging a pull request may close this issue.

2 participants