[data views] More efficient telemetry collection #152298
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -8,8 +8,13 @@ | |
|
|
||
| import { UsageCollectionSetup } from '@kbn/usage-collection-plugin/server'; | ||
| import { StartServicesAccessor } from '@kbn/core/server'; | ||
| import { SavedObjectsClient, SavedObjectsCreatePointInTimeFinderOptions } from '@kbn/core/server'; | ||
| import { | ||
| DATA_VIEW_SAVED_OBJECT_TYPE, | ||
| DataViewAttributes, | ||
| FieldSpec, | ||
| RuntimeField, | ||
| } from '../common'; | ||
| import { DataViewsServerPluginStartDependencies, DataViewsServerPluginStart } from './types'; | ||
|
|
||
| interface CountSummary { | ||
|
|
@@ -18,6 +23,8 @@ interface CountSummary { | |
| avg?: number; | ||
| } | ||
|
|
||
| type DataViewFieldAttrs = Pick<DataViewAttributes, 'fields' | 'runtimeFieldMap'>; | ||
|
|
||
| interface IndexPatternUsage { | ||
| indexPatternsCount: number; | ||
| indexPatternsWithScriptedFieldCount: number; | ||
|
|
@@ -57,17 +64,15 @@ export const updateMax = (currentMax: number | undefined, newVal: number): numbe | |
| } | ||
| }; | ||
|
|
||
| export async function getIndexPatternTelemetry(savedObjectsService: SavedObjectsClient) { | ||
| const countSummaryDefaults: CountSummary = { | ||
| min: undefined, | ||
| max: undefined, | ||
| avg: undefined, | ||
| }; | ||
|
|
||
| const results = { | ||
| indexPatternsCount: 0, | ||
| indexPatternsWithScriptedFieldCount: 0, | ||
| indexPatternsWithRuntimeFieldCount: 0, | ||
| scriptedFieldCount: 0, | ||
|
|
@@ -80,60 +85,74 @@ export async function getIndexPatternTelemetry(indexPatterns: DataViewsContract) | |
| }, | ||
| }; | ||
|
|
||
| const findOptions: SavedObjectsCreatePointInTimeFinderOptions = { | ||
| type: DATA_VIEW_SAVED_OBJECT_TYPE, | ||
| perPage: 1000, | ||
| fields: ['attributes.fields', 'attributes.runtimeFieldMap'], | ||
| }; | ||
|
|
||
| const finder = savedObjectsService.createPointInTimeFinder<DataViewFieldAttrs>(findOptions); | ||
|
|
||
| for await (const response of finder.find()) { | ||
| const { saved_objects: savedObjects, total } = response; | ||
| results.indexPatternsCount = total; | ||
|
|
||
| savedObjects.forEach((obj) => { | ||
| const fields = JSON.parse(obj.attributes.fields) || []; | ||
|
There was a problem hiding this comment. the JSON.parse threw an exception locally, so it's recommendable to use a There was a problem hiding this comment. Ah, I had failed to push a change. I also changed the default data view definition in the test not to have the attributes that are used as to provide test coverage. |
||
| const runtimeFieldsMap = obj.attributes.runtimeFieldMap | ||
| ? JSON.parse(obj.attributes.runtimeFieldMap) || {} | ||
|
There was a problem hiding this comment. This is also a candidate for There was a problem hiding this comment. @mattkime Telemetry stats now work as excepted 👍 ... one think I still think worth to consider is using a |
||
| : {}; | ||
| const scriptedFields: FieldSpec[] = fields.filter((fld: FieldSpec) => !!fld.script); | ||
| // to array | ||
| const runtimeFields: RuntimeField[] = Object.values(runtimeFieldsMap); | ||
|
|
||
| // calc LoC | ||
| if (scriptedFields.length > 0) { | ||
| // increment counts | ||
| results.indexPatternsWithScriptedFieldCount++; | ||
| results.scriptedFieldCount += scriptedFields.length; | ||
|
|
||
| // calc LoC | ||
| results.perIndexPattern.scriptedFieldLineCount = minMaxAvgLoC( | ||
| scriptedFields.map((fld) => fld.script || '') | ||
| ); | ||
|
|
||
| // calc field counts | ||
| results.perIndexPattern.scriptedFieldCount.min = updateMin( | ||
| results.perIndexPattern.scriptedFieldCount.min, | ||
| scriptedFields.length | ||
| ); | ||
| results.perIndexPattern.scriptedFieldCount.max = updateMax( | ||
| results.perIndexPattern.scriptedFieldCount.max, | ||
| scriptedFields.length | ||
| ); | ||
| results.perIndexPattern.scriptedFieldCount.avg = | ||
| results.scriptedFieldCount / results.indexPatternsWithScriptedFieldCount; | ||
| } | ||
|
|
||
| if (runtimeFields.length > 0) { | ||
| // increment counts | ||
| results.indexPatternsWithRuntimeFieldCount++; | ||
| results.runtimeFieldCount += runtimeFields.length; | ||
|
|
||
| // calc LoC | ||
| const runtimeFieldScripts = runtimeFields.map((fld) => fld.script?.source || ''); | ||
| results.perIndexPattern.runtimeFieldLineCount = minMaxAvgLoC(runtimeFieldScripts); | ||
|
|
||
| // calc field counts | ||
| results.perIndexPattern.runtimeFieldCount.min = updateMin( | ||
| results.perIndexPattern.runtimeFieldCount.min, | ||
| runtimeFields.length | ||
| ); | ||
| results.perIndexPattern.runtimeFieldCount.max = updateMax( | ||
| results.perIndexPattern.runtimeFieldCount.max, | ||
| runtimeFields.length | ||
| ); | ||
| results.perIndexPattern.runtimeFieldCount.avg = | ||
| results.runtimeFieldCount / results.indexPatternsWithRuntimeFieldCount; | ||
| } | ||
| }); | ||
| } | ||
|
|
||
| return results; | ||
|
There was a problem hiding this comment. console.log here to see results. results are encrypted in the http response. You may need to restart kibana to run this multiple times. |
||
| } | ||
|
|
@@ -153,14 +172,10 @@ export function registerIndexPatternsUsageCollector( | |
| type: 'index-patterns', | ||
| isReady: () => true, | ||
| fetch: async () => { | ||
| const [{ savedObjects }] = await getStartServices(); | ||
|
|
||
| const savedObjectsService = new SavedObjectsClient(savedObjects.createInternalRepository()); | ||
| return await getIndexPatternTelemetry(savedObjectsService); | ||
| }, | ||
| schema: { | ||
| indexPatternsCount: { type: 'long' }, | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we also call
finder.close()or it's not required?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Its not needed with the for loop.