Change elasticsearch.principal usage data/description

elastic · Aug 31, 2021 · 0317d33 · 0317d33
1 parent a9959d1
commit 0317d33
Show file tree

Hide file tree

Showing 6 changed files with 6 additions and 6 deletions.
diff --git a/src/core/server/core_usage_data/core_usage_data_service.test.ts b/src/core/server/core_usage_data/core_usage_data_service.test.ts
@@ -235,7 +235,7 @@ describe('CoreUsageDataService', () => {
                 "logQueries": false,
                 "numberOfHostsConfigured": 1,
                 "pingTimeoutMs": 30000,
-                "principal": "other",
+                "principal": "unknown",
                 "requestHeadersWhitelistConfigured": false,
                 "requestTimeoutMs": 30000,
                 "shardTimeoutMs": 30000,

diff --git a/src/core/server/core_usage_data/core_usage_data_service.ts b/src/core/server/core_usage_data/core_usage_data_service.ts
@@ -516,7 +516,7 @@ export class CoreUsageDataService implements CoreService<CoreUsageDataSetup, Cor
 }
 
 function getEsPrincipalUsage({ username, serviceAccountToken }: ElasticsearchConfigType) {
-  let value: CoreConfigUsageData['elasticsearch']['principal'] = 'other';
+  let value: CoreConfigUsageData['elasticsearch']['principal'] = 'unknown';
   if (isConfigured.string(username)) {
     switch (username) {
       case 'elastic': // deprecated

diff --git a/src/core/server/core_usage_data/types.ts b/src/core/server/core_usage_data/types.ts
@@ -211,7 +211,7 @@ export interface CoreConfigUsageData {
       | 'kibana_system_user'
       | 'other_user'
       | 'kibana_service_account'
-      | 'other';
+      | 'unknown';
   };
 
   http: {

diff --git a/src/core/server/server.api.md b/src/core/server/server.api.md
@@ -293,7 +293,7 @@ export interface CoreConfigUsageData {
         };
         apiVersion: string;
         healthCheckDelayMs: number;
-        principal: 'elastic_user' | 'kibana_user' | 'kibana_system_user' | 'other_user' | 'kibana_service_account' | 'other';
+        principal: 'elastic_user' | 'kibana_user' | 'kibana_system_user' | 'other_user' | 'kibana_service_account' | 'unknown';
     };
     // (undocumented)
     http: {

diff --git a/src/plugins/kibana_usage_collection/server/collectors/core/core_usage_collector.ts b/src/plugins/kibana_usage_collection/server/collectors/core/core_usage_collector.ts
@@ -135,7 +135,7 @@ export function getCoreUsageCollector(
             type: 'keyword',
             _meta: {
               description:
-                'Indicates what elasticsearch user or service account is configured, if any.',
+                'Indicates how Kibana authenticates itself to Elasticsearch. If elasticsearch.username is configured, this can be any of: "elastic_user", "kibana_user", "kibana_system_user", or "other_user". Otherwise, if elasticsearch.serviceAccountToken is configured, this will be "kibana_service_account". Otherwise, this value will be "unknown", because some other principal might be used to authenticate Kibana to Elasticsearch (such as an x509 certificate), or authentication may be skipped altogether.',
             },
           },
         },

diff --git a/src/plugins/telemetry/schema/oss_plugins.json b/src/plugins/telemetry/schema/oss_plugins.json
@@ -5961,7 +5961,7 @@
                 "principal": {
                   "type": "keyword",
                   "_meta": {
-                    "description": "Indicates what elasticsearch user or service account is configured, if any."
+                    "description": "Indicates how Kibana authenticates itself to Elasticsearch. If elasticsearch.username is configured, this can be any of: \"elastic_user\", \"kibana_user\", \"kibana_system_user\", or \"other_user\". Otherwise, if elasticsearch.serviceAccountToken is configured, this will be \"kibana_service_account\". Otherwise, this value will be \"unknown\", because some other principal might be used to authenticate Kibana to Elasticsearch (such as an x509 certificate), or authentication may be skipped altogether."
                   }
                 }
               }