From 3b41bbf14a1d0d1cbfd1963d5de3d93ac7511f0b Mon Sep 17 00:00:00 2001 From: Ying Mao Date: Wed, 14 Apr 2021 19:17:05 -0400 Subject: [PATCH] Adding descriptions to new telemetry fields --- .../actions/server/usage/actions_usage_collector.ts | 12 ++++++++++-- .../schema/xpack_plugins.json | 10 ++++++++-- 2 files changed, 18 insertions(+), 4 deletions(-) diff --git a/x-pack/plugins/actions/server/usage/actions_usage_collector.ts b/x-pack/plugins/actions/server/usage/actions_usage_collector.ts index 0164c6b195f50..06248e1fa95a8 100644 --- a/x-pack/plugins/actions/server/usage/actions_usage_collector.ts +++ b/x-pack/plugins/actions/server/usage/actions_usage_collector.ts @@ -39,10 +39,18 @@ export function createActionsUsageCollector( return true; }, schema: { - alert_history_connector_enabled: { type: 'boolean' }, + alert_history_connector_enabled: { + type: 'boolean', + _meta: { description: 'Indicates if preconfigured alert history connector is enabled.' }, + }, count_total: { type: 'long' }, count_active_total: { type: 'long' }, - count_active_alert_history_connectors: { type: 'long' }, + count_active_alert_history_connectors: { + type: 'long', + _meta: { + description: 'The total number of preconfigured alert history connectors used by rules.', + }, + }, count_by_type: byTypeSchema, count_active_by_type: byTypeSchema, }, diff --git a/x-pack/plugins/telemetry_collection_xpack/schema/xpack_plugins.json b/x-pack/plugins/telemetry_collection_xpack/schema/xpack_plugins.json index 9f25e6ae7319f..1d1cd8c0c7667 100644 --- a/x-pack/plugins/telemetry_collection_xpack/schema/xpack_plugins.json +++ b/x-pack/plugins/telemetry_collection_xpack/schema/xpack_plugins.json @@ -3,7 +3,10 @@ "actions": { "properties": { "alert_history_connector_enabled": { - "type": "boolean" + "type": "boolean", + "_meta": { + "description": "Indicates if preconfigured alert history connector is enabled." + } }, "count_total": { "type": "long" @@ -12,7 +15,10 @@ "type": "long" }, "count_active_alert_history_connectors": { - "type": "long" + "type": "long", + "_meta": { + "description": "The total number of preconfigured alert history connectors used by rules." + } }, "count_by_type": { "properties": {