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

[Infrastructure UI] Host limit telemetry #155726

Merged
merged 7 commits into from
May 11, 2023

Conversation

crespocarlos
Copy link
Contributor

@crespocarlos crespocarlos commented Apr 25, 2023

closes: #155567

Summary

This PR adds a new custom event to track the total number of hosts, as well as adjusts a few data-test-subj attribute values to meet the naming convention defined in the observability-dev docs

For Reviewers

An option for not allowing yet a new custom event in FS could be triggering the new custom events only for self-managed customers, and in FS watch the element that holds the total number of hosts. But for now, I decided to allow the new custom event in FS for consistency

@crespocarlos crespocarlos added Feature:Metrics UI Metrics UI feature Team:Infra Monitoring UI - DEPRECATED DEPRECATED - Label for the Infra Monitoring UI team. Use Team:obs-ux-infra_services release_note:skip Skip the PR/issue when compiling release notes backport:skip This commit does not require backporting Feature:ObsHosts Hosts feature within Observability v8.8.0 labels Apr 25, 2023
@apmmachine
Copy link
Contributor

🤖 GitHub comments

Expand to view the GitHub comments

Just comment with:

  • /oblt-deploy : Deploy a Kibana instance using the Observability test environments.
  • run elasticsearch-ci/docs : Re-trigger the docs validation. (use unformatted text in the comment!)

@crespocarlos crespocarlos force-pushed the 155576-telemetry-host-limit branch from cf662b4 to 2224bf6 Compare April 25, 2023 14:55
@crespocarlos crespocarlos marked this pull request as ready for review April 25, 2023 15:58
@crespocarlos crespocarlos requested review from a team as code owners April 25, 2023 15:58
@elasticmachine
Copy link
Contributor

Pinging @elastic/infra-monitoring-ui (Team:Infra Monitoring UI)

Copy link
Contributor

@TinaHeiligers TinaHeiligers left a comment

Choose a reason for hiding this comment

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

LGTM

@crespocarlos crespocarlos requested a review from afharo April 25, 2023 16:19
Copy link
Member

@jennypavlova jennypavlova left a comment

Choose a reason for hiding this comment

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

LGTM 🚀

Copy link
Member

@afharo afharo left a comment

Choose a reason for hiding this comment

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

LGTM

@@ -24,6 +24,7 @@ const configSchema = schema.object({
'Host Entry Clicked', // Worst-case scenario once per second - AT RISK,
'Host Flyout Filter Removed', // Worst-case scenario once per second - AT RISK,
'Host Flyout Filter Added', // Worst-case scenario once per second - AT RISK,
'Host View Total Host Count Retrieved', // Worst-case scenario 1 every 2 seconds
Copy link
Member

Choose a reason for hiding this comment

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

cc @shahinakmal FYI, this PR adds another custom event to FS

Copy link
Member

@afharo afharo left a comment

Choose a reason for hiding this comment

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

After checking with @shahinakmal, we shouldn't allow more custom events to be sent to FS.

@roshan-elastic
Copy link

Update:

  • I'm meeting @shahinakmal on Friday to walk through how we can answer the Qs we want with this custom event but only using the telemetry cluster

Context : FullStory Custom Events doesn't look like a scalable solution due to rate limits so it looks like we won't be able to use them moving forward unless absolutely necessary. Hoping we can use the telemetry cluster etc do do this analysis instead.

After that call, we'll make a call on whether the event needs to be whitelisted in FS.

@crespocarlos crespocarlos added backport:prev-minor Backport to (8.x) the previous minor version (i.e. one version back from main) v8.9.0 and removed backport:skip This commit does not require backporting v8.8.0 labels May 2, 2023
@roshan-elastic
Copy link

Hey @crespocarlos @shahinakmal - quick update:

  • @shahinakmal and I walked through the telemetry on Friday
  • We were able to get the data we wanted for this (but with caveats)
  • We are only able to get very small time periods of data - e.g. maybe 15-30 minutes of data before the UI is too slow
  • We need to be able to get weeks/days/months worth of data to make decisions based on the telemetry (something FullStory allowed)

As it stands, without the FullStory custom event - we're not getting the telemetry we need.

I'll send an email internally for next steps on this...

@roshan-elastic
Copy link

Hey @crespocarlos - we can remove the FS whitelisting here and go ahead with this (we'll try to live without the FS custom events given the throttling issues).

OK to proceed on this one?

@shahinakmal FYI - we'll remove it and go ahead as suggested (i.e. we'll use the telemetry cluster instead of FS for these custom events).

@crespocarlos crespocarlos requested a review from afharo May 11, 2023 13:16
@crespocarlos
Copy link
Contributor Author

@elasticmachine merge upstream

Copy link
Member

@afharo afharo left a comment

Choose a reason for hiding this comment

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

Thank you for iterating! LGTM

@kibana-ci
Copy link
Collaborator

💚 Build Succeeded

Metrics [docs]

Async chunks

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

id before after diff
infra 2.0MB 2.0MB +139.0B

Page load bundle

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

id before after diff
infra 101.7KB 102.1KB +418.0B
Unknown metric groups

ESLint disabled line counts

id before after diff
enterpriseSearch 19 21 +2
securitySolution 400 404 +4
total +6

Total ESLint disabled count

id before after diff
enterpriseSearch 20 22 +2
securitySolution 480 484 +4
total +6

History

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

@crespocarlos crespocarlos merged commit 937912b into elastic:main May 11, 2023
kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request May 11, 2023
closes: elastic#155567

## Summary

This PR adds a new custom event to track the total number of hosts, as
well as adjusts a few `data-test-subj` attribute values to meet the
naming convention defined in the observability-dev
[docs](https://github.com/elastic/observability-dev/blob/main/docs/how-we-work/telemetry/telemetry-convention.md#naming-convention)

### For Reviewers

An option for not allowing yet a new custom event in FS could be
triggering the new custom events only for self-managed customers, and in
FS watch the element that holds the total number of hosts. But for now,
I decided to allow the new custom event in FS for consistency

---------

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
(cherry picked from commit 937912b)
@kibanamachine
Copy link
Contributor

💚 All backports created successfully

Status Branch Result
8.8

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

Questions ?

Please refer to the Backport tool documentation

kibanamachine added a commit that referenced this pull request May 11, 2023
# Backport

This will backport the following commits from `main` to `8.8`:
- [[Infrastructure UI] Host limit telemetry
(#155726)](#155726)

<!--- Backport version: 8.9.7 -->

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

<!--BACKPORT [{"author":{"name":"Carlos
Crespo","email":"crespocarlos@users.noreply.github.com"},"sourceCommit":{"committedDate":"2023-05-11T15:44:38Z","message":"[Infrastructure
UI] Host limit telemetry (#155726)\n\ncloses:
https://github.com/elastic/kibana/issues/155567\r\n\r\n##
Summary\r\n\r\nThis PR adds a new custom event to track the total number
of hosts, as\r\nwell as adjusts a few `data-test-subj` attribute values
to meet the\r\nnaming convention defined in the
observability-dev\r\n[docs](https://github.com/elastic/observability-dev/blob/main/docs/how-we-work/telemetry/telemetry-convention.md#naming-convention)\r\n\r\n\r\n###
For Reviewers\r\n\r\nAn option for not allowing yet a new custom event
in FS could be\r\ntriggering the new custom events only for self-managed
customers, and in\r\nFS watch the element that holds the total number of
hosts. But for now,\r\nI decided to allow the new custom event in FS for
consistency\r\n\r\n---------\r\n\r\nCo-authored-by: Kibana Machine
<42973632+kibanamachine@users.noreply.github.com>","sha":"937912b056f5876247f27a7baad5314401e65939","branchLabelMapping":{"^v8.9.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Feature:Metrics
UI","Team:Infra Monitoring
UI","release_note:skip","backport:prev-minor","Feature:ObsHosts","v8.9.0"],"number":155726,"url":"https://github.com/elastic/kibana/pull/155726","mergeCommit":{"message":"[Infrastructure
UI] Host limit telemetry (#155726)\n\ncloses:
https://github.com/elastic/kibana/issues/155567\r\n\r\n##
Summary\r\n\r\nThis PR adds a new custom event to track the total number
of hosts, as\r\nwell as adjusts a few `data-test-subj` attribute values
to meet the\r\nnaming convention defined in the
observability-dev\r\n[docs](https://github.com/elastic/observability-dev/blob/main/docs/how-we-work/telemetry/telemetry-convention.md#naming-convention)\r\n\r\n\r\n###
For Reviewers\r\n\r\nAn option for not allowing yet a new custom event
in FS could be\r\ntriggering the new custom events only for self-managed
customers, and in\r\nFS watch the element that holds the total number of
hosts. But for now,\r\nI decided to allow the new custom event in FS for
consistency\r\n\r\n---------\r\n\r\nCo-authored-by: Kibana Machine
<42973632+kibanamachine@users.noreply.github.com>","sha":"937912b056f5876247f27a7baad5314401e65939"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"main","label":"v8.9.0","labelRegex":"^v8.9.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/155726","number":155726,"mergeCommit":{"message":"[Infrastructure
UI] Host limit telemetry (#155726)\n\ncloses:
https://github.com/elastic/kibana/issues/155567\r\n\r\n##
Summary\r\n\r\nThis PR adds a new custom event to track the total number
of hosts, as\r\nwell as adjusts a few `data-test-subj` attribute values
to meet the\r\nnaming convention defined in the
observability-dev\r\n[docs](https://github.com/elastic/observability-dev/blob/main/docs/how-we-work/telemetry/telemetry-convention.md#naming-convention)\r\n\r\n\r\n###
For Reviewers\r\n\r\nAn option for not allowing yet a new custom event
in FS could be\r\ntriggering the new custom events only for self-managed
customers, and in\r\nFS watch the element that holds the total number of
hosts. But for now,\r\nI decided to allow the new custom event in FS for
consistency\r\n\r\n---------\r\n\r\nCo-authored-by: Kibana Machine
<42973632+kibanamachine@users.noreply.github.com>","sha":"937912b056f5876247f27a7baad5314401e65939"}}]}]
BACKPORT-->

Co-authored-by: Carlos Crespo <crespocarlos@users.noreply.github.com>
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) Feature:Metrics UI Metrics UI feature Feature:ObsHosts Hosts feature within Observability release_note:skip Skip the PR/issue when compiling release notes Team:Infra Monitoring UI - DEPRECATED DEPRECATED - Label for the Infra Monitoring UI team. Use Team:obs-ux-infra_services v8.8.0 v8.9.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Infrastructure UI] Telemetry: Host limit
9 participants