maxmustermann/kibana
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Document spaces telemetry fields (#95087)

Browse source
This commit is contained in:
Larry Gregory 2021-03-23 15:47:14 -04:00 committed by GitHub
parent 8933037bd0
commit ba21c315c9
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 412 additions and 80 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

292
x-pack/plugins/spaces/server/usage_collection/spaces_usage_collector.ts
View file

@ -179,50 +179,262 @@ export function getSpacesUsageCollector(
type: 'spaces',
isReady: () => true,
schema: {
usesFeatureControls: { type: 'boolean' },
usesFeatureControls: {
type: 'boolean',
_meta: {
description:
'Indicates if at least one feature is disabled in at least one space. This is a signal that space-level feature controls are in use. This does not account for role-based (security) feature controls.',
},
},
disabledFeatures: {
// "feature": number;
DYNAMIC_KEY: { type: 'long' },
DYNAMIC_KEY: {
type: 'long',
_meta: {
description: 'The number of spaces which have this feature disabled.',
},
},
// Known registered features
stackAlerts: { type: 'long' },
actions: { type: 'long' },
enterpriseSearch: { type: 'long' },
fleet: { type: 'long' },
savedObjectsTagging: { type: 'long' },
indexPatterns: { type: 'long' },
discover: { type: 'long' },
canvas: { type: 'long' },
maps: { type: 'long' },
siem: { type: 'long' },
monitoring: { type: 'long' },
graph: { type: 'long' },
uptime: { type: 'long' },
savedObjectsManagement: { type: 'long' },
timelion: { type: 'long' },
dev_tools: { type: 'long' },
advancedSettings: { type: 'long' },
infrastructure: { type: 'long' },
visualize: { type: 'long' },
logs: { type: 'long' },
dashboard: { type: 'long' },
ml: { type: 'long' },
apm: { type: 'long' },
stackAlerts: {
type: 'long',
_meta: {
description: 'The number of spaces which have this feature disabled.',
},
},
actions: {
type: 'long',
_meta: {
description: 'The number of spaces which have this feature disabled.',
},
},
enterpriseSearch: {
type: 'long',
_meta: {
description: 'The number of spaces which have this feature disabled.',
},
},
fleet: {
type: 'long',
_meta: {
description: 'The number of spaces which have this feature disabled.',
},
},
savedObjectsTagging: {
type: 'long',
_meta: {
description: 'The number of spaces which have this feature disabled.',
},
},
indexPatterns: {
type: 'long',
_meta: {
description: 'The number of spaces which have this feature disabled.',
},
},
discover: {
type: 'long',
_meta: {
description: 'The number of spaces which have this feature disabled.',
},
},
canvas: {
type: 'long',
_meta: {
description: 'The number of spaces which have this feature disabled.',
},
},
maps: {
type: 'long',
_meta: {
description: 'The number of spaces which have this feature disabled.',
},
},
siem: {
type: 'long',
_meta: {
description: 'The number of spaces which have this feature disabled.',
},
},
monitoring: {
type: 'long',
_meta: {
description: 'The number of spaces which have this feature disabled.',
},
},
graph: {
type: 'long',
_meta: {
description: 'The number of spaces which have this feature disabled.',
},
},
uptime: {
type: 'long',
_meta: {
description: 'The number of spaces which have this feature disabled.',
},
},
savedObjectsManagement: {
type: 'long',
_meta: {
description: 'The number of spaces which have this feature disabled.',
},
},
timelion: {
type: 'long',
_meta: {
description: 'The number of spaces which have this feature disabled.',
},
},
dev_tools: {
type: 'long',
_meta: {
description: 'The number of spaces which have this feature disabled.',
},
},
advancedSettings: {
type: 'long',
_meta: {
description: 'The number of spaces which have this feature disabled.',
},
},
infrastructure: {
type: 'long',
_meta: {
description: 'The number of spaces which have this feature disabled.',
},
},
visualize: {
type: 'long',
_meta: {
description: 'The number of spaces which have this feature disabled.',
},
},
logs: {
type: 'long',
_meta: {
description: 'The number of spaces which have this feature disabled.',
},
},
dashboard: {
type: 'long',
_meta: {
description: 'The number of spaces which have this feature disabled.',
},
},
ml: {
type: 'long',
_meta: {
description: 'The number of spaces which have this feature disabled.',
},
},
apm: {
type: 'long',
_meta: {
description: 'The number of spaces which have this feature disabled.',
},
},
},
available: {
type: 'boolean',
_meta: {
description: 'Indicates if the spaces feature is available in this installation.',
},
},
enabled: {
type: 'boolean',
_meta: {
description: 'Indicates if the spaces feature is enabled in this installation.',
},
},
count: {
type: 'long',
_meta: {
description: 'The number of spaces in this installation.',
},
},
'apiCalls.copySavedObjects.total': {
type: 'long',
_meta: {
description: 'The number of times the "Copy Saved Objects" API has been called.',
},
},
'apiCalls.copySavedObjects.kibanaRequest.yes': {
type: 'long',
_meta: {
description:
'The number of times the "Copy Saved Objects" API has been called via the Kibana client.',
},
},
'apiCalls.copySavedObjects.kibanaRequest.no': {
type: 'long',
_meta: {
description:
'The number of times the "Copy Saved Objects" API has been called via an API consumer (e.g. curl).',
},
},
'apiCalls.copySavedObjects.createNewCopiesEnabled.yes': {
type: 'long',
_meta: {
description:
'The number of times the "Copy Saved Objects" API has been called with "createNewCopies" set to true.',
},
},
'apiCalls.copySavedObjects.createNewCopiesEnabled.no': {
type: 'long',
_meta: {
description:
'The number of times the "Copy Saved Objects" API has been called with "createNewCopies" set to false.',
},
},
'apiCalls.copySavedObjects.overwriteEnabled.yes': {
type: 'long',
_meta: {
description:
'The number of times the "Copy Saved Objects" API has been called with "overwrite" set to true.',
},
},
'apiCalls.copySavedObjects.overwriteEnabled.no': {
type: 'long',
_meta: {
description:
'The number of times the "Copy Saved Objects" API has been called with "overwrite" set to false.',
},
},
'apiCalls.resolveCopySavedObjectsErrors.total': {
type: 'long',
_meta: {
description:
'The number of times the "Resolve Copy Saved Objects Errors" API has been called.',
},
},
'apiCalls.resolveCopySavedObjectsErrors.kibanaRequest.yes': {
type: 'long',
_meta: {
description:
'The number of times the "Resolve Copy Saved Objects Errors" API has been called via the Kibana client.',
},
},
'apiCalls.resolveCopySavedObjectsErrors.kibanaRequest.no': {
type: 'long',
_meta: {
description:
'The number of times the "Resolve Copy Saved Objects Errors" API has been called via an API consumer (e.g. curl).',
},
},
'apiCalls.resolveCopySavedObjectsErrors.createNewCopiesEnabled.yes': {
type: 'long',
_meta: {
description:
'The number of times the "Resolve Copy Saved Objects Errors" API has been called with "createNewCopies" set to true.',
},
},
'apiCalls.resolveCopySavedObjectsErrors.createNewCopiesEnabled.no': {
type: 'long',
_meta: {
description:
'The number of times the "Resolve Copy Saved Objects Errors" API has been called with "createNewCopies" set to false.',
},
},
available: { type: 'boolean' },
enabled: { type: 'boolean' },
count: { type: 'long' },
'apiCalls.copySavedObjects.total': { type: 'long' },
'apiCalls.copySavedObjects.kibanaRequest.yes': { type: 'long' },
'apiCalls.copySavedObjects.kibanaRequest.no': { type: 'long' },
'apiCalls.copySavedObjects.createNewCopiesEnabled.yes': { type: 'long' },
'apiCalls.copySavedObjects.createNewCopiesEnabled.no': { type: 'long' },
'apiCalls.copySavedObjects.overwriteEnabled.yes': { type: 'long' },
'apiCalls.copySavedObjects.overwriteEnabled.no': { type: 'long' },
'apiCalls.resolveCopySavedObjectsErrors.total': { type: 'long' },
'apiCalls.resolveCopySavedObjectsErrors.kibanaRequest.yes': { type: 'long' },
'apiCalls.resolveCopySavedObjectsErrors.kibanaRequest.no': { type: 'long' },
'apiCalls.resolveCopySavedObjectsErrors.createNewCopiesEnabled.yes': { type: 'long' },
'apiCalls.resolveCopySavedObjectsErrors.createNewCopiesEnabled.no': { type: 'long' },
},
fetch: async ({ esClient }: CollectorFetchContext) => {
const { licensing, kibanaIndexConfig$, features, usageStatsServicePromise } = deps;

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

@ -3766,128 +3766,248 @@
"spaces": {
"properties": {
"usesFeatureControls": {
"type": "boolean"
"type": "boolean",
"_meta": {
"description": "Indicates if at least one feature is disabled in at least one space. This is a signal that space-level feature controls are in use. This does not account for role-based (security) feature controls."
}
},
"disabledFeatures": {
"properties": {
"DYNAMIC_KEY": {
"type": "long"
"type": "long",
"_meta": {
"description": "The number of spaces which have this feature disabled."
}
},
"stackAlerts": {
"type": "long"
"type": "long",
"_meta": {
"description": "The number of spaces which have this feature disabled."
}
},
"actions": {
"type": "long"
"type": "long",
"_meta": {
"description": "The number of spaces which have this feature disabled."
}
},
"enterpriseSearch": {
"type": "long"
"type": "long",
"_meta": {
"description": "The number of spaces which have this feature disabled."
}
},
"fleet": {
"type": "long"
"type": "long",
"_meta": {
"description": "The number of spaces which have this feature disabled."
}
},
"savedObjectsTagging": {
"type": "long"
"type": "long",
"_meta": {
"description": "The number of spaces which have this feature disabled."
}
},
"indexPatterns": {
"type": "long"
"type": "long",
"_meta": {
"description": "The number of spaces which have this feature disabled."
}
},
"discover": {
"type": "long"
"type": "long",
"_meta": {
"description": "The number of spaces which have this feature disabled."
}
},
"canvas": {
"type": "long"
"type": "long",
"_meta": {
"description": "The number of spaces which have this feature disabled."
}
},
"maps": {
"type": "long"
"type": "long",
"_meta": {
"description": "The number of spaces which have this feature disabled."
}
},
"siem": {
"type": "long"
"type": "long",
"_meta": {
"description": "The number of spaces which have this feature disabled."
}
},
"monitoring": {
"type": "long"
"type": "long",
"_meta": {
"description": "The number of spaces which have this feature disabled."
}
},
"graph": {
"type": "long"
"type": "long",
"_meta": {
"description": "The number of spaces which have this feature disabled."
}
},
"uptime": {
"type": "long"
"type": "long",
"_meta": {
"description": "The number of spaces which have this feature disabled."
}
},
"savedObjectsManagement": {
"type": "long"
"type": "long",
"_meta": {
"description": "The number of spaces which have this feature disabled."
}
},
"timelion": {
"type": "long"
"type": "long",
"_meta": {
"description": "The number of spaces which have this feature disabled."
}
},
"dev_tools": {
"type": "long"
"type": "long",
"_meta": {
"description": "The number of spaces which have this feature disabled."
}
},
"advancedSettings": {
"type": "long"
"type": "long",
"_meta": {
"description": "The number of spaces which have this feature disabled."
}
},
"infrastructure": {
"type": "long"
"type": "long",
"_meta": {
"description": "The number of spaces which have this feature disabled."
}
},
"visualize": {
"type": "long"
"type": "long",
"_meta": {
"description": "The number of spaces which have this feature disabled."
}
},
"logs": {
"type": "long"
"type": "long",
"_meta": {
"description": "The number of spaces which have this feature disabled."
}
},
"dashboard": {
"type": "long"
"type": "long",
"_meta": {
"description": "The number of spaces which have this feature disabled."
}
},
"ml": {
"type": "long"
"type": "long",
"_meta": {
"description": "The number of spaces which have this feature disabled."
}
},
"apm": {
"type": "long"
"type": "long",
"_meta": {
"description": "The number of spaces which have this feature disabled."
}
}
}
},
"available": {
"type": "boolean"
"type": "boolean",
"_meta": {
"description": "Indicates if the spaces feature is available in this installation."
}
},
"enabled": {
"type": "boolean"
"type": "boolean",
"_meta": {
"description": "Indicates if the spaces feature is enabled in this installation."
}
},
"count": {
"type": "long"
"type": "long",
"_meta": {
"description": "The number of spaces in this installation."
}
},
"apiCalls.copySavedObjects.total": {
"type": "long"
"type": "long",
"_meta": {
"description": "The number of times the \"Copy Saved Objects\" API has been called."
}
},
"apiCalls.copySavedObjects.kibanaRequest.yes": {
"type": "long"
"type": "long",
"_meta": {
"description": "The number of times the \"Copy Saved Objects\" API has been called via the Kibana client."
}
},
"apiCalls.copySavedObjects.kibanaRequest.no": {
"type": "long"
"type": "long",
"_meta": {
"description": "The number of times the \"Copy Saved Objects\" API has been called via an API consumer (e.g. curl)."
}
},
"apiCalls.copySavedObjects.createNewCopiesEnabled.yes": {
"type": "long"
"type": "long",
"_meta": {
"description": "The number of times the \"Copy Saved Objects\" API has been called with \"createNewCopies\" set to true."
}
},
"apiCalls.copySavedObjects.createNewCopiesEnabled.no": {
"type": "long"
"type": "long",
"_meta": {
"description": "The number of times the \"Copy Saved Objects\" API has been called with \"createNewCopies\" set to false."
}
},
"apiCalls.copySavedObjects.overwriteEnabled.yes": {
"type": "long"
"type": "long",
"_meta": {
"description": "The number of times the \"Copy Saved Objects\" API has been called with \"overwrite\" set to true."
}
},
"apiCalls.copySavedObjects.overwriteEnabled.no": {
"type": "long"
"type": "long",
"_meta": {
"description": "The number of times the \"Copy Saved Objects\" API has been called with \"overwrite\" set to false."
}
},
"apiCalls.resolveCopySavedObjectsErrors.total": {
"type": "long"
"type": "long",
"_meta": {
"description": "The number of times the \"Resolve Copy Saved Objects Errors\" API has been called."
}
},
"apiCalls.resolveCopySavedObjectsErrors.kibanaRequest.yes": {
"type": "long"
"type": "long",
"_meta": {
"description": "The number of times the \"Resolve Copy Saved Objects Errors\" API has been called via the Kibana client."
}
},
"apiCalls.resolveCopySavedObjectsErrors.kibanaRequest.no": {
"type": "long"
"type": "long",
"_meta": {
"description": "The number of times the \"Resolve Copy Saved Objects Errors\" API has been called via an API consumer (e.g. curl)."
}
},
"apiCalls.resolveCopySavedObjectsErrors.createNewCopiesEnabled.yes": {
"type": "long"
"type": "long",
"_meta": {
"description": "The number of times the \"Resolve Copy Saved Objects Errors\" API has been called with \"createNewCopies\" set to true."
}
},
"apiCalls.resolveCopySavedObjectsErrors.createNewCopiesEnabled.no": {
"type": "long"
"type": "long",
"_meta": {
"description": "The number of times the \"Resolve Copy Saved Objects Errors\" API has been called with \"createNewCopies\" set to false."
}
}
}
},