Adding descriptions to new telemetry fields

elastic · Apr 14, 2021 · 3b41bbf · 3b41bbf
1 parent e79e335
commit 3b41bbf
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 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
@@ -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
@@ -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": {