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

[Entity Inventory] Add basic telemetry #197055

Merged
merged 44 commits into from
Oct 25, 2024

Conversation

iblancof
Copy link
Contributor

@iblancof iblancof commented Oct 21, 2024

Summary

Closes #195608.

In this PR, we introduce basic telemetry tracking for the new Inventory plugin.
These events will help us gain insight into how users are interacting with the Inventory feature, including the state of the views, search behaviors, and entity type filtering.

New events

  • Entity Inventory Viewed
  • Entity Inventory Search Query Submitted
  • Entity Inventory Entity Type Filtered
  • Entity View Clicked

Untitled-2024-07-24-1420

New attribute added to global context

  • eem_enabled

It will only be populated if the Inventory plugin is accessible to users and after they access the Observability solution.
If EEM is not enabled and the user enables it, the property will be updated accordingly.

Details about not implementing eem_enabled can be found in this comment.

@iblancof iblancof added release_note:skip Skip the PR/issue when compiling release notes telemetry Issues related to the addition of telemetry to a feature backport:prev-minor Backport to (8.x) the previous minor version (i.e. one version back from main) Team:obs-ux-infra_services Observability Infrastructure & Services User Experience Team v8.16.0 labels Oct 21, 2024
@iblancof iblancof self-assigned this Oct 21, 2024
@iblancof iblancof requested a review from a team as a code owner October 21, 2024 12:54
@elasticmachine
Copy link
Contributor

elasticmachine commented Oct 25, 2024

💚 Build Succeeded

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id before after diff
inventory 226 228 +2

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id before after diff
inventory 218.1KB 219.1KB +1.0KB

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id before after diff
inventory 10.7KB 12.3KB +1.7KB
Unknown metric groups

ESLint disabled line counts

id before after diff
inventory 0 1 +1

Total ESLint disabled count

id before after diff
inventory 4 5 +1

History

cc @iblancof

Copy link
Contributor

@crespocarlos crespocarlos left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@iblancof iblancof merged commit 7d673b8 into elastic:main Oct 25, 2024
27 checks passed
@iblancof iblancof deleted the 195608-eco-inventory-telemetry branch October 25, 2024 14:49
@kibanamachine
Copy link
Contributor

Starting backport for target branches: 8.16, 8.x

https://github.com/elastic/kibana/actions/runs/11520477239

@kibanamachine
Copy link
Contributor

💔 All backports failed

Status Branch Result
8.16 Backport failed because of merge conflicts
8.x Backport failed because of merge conflicts

You might need to backport the following PRs to 8.x:
- [Inventory] List k8s entities in the grid (#197292)

Manual backport

To create the backport manually run:

node scripts/backport --pr 197055

Questions ?

Please refer to the Backport tool documentation

@kibanamachine
Copy link
Contributor

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create automatically backports add a backport:* label or prevent reminders by adding the backport:skip label.
You can also create backports manually by running node scripts/backport --pr 197055 locally

@kibanamachine kibanamachine added the backport missing Added to PRs automatically when the are determined to be missing a backport. label Oct 28, 2024
@crespocarlos
Copy link
Contributor

💚 All backports created successfully

Status Branch Result
8.x
8.16

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

crespocarlos pushed a commit to crespocarlos/kibana that referenced this pull request Oct 28, 2024
## Summary

Closes elastic#195608.

In this PR, we introduce basic telemetry tracking for the new Inventory
plugin.
These events will help us gain insight into how users are interacting
with the Inventory feature, including the state of the views, search
behaviors, and entity type filtering.

**New events**
- Entity Inventory Viewed
- Entity Inventory Search Query Submitted
- Entity Inventory Entity Type Filtered
- Entity View Clicked

![Untitled-2024-07-24-1420](https://github.com/user-attachments/assets/6e85ea00-c626-4bc1-a4f8-9907674eb264)

~**New attribute added to global context**~
- ~eem_enabled~

~It will only be populated if the Inventory plugin is accessible to
users and after they access the Observability solution.
If EEM is not enabled and the user enables it, the property will be
updated accordingly.~

Details about not implementing `eem_enabled` can be found in [this
comment](elastic#197055 (comment)).

(cherry picked from commit 7d673b8)

# Conflicts:
#	x-pack/plugins/observability_solution/inventory/public/components/search_bar/index.tsx
crespocarlos pushed a commit to crespocarlos/kibana that referenced this pull request Oct 28, 2024
## Summary

Closes elastic#195608.

In this PR, we introduce basic telemetry tracking for the new Inventory
plugin.
These events will help us gain insight into how users are interacting
with the Inventory feature, including the state of the views, search
behaviors, and entity type filtering.

**New events**
- Entity Inventory Viewed
- Entity Inventory Search Query Submitted
- Entity Inventory Entity Type Filtered
- Entity View Clicked

![Untitled-2024-07-24-1420](https://github.com/user-attachments/assets/6e85ea00-c626-4bc1-a4f8-9907674eb264)

~**New attribute added to global context**~
- ~eem_enabled~

~It will only be populated if the Inventory plugin is accessible to
users and after they access the Observability solution.
If EEM is not enabled and the user enables it, the property will be
updated accordingly.~

Details about not implementing `eem_enabled` can be found in [this
comment](elastic#197055 (comment)).

(cherry picked from commit 7d673b8)

# Conflicts:
#	x-pack/plugins/observability_solution/inventory/public/components/search_bar/index.tsx
crespocarlos added a commit that referenced this pull request Oct 29, 2024
# Backport

This will backport the following commits from `main` to `8.16`:
- [[Entity Inventory] Add basic telemetry
(#197055)](#197055)

<!--- Backport version: 8.9.8 -->

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

<!--BACKPORT [{"author":{"name":"Irene
Blanco","email":"[email protected]"},"sourceCommit":{"committedDate":"2024-10-25T14:49:49Z","message":"[Entity
Inventory] Add basic telemetry (#197055)\n\n## Summary\r\n\r\nCloses
https://github.com/elastic/kibana/issues/195608.\r\n\r\nIn this PR, we
introduce basic telemetry tracking for the new
Inventory\r\nplugin.\r\nThese events will help us gain insight into how
users are interacting\r\nwith the Inventory feature, including the state
of the views, search\r\nbehaviors, and entity type
filtering.\r\n\r\n\r\n**New events**\r\n- Entity Inventory Viewed\r\n-
Entity Inventory Search Query Submitted\r\n- Entity Inventory Entity
Type Filtered\r\n- Entity View
Clicked\r\n\r\n\r\n![Untitled-2024-07-24-1420](https://github.com/user-attachments/assets/6e85ea00-c626-4bc1-a4f8-9907674eb264)\r\n\r\n\r\n~**New
attribute added to global context**~\r\n- ~eem_enabled~\r\n\r\n~It will
only be populated if the Inventory plugin is accessible to\r\nusers and
after they access the Observability solution.\r\nIf EEM is not enabled
and the user enables it, the property will be\r\nupdated
accordingly.~\r\n\r\nDetails about not implementing `eem_enabled` can be
found in
[this\r\ncomment](https://github.com/elastic/kibana/pull/197055#issuecomment-2432123047).","sha":"7d673b84c3ecec2f6da81b57196301c6e7fe384a","branchLabelMapping":{"^v9.0.0$":"main","^v8.17.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","backport
missing","v9.0.0","telemetry","backport:prev-minor","ci:project-deploy-observability","Team:obs-ux-infra_services","v8.16.0"],"number":197055,"url":"https://github.com/elastic/kibana/pull/197055","mergeCommit":{"message":"[Entity
Inventory] Add basic telemetry (#197055)\n\n## Summary\r\n\r\nCloses
https://github.com/elastic/kibana/issues/195608.\r\n\r\nIn this PR, we
introduce basic telemetry tracking for the new
Inventory\r\nplugin.\r\nThese events will help us gain insight into how
users are interacting\r\nwith the Inventory feature, including the state
of the views, search\r\nbehaviors, and entity type
filtering.\r\n\r\n\r\n**New events**\r\n- Entity Inventory Viewed\r\n-
Entity Inventory Search Query Submitted\r\n- Entity Inventory Entity
Type Filtered\r\n- Entity View
Clicked\r\n\r\n\r\n![Untitled-2024-07-24-1420](https://github.com/user-attachments/assets/6e85ea00-c626-4bc1-a4f8-9907674eb264)\r\n\r\n\r\n~**New
attribute added to global context**~\r\n- ~eem_enabled~\r\n\r\n~It will
only be populated if the Inventory plugin is accessible to\r\nusers and
after they access the Observability solution.\r\nIf EEM is not enabled
and the user enables it, the property will be\r\nupdated
accordingly.~\r\n\r\nDetails about not implementing `eem_enabled` can be
found in
[this\r\ncomment](https://github.com/elastic/kibana/pull/197055#issuecomment-2432123047).","sha":"7d673b84c3ecec2f6da81b57196301c6e7fe384a"}},"sourceBranch":"main","suggestedTargetBranches":["8.16"],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","labelRegex":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/197055","number":197055,"mergeCommit":{"message":"[Entity
Inventory] Add basic telemetry (#197055)\n\n## Summary\r\n\r\nCloses
https://github.com/elastic/kibana/issues/195608.\r\n\r\nIn this PR, we
introduce basic telemetry tracking for the new
Inventory\r\nplugin.\r\nThese events will help us gain insight into how
users are interacting\r\nwith the Inventory feature, including the state
of the views, search\r\nbehaviors, and entity type
filtering.\r\n\r\n\r\n**New events**\r\n- Entity Inventory Viewed\r\n-
Entity Inventory Search Query Submitted\r\n- Entity Inventory Entity
Type Filtered\r\n- Entity View
Clicked\r\n\r\n\r\n![Untitled-2024-07-24-1420](https://github.com/user-attachments/assets/6e85ea00-c626-4bc1-a4f8-9907674eb264)\r\n\r\n\r\n~**New
attribute added to global context**~\r\n- ~eem_enabled~\r\n\r\n~It will
only be populated if the Inventory plugin is accessible to\r\nusers and
after they access the Observability solution.\r\nIf EEM is not enabled
and the user enables it, the property will be\r\nupdated
accordingly.~\r\n\r\nDetails about not implementing `eem_enabled` can be
found in
[this\r\ncomment](https://github.com/elastic/kibana/pull/197055#issuecomment-2432123047).","sha":"7d673b84c3ecec2f6da81b57196301c6e7fe384a"}},{"branch":"8.16","label":"v8.16.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->

---------

Co-authored-by: Irene Blanco <[email protected]>
@kibanamachine
Copy link
Contributor

Looks like this PR has backport PRs but they still haven't been merged. Please merge them ASAP to keep the branches relatively in sync.

crespocarlos added a commit that referenced this pull request Oct 29, 2024
# Backport

This will backport the following commits from `main` to `8.x`:
- [[Entity Inventory] Add basic telemetry
(#197055)](#197055)

<!--- Backport version: 8.9.8 -->

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

<!--BACKPORT [{"author":{"name":"Irene
Blanco","email":"[email protected]"},"sourceCommit":{"committedDate":"2024-10-25T14:49:49Z","message":"[Entity
Inventory] Add basic telemetry (#197055)\n\n## Summary\r\n\r\nCloses
https://github.com/elastic/kibana/issues/195608.\r\n\r\nIn this PR, we
introduce basic telemetry tracking for the new
Inventory\r\nplugin.\r\nThese events will help us gain insight into how
users are interacting\r\nwith the Inventory feature, including the state
of the views, search\r\nbehaviors, and entity type
filtering.\r\n\r\n\r\n**New events**\r\n- Entity Inventory Viewed\r\n-
Entity Inventory Search Query Submitted\r\n- Entity Inventory Entity
Type Filtered\r\n- Entity View
Clicked\r\n\r\n\r\n![Untitled-2024-07-24-1420](https://github.com/user-attachments/assets/6e85ea00-c626-4bc1-a4f8-9907674eb264)\r\n\r\n\r\n~**New
attribute added to global context**~\r\n- ~eem_enabled~\r\n\r\n~It will
only be populated if the Inventory plugin is accessible to\r\nusers and
after they access the Observability solution.\r\nIf EEM is not enabled
and the user enables it, the property will be\r\nupdated
accordingly.~\r\n\r\nDetails about not implementing `eem_enabled` can be
found in
[this\r\ncomment](https://github.com/elastic/kibana/pull/197055#issuecomment-2432123047).","sha":"7d673b84c3ecec2f6da81b57196301c6e7fe384a","branchLabelMapping":{"^v9.0.0$":"main","^v8.17.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","backport
missing","v9.0.0","telemetry","backport:prev-minor","ci:project-deploy-observability","Team:obs-ux-infra_services","v8.16.0"],"number":197055,"url":"https://github.com/elastic/kibana/pull/197055","mergeCommit":{"message":"[Entity
Inventory] Add basic telemetry (#197055)\n\n## Summary\r\n\r\nCloses
https://github.com/elastic/kibana/issues/195608.\r\n\r\nIn this PR, we
introduce basic telemetry tracking for the new
Inventory\r\nplugin.\r\nThese events will help us gain insight into how
users are interacting\r\nwith the Inventory feature, including the state
of the views, search\r\nbehaviors, and entity type
filtering.\r\n\r\n\r\n**New events**\r\n- Entity Inventory Viewed\r\n-
Entity Inventory Search Query Submitted\r\n- Entity Inventory Entity
Type Filtered\r\n- Entity View
Clicked\r\n\r\n\r\n![Untitled-2024-07-24-1420](https://github.com/user-attachments/assets/6e85ea00-c626-4bc1-a4f8-9907674eb264)\r\n\r\n\r\n~**New
attribute added to global context**~\r\n- ~eem_enabled~\r\n\r\n~It will
only be populated if the Inventory plugin is accessible to\r\nusers and
after they access the Observability solution.\r\nIf EEM is not enabled
and the user enables it, the property will be\r\nupdated
accordingly.~\r\n\r\nDetails about not implementing `eem_enabled` can be
found in
[this\r\ncomment](https://github.com/elastic/kibana/pull/197055#issuecomment-2432123047).","sha":"7d673b84c3ecec2f6da81b57196301c6e7fe384a"}},"sourceBranch":"main","suggestedTargetBranches":["8.16"],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","labelRegex":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/197055","number":197055,"mergeCommit":{"message":"[Entity
Inventory] Add basic telemetry (#197055)\n\n## Summary\r\n\r\nCloses
https://github.com/elastic/kibana/issues/195608.\r\n\r\nIn this PR, we
introduce basic telemetry tracking for the new
Inventory\r\nplugin.\r\nThese events will help us gain insight into how
users are interacting\r\nwith the Inventory feature, including the state
of the views, search\r\nbehaviors, and entity type
filtering.\r\n\r\n\r\n**New events**\r\n- Entity Inventory Viewed\r\n-
Entity Inventory Search Query Submitted\r\n- Entity Inventory Entity
Type Filtered\r\n- Entity View
Clicked\r\n\r\n\r\n![Untitled-2024-07-24-1420](https://github.com/user-attachments/assets/6e85ea00-c626-4bc1-a4f8-9907674eb264)\r\n\r\n\r\n~**New
attribute added to global context**~\r\n- ~eem_enabled~\r\n\r\n~It will
only be populated if the Inventory plugin is accessible to\r\nusers and
after they access the Observability solution.\r\nIf EEM is not enabled
and the user enables it, the property will be\r\nupdated
accordingly.~\r\n\r\nDetails about not implementing `eem_enabled` can be
found in
[this\r\ncomment](https://github.com/elastic/kibana/pull/197055#issuecomment-2432123047).","sha":"7d673b84c3ecec2f6da81b57196301c6e7fe384a"}},{"branch":"8.16","label":"v8.16.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->

---------

Co-authored-by: Irene Blanco <[email protected]>
Co-authored-by: Elastic Machine <[email protected]>
@kibanamachine kibanamachine added v8.17.0 and removed backport missing Added to PRs automatically when the are determined to be missing a backport. labels Oct 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport:prev-minor Backport to (8.x) the previous minor version (i.e. one version back from main) ci:project-deploy-observability Create an Observability project release_note:skip Skip the PR/issue when compiling release notes Team:obs-ux-infra_services Observability Infrastructure & Services User Experience Team telemetry Issues related to the addition of telemetry to a feature v8.16.0 v8.17.0 v9.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[ECO] Inventory Telemetry
6 participants