[Dashboard] [Telemetry] Report panels in dashboards by type #130166

Heenawter · 2022-04-13T17:16:48Z

Summary

This PR adjusts the old dashboard panel telemetry to have the following structure:

"dashboard": {
  "panels": {
    "total": 35,
    "by_reference": 30,
    "by_value": 5,
    "by_type": {
      "lens": {
        "total": 16,
        "by_reference": 13,
        "by_value": 3,
        "details": {}
      },
      "visualization": {
        "total": 16,
        "by_reference": 14,
        "by_value": 2,
        "details": {
          "dynamic_actions_count": 1,
          "dynamic_actions_actions_dashboard_to_dashboard_drilldown_count": 1,
          "dynamic_actions_triggers_filter_trigger_count": 1,
          "dynamic_actions_action_triggers_dashboard_to_dashboard_drilldown_filter_trigger_count": 1
        }
      },
      "search": {
        "total": 2,
        "by_reference": 2,
        "by_value": 0,
        "details": {}
      },
      "map": {
        "total": 1,
        "by_reference": 1,
        "by_value": 0,
        "details": {}
      }
    }
  }
}

Checklist

Delete any items that are not applicable to this PR.

Unit or functional tests were updated or added to match the most common scenarios

elasticmachine · 2022-04-14T15:48:13Z

Pinging @elastic/kibana-presentation (Team:Presentation)

ThomThomson

This re-structure looks good to me, and fits perfectly with how I was planning on doing the controls telemetry! Just left one nit about the typings.

ThomThomson · 2022-04-14T18:20:52Z

src/plugins/dashboard/server/usage/dashboard_telemetry.ts

+        by_reference: number;
+        by_value: number;
+        details: {
+          [key: string]: number;


The one nit I have here is that the details mapping is maybe too specific. If Lens for example, wanted to track something else, we'd be narrowing the type down too far. The schema would also need to be updated.

Looked in to that, and it doesn't seem like it's possible with the current limitations on the schema object. Basically, the only types that are supported are:

I thought about making it details: { [key: string]: unknown; } and giving the schema { type: object } but that doesn't seem to be supported. @elastic/kibana-telemetry might be able to help us out here, but for now I think we have to stick to a flat JSON object for details 🤷

Thanks for looking into this! Strange that only a subset of types are supported, but I suppose it makes sense if things are expected to mostly be counters. Leaving it as is sounds good to me!

ThomThomson · 2022-04-14T18:21:16Z

src/plugins/dashboard/server/usage/dashboard_telemetry.ts

+    // the following "details" need a follow-up that will actually properly consolidate
+    // the data from all embeddables - right now, the only data that is kept is the
+    // telemetry for the **final** embeddable of that type
+    collectorData.panels.by_type[type].details = embeddableService.telemetry(


This is awesome 🔥

…-fix'

kibana-ci · 2022-04-18T17:13:07Z

💚 Build Succeeded

Metrics [docs]

✅ unchanged

History

💚 Build #38266 succeeded 00bc5e1
💔 Build #38082 failed b4a78e1
💔 Build #38058 failed 5a29844
💔 Build #37985 failed 9bca109

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

cc @Heenawter

* Add new panel telemetry * Restructure panel data to sort by type first * Fix jest tests + slight restructure * [CI] Auto-commit changed files from 'node scripts/eslint --no-cache --fix' Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com> (cherry picked from commit 64d7bcc)

kibanamachine · 2022-04-21T15:29:08Z

💚 All backports created successfully

Status	Branch	Result
✅	8.2
✅	7.17

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

Questions ?

Please refer to the Backport tool documentation

…30166) (#130804) * [Dashboard] [Telemetry] Report panels in dashboards by type (#130166) * Add new panel telemetry * Restructure panel data to sort by type first * Fix jest tests + slight restructure * [CI] Auto-commit changed files from 'node scripts/eslint --no-cache --fix' Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com> (cherry picked from commit 64d7bcc) * Fix conflicts Co-authored-by: Hannah Mudge <Heenawter@users.noreply.github.com> Co-authored-by: heenawter <hannah.wright@elastic.co>

…130166) (#130805) * [Dashboard] [Telemetry] Report panels in dashboards by type (#130166) * Add new panel telemetry * Restructure panel data to sort by type first * Fix jest tests + slight restructure * [CI] Auto-commit changed files from 'node scripts/eslint --no-cache --fix' Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com> (cherry picked from commit 64d7bcc) * Fix conflicts Co-authored-by: Hannah Mudge <Heenawter@users.noreply.github.com> Co-authored-by: heenawter <hannah.wright@elastic.co>

…130166) * Add new panel telemetry * Restructure panel data to sort by type first * Fix jest tests + slight restructure * [CI] Auto-commit changed files from 'node scripts/eslint --no-cache --fix' Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>

Heenawter self-assigned this Apr 13, 2022

Heenawter added 2 commits April 13, 2022 17:09

Add new panel telemetry

b0882a6

Restructure panel data to sort by type first

b4a78e1

Heenawter force-pushed the fix-panel-telemetry_2022-04-13 branch from 5a29844 to b4a78e1 Compare April 13, 2022 23:09

Fix jest tests + slight restructure

00bc5e1

Heenawter force-pushed the fix-panel-telemetry_2022-04-13 branch from 6038c76 to 00bc5e1 Compare April 14, 2022 15:42

Heenawter marked this pull request as ready for review April 14, 2022 15:48

Heenawter requested review from a team as code owners April 14, 2022 15:48

Heenawter added v8.3.0 v7.17.3 labels Apr 14, 2022

ThomThomson approved these changes Apr 14, 2022

View reviewed changes

Heenawter added v8.0.2 v8.1.3 v8.2.1 labels Apr 14, 2022

Heenawter and others added 2 commits April 18, 2022 09:04

Merge branch 'main' into fix-panel-telemetry_2022-04-13

695ee12

[CI] Auto-commit changed files from 'node scripts/eslint --no-cache -…

965929b

…-fix'

Heenawter added v7.17.4 and removed v7.17.3 v8.0.2 v8.1.3 labels Apr 19, 2022

pgayvallet approved these changes Apr 19, 2022

View reviewed changes

Heenawter merged commit 64d7bcc into elastic:main Apr 19, 2022

Heenawter deleted the fix-panel-telemetry_2022-04-13 branch April 19, 2022 21:40

ThomThomson mentioned this pull request Apr 21, 2022

[Controls] Collect Telemetry #130498

Merged

2 tasks

Heenawter added auto-backport Deprecated: Automatically backport this PR after it's merged and removed backport:skip This commit does not require backporting labels Apr 21, 2022

kibanamachine mentioned this pull request Apr 21, 2022

[8.2] [Dashboard] [Telemetry] Report panels in dashboards by type (#130166) #130804

Merged

kibanamachine mentioned this pull request Apr 21, 2022

[7.17] [Dashboard] [Telemetry] Report panels in dashboards by type (#130166) #130805

Merged

ThomThomson removed the v7.17.4 label Apr 27, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Dashboard] [Telemetry] Report panels in dashboards by type #130166

[Dashboard] [Telemetry] Report panels in dashboards by type #130166

Heenawter commented Apr 13, 2022 •

edited

Loading

elasticmachine commented Apr 14, 2022

ThomThomson left a comment

ThomThomson Apr 14, 2022

Heenawter Apr 14, 2022 •

edited

Loading

ThomThomson Apr 14, 2022

ThomThomson Apr 14, 2022

kibana-ci commented Apr 18, 2022

kibanamachine commented Apr 21, 2022

[Dashboard] [Telemetry] Report panels in dashboards by type #130166

[Dashboard] [Telemetry] Report panels in dashboards by type #130166

Conversation

Heenawter commented Apr 13, 2022 • edited Loading

Summary

Checklist

elasticmachine commented Apr 14, 2022

ThomThomson left a comment

Choose a reason for hiding this comment

ThomThomson Apr 14, 2022

Choose a reason for hiding this comment

Heenawter Apr 14, 2022 • edited Loading

Choose a reason for hiding this comment

ThomThomson Apr 14, 2022

Choose a reason for hiding this comment

ThomThomson Apr 14, 2022

Choose a reason for hiding this comment

kibana-ci commented Apr 18, 2022

💚 Build Succeeded

Metrics [docs]

History

kibanamachine commented Apr 21, 2022

💚 All backports created successfully

Questions ?

Heenawter commented Apr 13, 2022 •

edited

Loading

Heenawter Apr 14, 2022 •

edited

Loading