github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-24 01:38:56 -04:00
Code Issues Projects Releases Packages Wiki Activity

[APM] Add telemetry from custom dashboards (#167866)

Browse source 
## Summary
closes: https://github.com/elastic/kibana/issues/167865

Adds telemetry for the total number of custom dashboards linked with
services and the kuery used
 
## How to test

Navigate to `internal/apm/debug-telemetry` on any of the deployed
environments

You will find the custom_dashboards field like this
<img width="370" alt="image"
src="82d24183-406a-4cb3-a75e-01c272448785">


### Update indexer
 - https://github.com/elastic/telemetry/pull/2702
This commit is contained in:
Katerina 2023-10-04 08:20:12 +02:00 • committed by GitHub
parent 82c8e0d33d
commit 471ae6a858
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
6 changed files with 180 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

30
x-pack/plugins/apm/common/__snapshots__/apm_telemetry.test.ts.snap generated
View file

@ -2577,6 +2577,22 @@ exports[`APM telemetry helpers getApmTelemetry generates a JSON object with the
}
}
},
"custom_dashboards": {
"properties": {
"kuery_fields": {
"type": "keyword",
"_meta": {
"description": "An array of up to 500 unique fields used to create the custom dashboards across all spaces. Example [service.language.name, service.name] "
}
},
"total": {
"type": "long",
"_meta": {
"description": "Total number of custom dashboards retrived from the saved object across all spaces"
}
}
}
},
"per_service": {
"properties": {
"service_id": {
@ -2967,6 +2983,20 @@ exports[`APM telemetry helpers getApmTelemetry generates a JSON object with the
}
}
},
"custom_dashboards": {
"properties": {
"took": {
"properties": {
"ms": {
"type": "long",
"_meta": {
"description": "Execution time in milliseconds for the \\"custom_dashboards\\" task"
}
}
}
}
}
},
"per_service": {
"properties": {
"took": {

52
x-pack/plugins/apm/server/lib/apm_telemetry/collect_data_telemetry/tasks.test.ts
View file

@ -801,6 +801,58 @@ describe('data telemetry collection tasks', () => {
});
});
describe('custom dashboards', () => {
const task = tasks.find((t) => t.name === 'custom_dashboards');
const savedObjectsClient = savedObjectsClientMock.create();
it('returns custom dashboards stats from all spaces', async () => {
savedObjectsClient.find.mockResolvedValueOnce({
page: 1,
per_page: 500,
total: 2,
saved_objects: [
{
type: 'apm-custom-dashboards',
id: '0b6157f0-44bd-11ed-bdb7-bffab551cd4d',
namespaces: ['default'],
attributes: {
dashboardSavedObjectId: 'foo-id',
serviceEnvironmentFilterEnabled: true,
serviceNameFilterEnabled: true,
kuery: 'service.name: frontend and service.environment: prod',
},
references: [],
score: 1,
},
{
type: 'apm-custom-dashboards',
id: '0b6157f0-44bd-11ed-bdb7-bffab551cd4d',
namespaces: ['space-1'],
attributes: {
dashboardSavedObjectId: 'bar-id',
serviceEnvironmentFilterEnabled: true,
serviceNameFilterEnabled: true,
kuery: 'service.name: frontend',
},
references: [],
score: 0,
},
],
});
expect(
await task?.executor({
savedObjectsClient,
} as any)
).toEqual({
custom_dashboards: {
kuery_fields: ['service.name', 'service.environment'],
total: 2,
},
});
});
});
describe('top_traces', () => {
const task = tasks.find((t) => t.name === 'top_traces');

30
x-pack/plugins/apm/server/lib/apm_telemetry/collect_data_telemetry/tasks.ts
View file

@ -71,6 +71,10 @@ import {
import { APM_AGENT_CONFIGURATION_INDEX } from '../../../routes/settings/apm_indices/apm_system_index_constants';
import { IndicesStatsResponse, TelemetryClient } from '../telemetry_client';
import { RollupInterval } from '../../../../common/rollup';
import {
APM_CUSTOM_DASHBOARDS_SAVED_OBJECT_TYPE,
SavedApmCustomDashboard,
} from '../../../../common/custom_dashboards';
type ISavedObjectsClient = Pick<SavedObjectsClient, 'find'>;
const TIME_RANGES = ['1d', 'all'] as const;
@ -1491,6 +1495,32 @@ export const tasks: TelemetryTask[] = [
};
},
},
{
name: 'custom_dashboards',
executor: async ({ savedObjectsClient }) => {
const response = await savedObjectsClient.find<SavedApmCustomDashboard>({
type: APM_CUSTOM_DASHBOARDS_SAVED_OBJECT_TYPE,
page: 1,
perPage: 500,
sortField: 'updated_at',
sortOrder: 'desc',
namespaces: ['*'],
});
const kueryNodes = response.saved_objects.map(
({ attributes: { kuery } }) => fromKueryExpression(kuery ?? '')
);
const kueryFields = getKueryFields(kueryNodes);
return {
custom_dashboards: {
kuery_fields: uniq(kueryFields),
total: response.total ?? 0,
},
};
},
},
{
name: 'per_service',
executor: async ({ indices, telemetryClient }) => {

30
x-pack/plugins/apm/server/lib/apm_telemetry/schema.ts
View file

@ -1083,6 +1083,25 @@ export const apmSchema: MakeSchemaFrom<APMUsage, true> = {
},
},
},
custom_dashboards: {
kuery_fields: {
type: 'array',
items: {
type: 'keyword',
_meta: {
description:
'An array of up to 500 unique fields used to create the custom dashboards across all spaces. Example [service.language.name, service.name] ',
},
},
},
total: {
type: 'long',
_meta: {
description:
'Total number of custom dashboards retrived from the saved object across all spaces',
},
},
},
per_service: { type: 'array', items: { ...apmPerServiceSchema } },
top_traces: {
max: {
@ -1263,6 +1282,17 @@ export const apmSchema: MakeSchemaFrom<APMUsage, true> = {
},
},
},
custom_dashboards: {
took: {
ms: {
type: 'long',
_meta: {
description:
'Execution time in milliseconds for the "custom_dashboards" task',
},
},
},
},
per_service: {
took: {
ms: {

5
x-pack/plugins/apm/server/lib/apm_telemetry/types.ts
View file

@ -213,6 +213,10 @@ export interface APMUsage {
kuery_fields: string[];
total: number;
};
custom_dashboards: {
kuery_fields: string[];
total: number;
};
per_service: APMPerService[];
top_traces: {
max: number;
@ -234,6 +238,7 @@ export interface APMUsage {
| 'cardinality'
| 'environments'
| 'service_groups'
| 'custom_dashboards'
| 'per_service'
| 'top_traces',
{ took: { ms: number } }

33
x-pack/plugins/telemetry_collection_xpack/schema/xpack_plugins.json
View file

@ -5672,6 +5672,25 @@
}
}
},
"custom_dashboards": {
"properties": {
"kuery_fields": {
"type": "array",
"items": {
"type": "keyword",
"_meta": {
"description": "An array of up to 500 unique fields used to create the custom dashboards across all spaces. Example [service.language.name, service.name] "
}
}
},
"total": {
"type": "long",
"_meta": {
"description": "Total number of custom dashboards retrived from the saved object across all spaces"
}
}
}
},
"per_service": {
"type": "array",
"items": {
@ -6077,6 +6096,20 @@
}
}
},
"custom_dashboards": {
"properties": {
"took": {
"properties": {
"ms": {
"type": "long",
"_meta": {
"description": "Execution time in milliseconds for the \"custom_dashboards\" task"
}
}
}
}
}
},
"per_service": {
"properties": {
"took": {