chore(extension-metrics): address review comments

loopbackio · Oct 17, 2019 · ba183e4 · ba183e4
1 parent 0e7087b
commit ba183e4
Show file tree

Hide file tree

Showing 6 changed files with 12 additions and 10 deletions.
diff --git a/extensions/metrics/src/__tests__/acceptance/metrics-push.acceptance.ts b/extensions/metrics/src/__tests__/acceptance/metrics-push.acceptance.ts
@@ -7,9 +7,7 @@ import {RestApplication, RestServerConfig} from '@loopback/rest';
 import {givenHttpServerConfig, supertest} from '@loopback/testlab';
 import {AddressInfo} from 'net';
 import {promisify} from 'util';
-import {MetricsComponent} from '../..';
-import {MetricsBindings} from '../../keys';
-import {MetricsOptions} from '../../types';
+import {MetricsBindings, MetricsComponent, MetricsOptions} from '../..';
 import {PushGateway} from './mock-pushgateway';
 
 const gateway = new PushGateway();

diff --git a/extensions/metrics/src/__tests__/acceptance/metrics.acceptance.ts b/extensions/metrics/src/__tests__/acceptance/metrics.acceptance.ts
@@ -10,9 +10,7 @@ import {
   expect,
   givenHttpServerConfig,
 } from '@loopback/testlab';
-import {MetricsComponent} from '../..';
-import {MetricsBindings} from '../../keys';
-import {MetricsOptions} from '../../types';
+import {MetricsBindings, MetricsComponent, MetricsOptions} from '../..';
 
 describe('Metrics (acceptance)', () => {
   let app: RestApplication;

diff --git a/extensions/metrics/src/metrics.component.ts b/extensions/metrics/src/metrics.component.ts
@@ -15,7 +15,7 @@ import {Application, Component, CoreBindings} from '@loopback/core';
 import {metricsControllerFactory} from './controllers';
 import {MetricsInterceptor} from './interceptors';
 import {MetricsBindings} from './keys';
-import {MetricsObserver, PushGatewayObserver} from './observers';
+import {MetricsObserver, MetricsPushObserver} from './observers';
 import {DEFAULT_METRICS_OPTIONS, MetricsOptions} from './types';
 
 /**
@@ -39,7 +39,7 @@ export class MetricsComponent implements Component {
       !options.pushGateway ||
       (options.pushGateway && !options.pushGateway.disabled)
     ) {
-      this.application.lifeCycleObserver(PushGatewayObserver);
+      this.application.lifeCycleObserver(MetricsPushObserver);
     }
     this.application.add(createBindingFromClass(MetricsInterceptor));
     if (!options.endpoint || (options.endpoint && !options.endpoint.disabled)) {

diff --git a/extensions/metrics/src/observers/index.ts b/extensions/metrics/src/observers/index.ts
@@ -4,4 +4,4 @@
 // License text available at https://opensource.org/licenses/MIT
 
 export * from './metrics.observer';
-export * from './pushgateway.observer';
+export * from './metrics.push.observer';
diff --git a/extensions/metrics/src/observers/metrics.observer.ts b/extensions/metrics/src/observers/metrics.observer.ts
@@ -8,6 +8,9 @@ import {collectDefaultMetrics, register} from 'prom-client';
 import {MetricsBindings} from '../keys';
 import {DEFAULT_METRICS_OPTIONS, MetricsOptions} from '../types';
 
+/**
+ * An observer to set default Node.js metrics collection
+ */
 export class MetricsObserver implements LifeCycleObserver {
   private interval: NodeJS.Timeout | undefined;
 

diff --git a/...ics/src/observers/pushgateway.observer.ts → ...cs/src/observers/metrics.push.observer.ts b/...ics/src/observers/pushgateway.observer.ts → ...cs/src/observers/metrics.push.observer.ts
@@ -8,7 +8,10 @@ import {Pushgateway} from 'prom-client';
 import {MetricsBindings} from '../keys';
 import {DEFAULT_METRICS_OPTIONS, MetricsOptions} from '../types';
 
-export class PushGatewayObserver implements LifeCycleObserver {
+/**
+ * An observer to set up periodical push of metrics to a push gateway
+ */
+export class MetricsPushObserver implements LifeCycleObserver {
   private interval: NodeJS.Timeout | undefined;
   private gateway: Pushgateway;