Add some collector classes for objects that get registered in a CollectorSet

x-pack/plugins/monitoring/server/kibana_monitoring/classes/collector.js

@@ -0,0 +1,31 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License;
+ * you may not use this file except in compliance with the Elastic License.
+ */
+
+export class Collector {
+  /*
+   * @param {String} type.type - property name as the key for the data
+   * @param {Function} type.init (optional) - initialization function
+   * @param {Function} type.fetch - function to query data
+   * @param {Function} type.cleanup (optional) - cleanup function
+   * @param {Boolean} type.fetchAfterInit (optional) - if collector should fetch immediately after init
+   */
+  constructor({ type, init, fetch, cleanup, fetchAfterInit }) {
+    this.type = type;
+    this.init = init;
+    this.fetch = fetch;
+    this.cleanup = cleanup;
+
+    this.fetchAfterInit = fetchAfterInit;
+  }
+
+  /*
+   * Allows using `server.log('debug', message)` as `this.log.debug(message)`.
+   * Works for info and warn logs as well.
+   */
+  setLogger(logger) {
+    this.log = logger;
+  }
+}

x-pack/plugins/monitoring/server/kibana_monitoring/lib/collector_set.js → x-pack/plugins/monitoring/server/kibana_monitoring/classes/collector_set.js

@@ -7,6 +7,7 @@
 import { flatten, isEmpty } from 'lodash';
 import { LOGGING_TAG, KIBANA_MONITORING_LOGGING_TAG } from '../../../common/constants';
 import Promise from 'bluebird';
+import { UsageCollector } from './usage_collector';
 
 const LOGGING_TAGS = [LOGGING_TAG, KIBANA_MONITORING_LOGGING_TAG];
 
@@ -52,13 +53,10 @@ export class CollectorSet {
   }
 
   /*
-   * @param {String} type.type
-   * @param {Function} type.init (optional)
-   * @param {Function} type.fetch
-   * @param {Function} type.cleanup (optional)
+   * @param {Collector} collector object
    */
-  register(type) {
-    this._collectors.push(type);
+  register(collector) {
+    this._collectors.push(collector);
   }
 
   /*
@@ -139,6 +137,19 @@ export class CollectorSet {
     });
   }
 
+  async bulkFetchUsage() {
+    const usageCollectors = this._collectors.filter(c => c instanceof UsageCollector);
+    const bulk = await this._bulkFetch(usageCollectors);
+
+    // summarize each type of stat
+    return bulk.reduce((accumulatedStats, currentStat) => {
+      return {
+        ...accumulatedStats,
+        [currentStat.type]: currentStat.result,
+      };
+    }, {});
+  }
+
   cleanup() {
     this._log.info(`Stopping all stats collectors`);
 

x-pack/plugins/monitoring/server/kibana_monitoring/classes/usage_collector.js

@@ -0,0 +1,13 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License;
+ * you may not use this file except in compliance with the Elastic License.
+ */
+
+import { Collector } from './collector';
+
+export class UsageCollector extends Collector {
+  constructor(properties) {
+    super(properties);
+  }
+}

x-pack/plugins/monitoring/server/kibana_monitoring/collectors/get_kibana_usage_collector.js

@@ -6,6 +6,7 @@
 
 import { get, snakeCase } from 'lodash';
 import { KIBANA_USAGE_TYPE } from '../../../common/constants';
+import { UsageCollector } from '../classes/usage_collector';
 
 const TYPES = [
   'dashboard',
@@ -20,7 +21,7 @@ const TYPES = [
  * Fetches saved object client counts by querying the saved object index
  */
 export function getKibanaUsageCollector(server, callCluster) {
-  return {
+  return new UsageCollector({
     type: KIBANA_USAGE_TYPE,
     async fetch() {
       const index = server.config().get('kibana.index');
@@ -62,5 +63,5 @@ export function getKibanaUsageCollector(server, callCluster) {
         }), {})
       };
     }
-  };
+  });
 }

x-pack/plugins/monitoring/server/kibana_monitoring/collectors/get_ops_stats_collector.js

@@ -6,6 +6,7 @@
 
 import { KIBANA_STATS_TYPE } from '../../../common/constants';
 import { opsBuffer } from './ops_buffer';
+import { Collector } from '../classes/collector';
 
 /*
  * Initialize a collector for Kibana Ops Stats
@@ -20,11 +21,6 @@ export function getOpsStatsCollector(server) {
     monitor.on('ops', onOps);
   };
 
-  let _log;
-  const setLogger = logger => {
-    _log = logger;
-  };
-
   const cleanup = () => {
     if (monitor) {
       monitor.removeListener('ops', onOps);
@@ -34,24 +30,23 @@ export function getOpsStatsCollector(server) {
   // This needs to be removed once the FIXME for 1301 is fixed
   // `process` is a NodeJS global, and is always available without using require/import
   process.on('SIGHUP', () => {
-    _log.info('Re-initializing Kibana Monitoring due to SIGHUP');
+    this.log.info('Re-initializing Kibana Monitoring due to SIGHUP');
     /* This timeout is a temporary stop-gap until collecting stats is not bound to even-better
      * and collecting stats is not interfered by logging configuration reloading
      * Related to https://github.com/elastic/x-pack-kibana/issues/1301
      */
     setTimeout(() => {
       cleanup();
       init();
-      _log.info('Re-initialized Kibana Monitoring due to SIGHUP');
+      this.log.info('Re-initialized Kibana Monitoring due to SIGHUP');
     }, 5 * 1000); // wait 5 seconds to avoid race condition with reloading logging configuration
   });
 
-  return {
+  return new Collector({
     type: KIBANA_STATS_TYPE,
     init,
-    setLogger,
     fetch: buffer.flush,
     fetchAfterInit: true,
     cleanup
-  };
+  });
 }

x-pack/plugins/monitoring/server/kibana_monitoring/collectors/get_settings_collector.js

@@ -5,9 +5,9 @@
  */
 
 import { get } from 'lodash';
-
 import { XPACK_DEFAULT_ADMIN_EMAIL_UI_SETTING } from '../../../../../server/lib/constants';
 import { KIBANA_SETTINGS_TYPE } from '../../../common/constants';
+import { Collector } from '../classes/collector';
 
 /*
  * Check if Cluster Alert email notifications is enabled in config
@@ -58,36 +58,28 @@ export function getSettingsCollector(server) {
   const { callWithInternalUser } = server.plugins.elasticsearch.getCluster('admin');
   const config = server.config();
 
-  let _log;
-  const setLogger = logger => {
-    _log = logger;
-  };
-
-  const fetch = async () => {
-    let kibanaSettingsData;
-    const defaultAdminEmail = await checkForEmailValue(config, callWithInternalUser);
-
-    // skip everything if defaultAdminEmail === undefined
-    if (defaultAdminEmail || (defaultAdminEmail === null && shouldUseNull)) {
-      kibanaSettingsData = {
-        xpack: {
-          default_admin_email: defaultAdminEmail
-        }
-      };
-      _log.debug(`[${defaultAdminEmail}] default admin email setting found, sending [${KIBANA_SETTINGS_TYPE}] monitoring document.`);
-    } else {
-      _log.debug(`not sending [${KIBANA_SETTINGS_TYPE}] monitoring document because [${defaultAdminEmail}] is null or invalid.`);
-    }
-
-    // remember the current email so that we can mark it as successful if the bulk does not error out
-    shouldUseNull = !!defaultAdminEmail;
-
-    return kibanaSettingsData;
-  };
-
-  return {
+  return new Collector({
     type: KIBANA_SETTINGS_TYPE,
-    setLogger,
-    fetch
-  };
+    async fetch() {
+      let kibanaSettingsData;
+      const defaultAdminEmail = await checkForEmailValue(config, callWithInternalUser);
+
+      // skip everything if defaultAdminEmail === undefined
+      if (defaultAdminEmail || (defaultAdminEmail === null && shouldUseNull)) {
+        kibanaSettingsData = {
+          xpack: {
+            default_admin_email: defaultAdminEmail
+          }
+        };
+        this.log.debug(`[${defaultAdminEmail}] default admin email setting found, sending [${KIBANA_SETTINGS_TYPE}] monitoring document.`);
+      } else {
+        this.log.debug(`not sending [${KIBANA_SETTINGS_TYPE}] monitoring document because [${defaultAdminEmail}] is null or invalid.`);
+      }
+
+      // remember the current email so that we can mark it as successful if the bulk does not error out
+      shouldUseNull = !!defaultAdminEmail;
+
+      return kibanaSettingsData;
+    }
+  });
 }

x-pack/plugins/monitoring/server/kibana_monitoring/index.js

@@ -7,3 +7,4 @@
 export { createCollectorSet } from './create_collector_set';
 export { getKibanaUsageCollector } from './collectors/get_kibana_usage_collector';
 export { getReportingUsageCollector } from './collectors/get_reporting_usage_collector';
+export { UsageCollector } from './classes/usage_collector';

x-pack/plugins/monitoring/server/kibana_monitoring/start_collector_set.js

@@ -5,7 +5,7 @@
  */
 
 import { callClusterFactory } from '../../../xpack_main';
-import { CollectorSet } from './lib/collector_set';
+import { CollectorSet } from './classes/collector_set';
 import { getOpsStatsCollector } from './collectors/get_ops_stats_collector';
 import { getSettingsCollector } from './collectors/get_settings_collector';
 import { getKibanaUsageCollector } from './collectors/get_kibana_usage_collector';