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.

Sign up for GitHub

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

Jump to bottom

[Usage Collection] Add schema to stack_management #77897

Merged
merged 6 commits into from
Sep 24, 2020
Merged

[Usage Collection] Add schema to stack_management #77897

merged 6 commits into from
Sep 24, 2020

Conversation

afharo
Copy link
Member

@afharo afharo commented Sep 18, 2020

Summary

  • Add schema definition to the collector stack_management.
  • Fix check_collector_integrity to support keys with ' in the key name.

Related to #70180.

For maintainers

@afharo afharo requested a review from a team as a code owner September 18, 2020 13:54
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-telemetry (Team:KibanaTelemetry)

@afharo afharo added the release_note:skip Skip the PR/issue when compiling release notes label Sep 18, 2020
@afharo afharo mentioned this pull request Sep 18, 2020
Closed
14 tasks
@afharo afharo force-pushed the telemetry/schema/stack_management branch from fd10857 to 8779c41 Compare September 18, 2020 14:46
@afharo
Copy link
Member Author

afharo commented Sep 21, 2020

@elasticmachine merge upstream

@afharo
Copy link
Member Author

afharo commented Sep 23, 2020

@elasticmachine merge upstream

@afharo
Copy link
Member Author

afharo commented Sep 23, 2020

@elasticmachine merge upstream

TinaHeiligers
TinaHeiligers reviewed Sep 23, 2020
View reviewed changes
src/plugins/kibana_usage_collection/server/collectors/management/schema.ts
'timelion:es.default_index': { type: 'keyword' },
'timelion:showTutorial': { type: 'boolean' },
'securitySolution:timeDefaults': { type: 'keyword' },
'securitySolution:defaultAnomalyScore': { type: 'long' },
Copy link
Contributor

Choose a reason for hiding this comment

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

Running a trial license, I didn't get this field in the usage data payload. There are a lot of fields though and I might have missed it.

TinaHeiligers
TinaHeiligers reviewed Sep 23, 2020
View reviewed changes
src/plugins/kibana_usage_collection/server/collectors/management/schema.ts
import { UsageStats } from './telemetry_management_collector';

// Retrieved by changing all the current settings in Kibana (we'll need to revisit it in the future).
// I would suggest we use flattened type for the mappings of this collector.
Copy link
Contributor

@TinaHeiligers TinaHeiligers Sep 23, 2020 •
edited
Loading

Choose a reason for hiding this comment

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

Flattened field types won't allow us to do aggregations and answer questions such as: "what is the average precision used in tile maps?" or "what is the average size of terms aggregations users set in Discover?"

TinaHeiligers
TinaHeiligers reviewed Sep 23, 2020
View reviewed changes
...ugins/kibana_usage_collection/server/collectors/management/telemetry_management_collector.ts

export type UsageStats = Record<string, any>;
export interface UsageStats extends Record<string, boolean | number | string> {
// We don't support `type` yet. Only interfaces. So I added at least 1 known key to the generic
Copy link
Contributor

Choose a reason for hiding this comment

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

The tech debt is reasonable here. We can handle it together with any other larger changes we need to make.

TinaHeiligers
TinaHeiligers approved these changes Sep 23, 2020
View reviewed changes
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.

Great effort at extracting all those fields! It will come in very handy when we create our usage data dictionary.
LGTM

@kibanamachine
Copy link
Contributor

💚 Build Succeeded

Metrics [docs]

distributable file count

id value diff baseline
default 45879 +1 45878
oss 26617 +1 26616
total +2

History

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

@afharo afharo merged commit 18f7f04 into elastic:master Sep 24, 2020
@afharo afharo deleted the telemetry/schema/stack_management branch September 24, 2020 13:05
@afharo afharo mentioned this pull request Sep 24, 2020
Merged
afharo added a commit that referenced this pull request Sep 24, 2020
@afharo @elasticmachine
[7.x] [Usage Collection] Add schema to stack_management (#77897) (#…
2def830 
…78417)

Co-authored-by: Elastic Machine <[email protected]>

Co-authored-by: Elastic Machine <[email protected]>
@lukeelmers lukeelmers added the Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc label Oct 1, 2021
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-core (Team:Core)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@TinaHeiligers TinaHeiligers TinaHeiligers approved these changes

Assignees
No one assigned
Labels
Feature:Telemetry release_note:skip Skip the PR/issue when compiling release notes Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc v7.10.0 v8.0.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@afharo @elasticmachine @kibanamachine @TinaHeiligers @lukeelmers