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

[SecuritySolution][Onboarding] Send Telemetry when header/footer cards are clicked #196495

Merged

Conversation

agusruidiazgd
Copy link
Contributor

@agusruidiazgd agusruidiazgd commented Oct 16, 2024

Summary

#196145

To verify:

  1. Add these lines to kibana.dev.yml
logging.browser.root.level: debug
telemetry.optIn: true


2. In the onboarding hub, click on header cards.
It should log onboarding_card_${cardId} on cards clicked.
Screenshot 2024-10-16 at 10 30 58
Screenshot 2024-10-15 at 16 54 32


3. It should log onboarding_footer_link_${footerLinkId} on footer links visited.
Screenshot 2024-10-16 at 10 31 26

Screenshot 2024-10-15 at 17 29 59

Checklist

Delete any items that are not applicable to this PR.

@agusruidiazgd agusruidiazgd self-assigned this Oct 16, 2024
@agusruidiazgd agusruidiazgd changed the title Feat/onboarding header cards telemetry Onboarding header/footer cards telemetry Oct 16, 2024
@agusruidiazgd
Copy link
Contributor Author

/ci

@agusruidiazgd
Copy link
Contributor Author

/ci

@agusruidiazgd agusruidiazgd added release_note:skip Skip the PR/issue when compiling release notes backport:skip This commit does not require backporting v9.0.0 Team:Threat Hunting:Explore ci:cloud-deploy Create or update a Cloud deployment v8.16.0 backport labels Oct 23, 2024
@agusruidiazgd agusruidiazgd marked this pull request as ready for review October 23, 2024 08:24
@agusruidiazgd agusruidiazgd requested a review from a team as a code owner October 23, 2024 08:24
@elasticmachine
Copy link
Contributor

Pinging @elastic/security-threat-hunting-explore (Team:Threat Hunting:Explore)

@agusruidiazgd agusruidiazgd changed the title Onboarding header/footer cards telemetry [SecuritySolution][Onboarding] Send Telemetry when header/footer cards are clicked Oct 23, 2024
Copy link
Contributor

@semd semd left a comment

Choose a reason for hiding this comment

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

LGTM! thanks 💯

@elasticmachine
Copy link
Contributor

elasticmachine commented Oct 23, 2024

💚 Build Succeeded

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id before after diff
securitySolution 6039 6041 +2

Async chunks

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

id before after diff
securitySolution 20.7MB 20.7MB +849.0B
Unknown metric groups

ESLint disabled line counts

id before after diff
securitySolution 551 552 +1

Total ESLint disabled count

id before after diff
securitySolution 637 638 +1

History

cc @agusruidiazgd

@agusruidiazgd agusruidiazgd merged commit e38b4df into elastic:main Oct 23, 2024
45 checks passed
@angorayc
Copy link
Contributor

Telemetry added:

Header:

  1. onboarding_header_card_video
  2. onboarding_header_card_teammates
  3. onboarding_header_card_demo

Footer:

  1. onboarding_footer_link_document
  2. onboarding_footer_link_forum
  3. onboarding_footer_link_demo
  4. onboarding_footer_link_labs

semd pushed a commit to semd/kibana that referenced this pull request Nov 29, 2024
…s are clicked (elastic#196495)

## Summary

elastic#196145

To verify:

1. Add these lines to kibana.dev.yml
```
logging.browser.root.level: debug
telemetry.optIn: true
```
\
2. In the onboarding hub, click on header cards.
It should log `onboarding_card_${cardId}` on cards clicked.
<img width="1101" alt="Screenshot 2024-10-16 at 10 30 58"
src="https://github.com/user-attachments/assets/902848f2-fdc5-412d-bfe0-9ed51ba87c56">
<img width="1258" alt="Screenshot 2024-10-15 at 16 54 32"
src="https://github.com/user-attachments/assets/883a49a2-cd78-4438-91bb-21b2842b8893">

\
3. It should log `onboarding_footer_link_${footerLinkId}` on footer
links visited.
<img width="1019" alt="Screenshot 2024-10-16 at 10 31 26"
src="https://github.com/user-attachments/assets/a7ff80a7-a30d-42e9-84d3-5a14fd243022">

<img width="1200" alt="Screenshot 2024-10-15 at 17 29 59"
src="https://github.com/user-attachments/assets/3034ca61-425b-47f5-a415-8bf6065f2c6f">

### Checklist

Delete any items that are not applicable to this PR.

- [ ] Any text added follows [EUI's writing
guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses
sentence case text and includes [i18n
support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)
- [ ]
[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)
was added for features that require explanation or tutorials
- [ ] [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

(cherry picked from commit e38b4df)
@semd
Copy link
Contributor

semd commented Nov 29, 2024

💚 All backports created successfully

Status Branch Result
8.x

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

Questions ?

Please refer to the Backport tool documentation

semd added a commit that referenced this pull request Nov 29, 2024
…r cards are clicked (#196495) (#202309)

# Backport

This will backport the following commits from `main` to `8.x`:
- [[SecuritySolution][Onboarding] Send Telemetry when header/footer
cards are clicked
(#196495)](#196495)

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

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

<!--BACKPORT [{"author":{"name":"Agustina Nahir
Ruidiaz","email":"[email protected]"},"sourceCommit":{"committedDate":"2024-10-23T12:42:36Z","message":"[SecuritySolution][Onboarding]
Send Telemetry when header/footer cards are clicked (#196495)\n\n##
Summary\r\n\r\n#196145\r\n\r\nTo verify:\r\n\r\n\r\n1. Add these lines
to kibana.dev.yml\r\n```\r\nlogging.browser.root.level:
debug\r\ntelemetry.optIn: true\r\n```\r\n\\\r\n2. In the onboarding hub,
click on header cards.\r\nIt should log `onboarding_card_${cardId}` on
cards clicked.\r\n<img width=\"1101\" alt=\"Screenshot 2024-10-16 at 10
30
58\"\r\nsrc=\"https://github.com/user-attachments/assets/902848f2-fdc5-412d-bfe0-9ed51ba87c56\">\r\n<img
width=\"1258\" alt=\"Screenshot 2024-10-15 at 16 54
32\"\r\nsrc=\"https://github.com/user-attachments/assets/883a49a2-cd78-4438-91bb-21b2842b8893\">\r\n\r\n\\\r\n3.
It should log `onboarding_footer_link_${footerLinkId}` on
footer\r\nlinks visited.\r\n<img width=\"1019\" alt=\"Screenshot
2024-10-16 at 10 31
26\"\r\nsrc=\"https://github.com/user-attachments/assets/a7ff80a7-a30d-42e9-84d3-5a14fd243022\">\r\n\r\n<img
width=\"1200\" alt=\"Screenshot 2024-10-15 at 17 29
59\"\r\nsrc=\"https://github.com/user-attachments/assets/3034ca61-425b-47f5-a415-8bf6065f2c6f\">\r\n\r\n\r\n###
Checklist\r\n\r\nDelete any items that are not applicable to this
PR.\r\n\r\n- [ ] Any text added follows [EUI's
writing\r\nguidelines](https://elastic.github.io/eui/#/guidelines/writing),
uses\r\nsentence case text and includes
[i18n\r\nsupport](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)\r\n-
[
]\r\n[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)\r\nwas
added for features that require explanation or tutorials\r\n- [ ] [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","sha":"e38b4df83db4c56a747b88642c7458a88dd10822","branchLabelMapping":{"^v9.0.0$":"main","^v8.17.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["backport","release_note:skip","backport:skip","v9.0.0","Team:Threat
Hunting:Explore","ci:cloud-deploy","v8.16.0"],"number":196495,"url":"https://github.com/elastic/kibana/pull/196495","mergeCommit":{"message":"[SecuritySolution][Onboarding]
Send Telemetry when header/footer cards are clicked (#196495)\n\n##
Summary\r\n\r\n#196145\r\n\r\nTo verify:\r\n\r\n\r\n1. Add these lines
to kibana.dev.yml\r\n```\r\nlogging.browser.root.level:
debug\r\ntelemetry.optIn: true\r\n```\r\n\\\r\n2. In the onboarding hub,
click on header cards.\r\nIt should log `onboarding_card_${cardId}` on
cards clicked.\r\n<img width=\"1101\" alt=\"Screenshot 2024-10-16 at 10
30
58\"\r\nsrc=\"https://github.com/user-attachments/assets/902848f2-fdc5-412d-bfe0-9ed51ba87c56\">\r\n<img
width=\"1258\" alt=\"Screenshot 2024-10-15 at 16 54
32\"\r\nsrc=\"https://github.com/user-attachments/assets/883a49a2-cd78-4438-91bb-21b2842b8893\">\r\n\r\n\\\r\n3.
It should log `onboarding_footer_link_${footerLinkId}` on
footer\r\nlinks visited.\r\n<img width=\"1019\" alt=\"Screenshot
2024-10-16 at 10 31
26\"\r\nsrc=\"https://github.com/user-attachments/assets/a7ff80a7-a30d-42e9-84d3-5a14fd243022\">\r\n\r\n<img
width=\"1200\" alt=\"Screenshot 2024-10-15 at 17 29
59\"\r\nsrc=\"https://github.com/user-attachments/assets/3034ca61-425b-47f5-a415-8bf6065f2c6f\">\r\n\r\n\r\n###
Checklist\r\n\r\nDelete any items that are not applicable to this
PR.\r\n\r\n- [ ] Any text added follows [EUI's
writing\r\nguidelines](https://elastic.github.io/eui/#/guidelines/writing),
uses\r\nsentence case text and includes
[i18n\r\nsupport](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)\r\n-
[
]\r\n[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)\r\nwas
added for features that require explanation or tutorials\r\n- [ ] [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","sha":"e38b4df83db4c56a747b88642c7458a88dd10822"}},"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/196495","number":196495,"mergeCommit":{"message":"[SecuritySolution][Onboarding]
Send Telemetry when header/footer cards are clicked (#196495)\n\n##
Summary\r\n\r\n#196145\r\n\r\nTo verify:\r\n\r\n\r\n1. Add these lines
to kibana.dev.yml\r\n```\r\nlogging.browser.root.level:
debug\r\ntelemetry.optIn: true\r\n```\r\n\\\r\n2. In the onboarding hub,
click on header cards.\r\nIt should log `onboarding_card_${cardId}` on
cards clicked.\r\n<img width=\"1101\" alt=\"Screenshot 2024-10-16 at 10
30
58\"\r\nsrc=\"https://github.com/user-attachments/assets/902848f2-fdc5-412d-bfe0-9ed51ba87c56\">\r\n<img
width=\"1258\" alt=\"Screenshot 2024-10-15 at 16 54
32\"\r\nsrc=\"https://github.com/user-attachments/assets/883a49a2-cd78-4438-91bb-21b2842b8893\">\r\n\r\n\\\r\n3.
It should log `onboarding_footer_link_${footerLinkId}` on
footer\r\nlinks visited.\r\n<img width=\"1019\" alt=\"Screenshot
2024-10-16 at 10 31
26\"\r\nsrc=\"https://github.com/user-attachments/assets/a7ff80a7-a30d-42e9-84d3-5a14fd243022\">\r\n\r\n<img
width=\"1200\" alt=\"Screenshot 2024-10-15 at 17 29
59\"\r\nsrc=\"https://github.com/user-attachments/assets/3034ca61-425b-47f5-a415-8bf6065f2c6f\">\r\n\r\n\r\n###
Checklist\r\n\r\nDelete any items that are not applicable to this
PR.\r\n\r\n- [ ] Any text added follows [EUI's
writing\r\nguidelines](https://elastic.github.io/eui/#/guidelines/writing),
uses\r\nsentence case text and includes
[i18n\r\nsupport](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)\r\n-
[
]\r\n[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)\r\nwas
added for features that require explanation or tutorials\r\n- [ ] [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","sha":"e38b4df83db4c56a747b88642c7458a88dd10822"}},{"branch":"8.16","label":"v8.16.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->

Co-authored-by: Agustina Nahir Ruidiaz <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport:skip This commit does not require backporting backport ci:cloud-deploy Create or update a Cloud deployment release_note:skip Skip the PR/issue when compiling release notes Team:Threat Hunting:Explore v8.16.0 v8.18.0 v9.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants