Telemetry for Visualizations by type #28793

tsullivan · 2019-01-15T22:16:23Z

Closing #22010

Summary

This PR adds a visualization_types property to Kibana usage stats.

Parts of the solution

Nightly Task to parse visState JSON

This schedules a nightly task to parse the visState JSON strings from every visualization saved object in the .kibana index. Therefore, it depends on the x-pack/task_manager plugin, which I believe makes it suitable for creating as a new X-Pack plugin that can have elasticsearch, xpack_main and task_manager as dependencies.

At first, the task is scheduled to run immediately, and from that point, it runs nightly at midnight local server time.

Collector to return the parsed / summarized stats

The actual usage collector gets the scheduled task by _id, finds the state data that contains the stats and simply returns it.

Screenshot of API response

Explanation: Looking at the area stats, my default space has 10 area charts and my custom space has 1 area chart. Hence, min, max and avg are anonymized breakdowns of how that visualization type is distributed across spaces.

Checklist

Use ~~strikethroughs~~ to remove checklist items you don't feel are applicable to this PR.

~~This was checked for cross-browser compatibility, including a check against IE11~~
~~Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support~~
~~Documentation was added for features that require explanation or tutorials~~
Unit or functional tests were updated or added to match the most common scenarios
~~This was checked for keyboard-only and screenreader accessibility~~

x-pack/plugins/core_telemetry/index.js

tsullivan · 2019-01-17T22:52:07Z

cc @epixa @njd5475 this is an example of defining task types and scheduling tasks in the Task Manager directly. Need to keep you in the loop since work on Alerting could change the Task Manager API.

elasticmachine · 2019-01-27T01:31:07Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request

elasticmachine · 2019-01-27T05:21:48Z

Pinging @elastic/kibana-app

tsullivan · 2019-01-27T05:22:01Z

CI is green, and looking to get 1 more review

joelgriffith · 2019-01-29T18:46:49Z

x-pack/plugins/oss_telemetry/server/lib/collectors/visualizations/get_usage_collector.ts

+         * has to wait for all plugins to initialize first.
+         * It's fine to ignore it as next time around it will be initialized (or it will throw a different type of error)
+         */
+        if (errMessage.indexOf('NotInitialized') >= 0) {


errMessage.includes('NotInitialized') might read a bit better here (might also be sub-ms faster as well?)

Also might want a test for this since it's interesting behavior (not sure how difficult that is)

joelgriffith

Just one case that I think would be good to test

joelgriffith · 2019-01-29T18:49:20Z

x-pack/plugins/oss_telemetry/server/lib/collectors/visualizations/get_usage_collector.ts

+         * has to wait for all plugins to initialize first.
+         * It's fine to ignore it as next time around it will be initialized (or it will throw a different type of error)
+         */
+        if (errMessage.indexOf('NotInitialized') >= 0) {


Also might want a test for this since it's interesting behavior (not sure how difficult that is)

elasticmachine · 2019-01-30T05:48:02Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request

* task runner and usage collector for visualizations by type * type is always just "visualization" * drop the I- prefix for interfaces * bug fixes * ts fix * comment perfection * just usage. * const for task numworkers * use mapValues * get next midnight module * move to oss_telemtry * test fix * errMessage.includes(NotInitialized)

tsullivan · 2019-01-30T16:42:33Z

6.x/6.7: #29625

alexfrancoeur · 2019-01-30T21:38:00Z

Just want to say how excited I am about this one, huge thank you 🙇 to everyone who had a hand in this. This PR is amazing!

* task runner and usage collector for visualizations by type * type is always just "visualization" * drop the I- prefix for interfaces * bug fixes * ts fix * comment perfection * just usage. * const for task numworkers * use mapValues * get next midnight module * move to oss_telemtry * test fix * errMessage.includes(NotInitialized)

AlonaNadler · 2019-06-10T13:21:56Z

any idea why TSVB is not in this telemetry pr? I know @tsullivan worked on it and it was supposed to be included

lukeelmers · 2019-06-10T18:03:08Z

@AlonaNadler In the codebase, TSVB currently lives inside a legacy plugin called metrics (not to be confused with the metric vis type).

I haven't looked closely at this PR, but based on Tim's summary above it looks like the API response includes data for metrics, which I would expect to be the TSVB data.

AlonaNadler · 2019-06-11T11:51:00Z

Thanks @lukeelmers that is very helpful !
few other questions:

any idea where is goal and single metric visualizations?
Tile map, does it include coordinate map and region map visualizations combined?
Which visualizations included within histogram? is it for bar chart and horizontal bars combined?
Do you see vega in there hidden somewhere ? (wishful thinking :) )

timroes · 2019-06-11T12:48:53Z

@AlonaNadler I have not yet confirmed

Goal should be tracked as goal.
Single Metric visualization is tracked as metric, while TSVB is tracked as metrics!
tile_map should only be the coordinate map (tile map was the old name), Region map should be tracked as region_map.
histogram tracks vertical bar charts, horizontal_bar horizontal bar charts. Though histogram, area. horizontal_bar and line always needs to be treated with caution. They are only indicating the type the user initially selected in the wizard. You can create a bar chart, then switch it's style over to line, and add one series that is an area, so the final chart would include one line and one area; it would still be tracked as histogram since that was what the user initially selected. The same is true if you start over with either area, line and switch them over, so basically those three types are not tracked exactly.
Vega should be tracked as vega.

tsullivan added WIP Work in progress v7.0.0 Feature:Telemetry v6.7.0 labels Jan 15, 2019

tsullivan force-pushed the telemetry/visualization-types branch 8 times, most recently from d98e8b9 to 126d065 Compare January 17, 2019 22:38

tsullivan changed the title ~~[WIP] Telemetry for Visualizations by type~~ Telemetry for Visualizations by type Jan 17, 2019

tsullivan requested review from pickypg, epixa, njd5475, chrisdavies and Bargs and removed request for epixa January 17, 2019 22:39

tsullivan added review and removed WIP Work in progress labels Jan 17, 2019

elastic deleted a comment from elasticmachine Jan 17, 2019

tsullivan commented Jan 17, 2019

View reviewed changes

x-pack/plugins/core_telemetry/index.js Outdated Show resolved Hide resolved

task runner and usage collector for visualizations by type

c64cba9

tsullivan force-pushed the telemetry/visualization-types branch from 126d065 to c64cba9 Compare January 17, 2019 22:50

tsullivan requested a review from timroes January 17, 2019 22:51

tsullivan added 3 commits January 26, 2019 17:26

const for task numworkers

dad1216

use mapValues

b26dda4

get next midnight module

75eeb16

elastic deleted a comment from elasticmachine Jan 27, 2019

tsullivan added 2 commits January 26, 2019 17:45

move to oss_telemtry

ed77b19

test fix

fef2cb9

tsullivan added the Team:Visualizations Visualization editors, elastic-charts and infrastructure label Jan 27, 2019

joelgriffith reviewed Jan 29, 2019

View reviewed changes

joelgriffith suggested changes Jan 29, 2019

View reviewed changes

Bamieh approved these changes Jan 29, 2019

View reviewed changes

tsullivan added 2 commits January 29, 2019 21:47

Merge branch 'master' into telemetry/visualization-types

21b010a

errMessage.includes(NotInitialized)

37a0f2f

joelgriffith approved these changes Jan 30, 2019

View reviewed changes

tsullivan merged commit b379751 into elastic:master Jan 30, 2019

tsullivan deleted the telemetry/visualization-types branch January 30, 2019 16:40

tsullivan mentioned this pull request Jan 30, 2019

[6.x] Telemetry for Visualizations by type (#28793) #29625

Merged

This was referenced Feb 4, 2019

[Telemetry] Count of Visualization by Type #22010

Closed

[OSS-Telemetry] Make the plugin have the right config prefix #30005

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Telemetry for Visualizations by type #28793

Telemetry for Visualizations by type #28793

tsullivan commented Jan 15, 2019 •

edited

Loading

tsullivan commented Jan 17, 2019

elasticmachine commented Jan 27, 2019

elasticmachine commented Jan 27, 2019

tsullivan commented Jan 27, 2019

joelgriffith Jan 29, 2019

joelgriffith Jan 29, 2019

joelgriffith left a comment

joelgriffith Jan 29, 2019

elasticmachine commented Jan 30, 2019

tsullivan commented Jan 30, 2019

alexfrancoeur commented Jan 30, 2019

AlonaNadler commented Jun 10, 2019

lukeelmers commented Jun 10, 2019

AlonaNadler commented Jun 11, 2019 •

edited

Loading

timroes commented Jun 11, 2019 •

edited

Loading

Telemetry for Visualizations by type #28793

Telemetry for Visualizations by type #28793

Conversation

tsullivan commented Jan 15, 2019 • edited Loading

Summary

Parts of the solution

Nightly Task to parse visState JSON

Collector to return the parsed / summarized stats

Screenshot of API response

Checklist

tsullivan commented Jan 17, 2019

elasticmachine commented Jan 27, 2019

💚 Build Succeeded

elasticmachine commented Jan 27, 2019

tsullivan commented Jan 27, 2019

joelgriffith Jan 29, 2019

Choose a reason for hiding this comment

joelgriffith Jan 29, 2019

Choose a reason for hiding this comment

joelgriffith left a comment

Choose a reason for hiding this comment

joelgriffith Jan 29, 2019

Choose a reason for hiding this comment

elasticmachine commented Jan 30, 2019

💚 Build Succeeded

tsullivan commented Jan 30, 2019

alexfrancoeur commented Jan 30, 2019

AlonaNadler commented Jun 10, 2019

lukeelmers commented Jun 10, 2019

AlonaNadler commented Jun 11, 2019 • edited Loading

timroes commented Jun 11, 2019 • edited Loading

tsullivan commented Jan 15, 2019 •

edited

Loading

AlonaNadler commented Jun 11, 2019 •

edited

Loading

timroes commented Jun 11, 2019 •

edited

Loading