-
Notifications
You must be signed in to change notification settings - Fork 8.2k
/
custom_element_collector.ts
165 lines (146 loc) · 4.32 KB
/
custom_element_collector.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
/*
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
* or more contributor license agreements. Licensed under the Elastic License
* 2.0; you may not use this file except in compliance with the Elastic License
* 2.0.
*/
import { get } from 'lodash';
import { MakeSchemaFrom } from 'src/plugins/usage_collection/server';
import { collectFns } from './collector_helpers';
import {
TelemetryCollector,
TelemetryCustomElement,
TelemetryCustomElementDocument,
} from '../../types';
import { parseExpression } from '../../../../../src/plugins/expressions/common';
const CUSTOM_ELEMENT_TYPE = 'canvas-element';
interface CustomElementSearch {
[CUSTOM_ELEMENT_TYPE]: TelemetryCustomElementDocument;
}
export interface CustomElementTelemetry {
custom_elements?: {
count: number;
elements: {
min: number;
max: number;
avg: number;
};
functions_in_use: string[];
};
}
export const customElementSchema: MakeSchemaFrom<CustomElementTelemetry> = {
custom_elements: {
count: {
type: 'long',
_meta: {
description: 'The total number of custom Canvas elements',
},
},
elements: {
min: {
type: 'long',
_meta: {
description: 'The minimum number of elements used across all Canvas Custom Elements',
},
},
max: {
type: 'long',
_meta: {
description: 'The maximum number of elements used across all Canvas Custom Elements',
},
},
avg: {
type: 'float',
_meta: {
description: 'The average number of elements used in Canvas Custom Element',
},
},
},
functions_in_use: {
type: 'array',
items: {
type: 'keyword',
_meta: {
description: 'The functions in use by Canvas Custom Elements',
},
},
},
},
};
function isCustomElement(maybeCustomElement: any): maybeCustomElement is TelemetryCustomElement {
return (
maybeCustomElement !== null &&
Array.isArray(maybeCustomElement.selectedNodes) &&
maybeCustomElement.selectedNodes.every(
(node: any) => node.expression && typeof node.expression === 'string'
)
);
}
function parseJsonOrNull(maybeJson: string) {
try {
return JSON.parse(maybeJson);
} catch (e) {
return null;
}
}
/**
Calculate statistics about a collection of CustomElement Documents
@param customElements - Array of CustomElement documents
@returns Statistics about how Custom Elements are being used
*/
export function summarizeCustomElements(
customElements: TelemetryCustomElementDocument[]
): CustomElementTelemetry {
const functionSet = new Set<string>();
const parsedContents: TelemetryCustomElement[] = customElements
.map((element) => element.content)
.map(parseJsonOrNull)
.filter(isCustomElement);
if (parsedContents.length === 0) {
return {};
}
const elements = {
min: Infinity,
max: -Infinity,
avg: 0,
};
let totalElements = 0;
parsedContents.map((contents) => {
contents.selectedNodes.map((node) => {
const ast = parseExpression(node.expression);
collectFns(ast, (cFunction: string) => {
functionSet.add(cFunction);
});
});
elements.min = Math.min(elements.min, contents.selectedNodes.length);
elements.max = Math.max(elements.max, contents.selectedNodes.length);
totalElements += contents.selectedNodes.length;
});
elements.avg = totalElements / parsedContents.length;
return {
custom_elements: {
elements,
count: customElements.length,
functions_in_use: Array.from(functionSet),
},
};
}
const customElementCollector: TelemetryCollector = async function customElementCollector(
kibanaIndex,
esClient
) {
const customElementParams = {
size: 10000,
index: kibanaIndex,
ignore_unavailable: true,
filter_path: [`hits.hits._source.${CUSTOM_ELEMENT_TYPE}.content`],
body: { query: { bool: { filter: { term: { type: CUSTOM_ELEMENT_TYPE } } } } },
};
const { body: esResponse } = await esClient.search<CustomElementSearch>(customElementParams);
if (get(esResponse, 'hits.hits.length') > 0) {
const customElements = esResponse.hits.hits.map((hit) => hit._source![CUSTOM_ELEMENT_TYPE]);
return summarizeCustomElements(customElements);
}
return {};
};
export { customElementCollector };