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.

Sign up for GitHub

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

Jump to bottom

[OneDiscover] Add contextual awareness resolution results to EBT telemetry events #186109

Closed
Tracked by #182073
kertal opened this issue Jun 12, 2024 · 1 comment · Fixed by #192908
Closed
Tracked by #182073

[OneDiscover] Add contextual awareness resolution results to EBT telemetry events #186109

kertal opened this issue Jun 12, 2024 · 1 comment · Fixed by #192908
Assignees
@jughosta
Labels
impact:high Addressing this issue will have a high level of impact on the quality/strength of our product. Project:OneDiscover Enrich Discover with contextual awareness Team:DataDiscovery Discover, search (e.g. data plugin and KQL), data views, saved searches. For ES|QL, use Team:ES|QL. telemetry Issues related to the addition of telemetry to a feature

Comments

@kertal
Copy link
Member

kertal commented Jun 12, 2024

📓 Summary

To allow better and more granular telemetry analysis about the contextual resolution in Discover, Event-Based-Telemetry (EBT) events context should be extended by a new property called discover_profiles or discover_context. This property will contain an array of active profiles, e.g. observability-root, logs-data-source (or root-observabilty, data-source-logs), allowing to get insights in which discover context other EBT events like click are logged.

What we intend to log is

  • Root Context
  • Data Source Context

What is currently out of scope

  • Document Context (they are not global values like the other profile types)

More infos about how to extend EBT context can be found here

https://docs.elastic.dev/telemetry/collection/event-based-telemetry#adding-context-to-the-event

✔️ Acceptance criteria

  • Extend EBT Based Telemetry by Contextual Awareness Data, logging Root & Data Source Context (when available)
  • Aim to keep the extension simple, by using just a single property, because "Note that currently, the context is attached to all events, which means we have to be extra careful polluting abusing this feature"
@kertal kertal added the Project:OneDiscover Enrich Discover with contextual awareness label Jun 12, 2024
@botelastic botelastic bot added the needs-team Issues missing a team label label Jun 12, 2024
@kertal kertal added Team:DataDiscovery Discover, search (e.g. data plugin and KQL), data views, saved searches. For ES|QL, use Team:ES|QL. and removed needs-team Issues missing a team label labels Jun 12, 2024
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-data-discovery (Team:DataDiscovery)

@kertal kertal added the impact:high Addressing this issue will have a high level of impact on the quality/strength of our product. label Jun 12, 2024
@kertal kertal added the telemetry Issues related to the addition of telemetry to a feature label Jun 12, 2024
@kertal kertal changed the title [Discover] Add contextual awareness resolution results to EBT events [Discover] Add contextual awareness resolution results to EBT telemetry events Jun 18, 2024
@kertal kertal mentioned this issue Jun 24, 2024
Open
@jughosta jughosta mentioned this issue Sep 13, 2024
Merged
1 task
@jughosta jughosta self-assigned this Sep 17, 2024
@kertal kertal changed the title [Discover] Add contextual awareness resolution results to EBT telemetry events [OneDiscover] Add contextual awareness resolution results to EBT telemetry events Sep 18, 2024
kibanamachine pushed a commit to kibanamachine/kibana that referenced this issue Sep 24, 2024
@jughosta
[Discover] Extend EBT context with a list of activated context-aware …
53f3e28 
…profiles (elastic#192908)

- Closes elastic#186109

## Summary

This PR extends EBT context with `dscProfiles` - a list of active
context-aware profiles.

<img width="981" alt="Screenshot 2024-09-16 at 17 30 47"
src="https://github.com/user-attachments/assets/64d49abc-3ee0-4d5a-8283-cdca5d78f963">

## Testing

Enable "Usage collection" global setting.

Navigate to Discover and observe `kibana-browser` requests in Network
tab.

### Checklist

- [x] [Unit or functional
tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)
were updated or added to match the most common scenarios

---------

Co-authored-by: kibanamachine <[email protected]>
(cherry picked from commit c28af87)
kibanamachine referenced this issue Sep 24, 2024
@kibanamachine @jughosta
[8.x] [Discover] Extend EBT context with a list of activated context-…
21196a5 
…aware profiles (#192908) (#193926)

# Backport

This will backport the following commits from `main` to `8.x`:
- [[Discover] Extend EBT context with a list of activated context-aware
profiles (#192908)](#192908)

<!--- Backport version: 9.4.3 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Julia
Rechkunova","email":"[email protected]"},"sourceCommit":{"committedDate":"2024-09-24T21:08:21Z","message":"[Discover]
Extend EBT context with a list of activated context-aware profiles
(#192908)\n\n- Closes
https://github.com/elastic/kibana/issues/186109\r\n\r\n##
Summary\r\n\r\nThis PR extends EBT context with `dscProfiles` - a list
of active\r\ncontext-aware profiles.\r\n\r\n<img width=\"981\"
alt=\"Screenshot 2024-09-16 at 17 30
47\"\r\nsrc=\"https://github.com/user-attachments/assets/64d49abc-3ee0-4d5a-8283-cdca5d78f963\">\r\n\r\n\r\n##
Testing\r\n\r\nEnable \"Usage collection\" global
setting.\r\n\r\nNavigate to Discover and observe `kibana-browser`
requests in Network\r\ntab.\r\n\r\n### Checklist\r\n\r\n- [x] [Unit or
functional\r\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\r\nwere
updated or added to match the most common
scenarios\r\n\r\n---------\r\n\r\nCo-authored-by: kibanamachine
<[email protected]>","sha":"c28af871d2fa4d8e9f0edd0eafad4d10669a62f5","branchLabelMapping":{"^v9.0.0$":"main","^v8.16.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","v9.0.0","Team:DataDiscovery","backport:prev-minor","Project:OneDiscover"],"title":"[Discover]
Extend EBT context with a list of activated context-aware
profiles","number":192908,"url":"https://github.com/elastic/kibana/pull/192908","mergeCommit":{"message":"[Discover]
Extend EBT context with a list of activated context-aware profiles
(#192908)\n\n- Closes
https://github.com/elastic/kibana/issues/186109\r\n\r\n##
Summary\r\n\r\nThis PR extends EBT context with `dscProfiles` - a list
of active\r\ncontext-aware profiles.\r\n\r\n<img width=\"981\"
alt=\"Screenshot 2024-09-16 at 17 30
47\"\r\nsrc=\"https://github.com/user-attachments/assets/64d49abc-3ee0-4d5a-8283-cdca5d78f963\">\r\n\r\n\r\n##
Testing\r\n\r\nEnable \"Usage collection\" global
setting.\r\n\r\nNavigate to Discover and observe `kibana-browser`
requests in Network\r\ntab.\r\n\r\n### Checklist\r\n\r\n- [x] [Unit or
functional\r\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\r\nwere
updated or added to match the most common
scenarios\r\n\r\n---------\r\n\r\nCo-authored-by: kibanamachine
<[email protected]>","sha":"c28af871d2fa4d8e9f0edd0eafad4d10669a62f5"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","branchLabelMappingKey":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/192908","number":192908,"mergeCommit":{"message":"[Discover]
Extend EBT context with a list of activated context-aware profiles
(#192908)\n\n- Closes
https://github.com/elastic/kibana/issues/186109\r\n\r\n##
Summary\r\n\r\nThis PR extends EBT context with `dscProfiles` - a list
of active\r\ncontext-aware profiles.\r\n\r\n<img width=\"981\"
alt=\"Screenshot 2024-09-16 at 17 30
47\"\r\nsrc=\"https://github.com/user-attachments/assets/64d49abc-3ee0-4d5a-8283-cdca5d78f963\">\r\n\r\n\r\n##
Testing\r\n\r\nEnable \"Usage collection\" global
setting.\r\n\r\nNavigate to Discover and observe `kibana-browser`
requests in Network\r\ntab.\r\n\r\n### Checklist\r\n\r\n- [x] [Unit or
functional\r\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\r\nwere
updated or added to match the most common
scenarios\r\n\r\n---------\r\n\r\nCo-authored-by: kibanamachine
<[email protected]>","sha":"c28af871d2fa4d8e9f0edd0eafad4d10669a62f5"}}]}]
BACKPORT-->

Co-authored-by: Julia Rechkunova <[email protected]>
@davismcphee davismcphee mentioned this issue Nov 14, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jughosta jughosta

Labels
impact:high Addressing this issue will have a high level of impact on the quality/strength of our product. Project:OneDiscover Enrich Discover with contextual awareness Team:DataDiscovery Discover, search (e.g. data plugin and KQL), data views, saved searches. For ES|QL, use Team:ES|QL. telemetry Issues related to the addition of telemetry to a feature
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

[Discover] Extend EBT context with a list of activated context-aware profiles jughosta/kibana
4 participants
@mattkime @kertal @jughosta @elasticmachine