Document telemetry fields for stack security features (#96638) (#96702)

Co-authored-by: Larry Gregory <larry.gregory@elastic.co>
elastic · Apr 9, 2021 · 75176d2 · 75176d2
1 parent cff4de1
commit 75176d2
Show file tree

Hide file tree

Showing 2 changed files with 47 additions and 6 deletions.
diff --git a/x-pack/plugins/security/server/usage_collector/security_usage_collector.ts b/x-pack/plugins/security/server/usage_collector/security_usage_collector.ts
@@ -53,26 +53,49 @@ export function registerSecurityUsageCollector({ usageCollection, config, licens
     schema: {
       auditLoggingEnabled: {
         type: 'boolean',
+        _meta: {
+          description:
+            'Indicates if audit logging is both enabled and supported by the current license.',
+        },
       },
       loginSelectorEnabled: {
         type: 'boolean',
+        _meta: {
+          description: 'Indicates if the login selector UI is enabled.',
+        },
       },
       accessAgreementEnabled: {
         type: 'boolean',
+        _meta: {
+          description:
+            'Indicates if the access agreement UI is both enabled and supported by the current license.',
+        },
       },
       authProviderCount: {
         type: 'long',
+        _meta: {
+          description:
+            'The number of configured auth providers (including disabled auth providers).',
+        },
       },
       enabledAuthProviders: {
         type: 'array',
         items: {
           type: 'keyword',
+          _meta: {
+            description:
+              'The types of enabled auth providers (such as `saml`, `basic`, `pki`, etc).',
+          },
         },
       },
       httpAuthSchemes: {
         type: 'array',
         items: {
           type: 'keyword',
+          _meta: {
+            description:
+              'The set of enabled http auth schemes. Used for api-based usage, and when credentials are provided via reverse-proxy.',
+          },
         },
       },
     },

diff --git a/x-pack/plugins/telemetry_collection_xpack/schema/xpack_plugins.json b/x-pack/plugins/telemetry_collection_xpack/schema/xpack_plugins.json
@@ -3896,27 +3896,45 @@
     "security": {
       "properties": {
         "auditLoggingEnabled": {
-          "type": "boolean"
+          "type": "boolean",
+          "_meta": {
+            "description": "Indicates if audit logging is both enabled and supported by the current license."
+          }
         },
         "loginSelectorEnabled": {
-          "type": "boolean"
+          "type": "boolean",
+          "_meta": {
+            "description": "Indicates if the login selector UI is enabled."
+          }
         },
         "accessAgreementEnabled": {
-          "type": "boolean"
+          "type": "boolean",
+          "_meta": {
+            "description": "Indicates if the access agreement UI is both enabled and supported by the current license."
+          }
         },
         "authProviderCount": {
-          "type": "long"
+          "type": "long",
+          "_meta": {
+            "description": "The number of configured auth providers (including disabled auth providers)."
+          }
         },
         "enabledAuthProviders": {
           "type": "array",
           "items": {
-            "type": "keyword"
+            "type": "keyword",
+            "_meta": {
+              "description": "The types of enabled auth providers (such as `saml`, `basic`, `pki`, etc)."
+            }
           }
         },
         "httpAuthSchemes": {
           "type": "array",
           "items": {
-            "type": "keyword"
+            "type": "keyword",
+            "_meta": {
+              "description": "The set of enabled http auth schemes. Used for api-based usage, and when credentials are provided via reverse-proxy."
+            }
           }
         }
       }