feat: add metrics interfaces and classes, create view classe, general refactoring, jsdoc and others

Author: silva-fabio

docs/design/opencensus.nodejs.stats.design.png

@@ -54,6 +54,7 @@
   },
   "dependencies": {
     "continuation-local-storage": "^3.2.1",
+    "hdr-histogram-js": "^1.1.4",
     "log-driver": "^1.2.7",
     "semver": "^5.5.0",
     "shimmer": "^1.2.0",

packages/opencensus-core/package-lock.json

@@ -83,17 +83,16 @@ export class ConsoleStatsExporter implements types.StatsExporter {
    * @param view registered view
    * @param measure registered measure
    */
-  onRegisterView(view: View, measure: Measure) {
-    console.log(
-        `View registered: ${view.name}, Measure registered: ${measure.name}`);
+  onRegisterView(view: View) {
+    console.log(`View registered: ${view.name}, Measure registered: ${
+        view.measure.name}`);
   }
   /**
    * Event called when a measurement is recorded
    * @param view recorded view from measurement
    * @param measurement recorded measurement
    */
-  onRecord(view: View, measurement: Measurement) {
-    console.log(`Measurement recorded: ${measurement.measure.name}, value: ${
-        measurement.value}`);
+  onRecord(view: View) {
+    console.log(`Measurement recorded: ${view.measure.name}`);
   }
 }

packages/opencensus-core/package.json

@@ -15,7 +15,7 @@
  */
 
 
-import {Measure, Measurement, View} from '../stats/model/types';
+import {Measure, Measurement, View, ViewEventListener} from '../stats/model/types';
 import * as configTypes from '../trace/config/types';
 import * as modelTypes from '../trace/model/types';
 
@@ -25,23 +25,10 @@ export interface Exporter extends modelTypes.SpanEventListener {
    * Sends a list of root spans to the service.
    * @param rootSpans A list of root spans to publish.
    */
-
   publish(rootSpans: modelTypes.RootSpan[]): Promise<number|string|void>;
 }
 
-export interface StatsExporter {
-  /**
-   * Event called when a view is registered
-   * @param view registered view
-   * @param measure registered measure
-   */
-  onRegisterView(view: View, measure: Measure): void;
-  /**
-   * Event called when a measurement is recorded
-   * @param view recorded view from measurement
-   * @param measurement recorded measurement
-   */
-  onRecord(view: View, measurement: Measurement): void;
-}
+/** Define a StatsExporter interface */
+export interface StatsExporter extends ViewEventListener {}
 
 export type ExporterConfig = configTypes.BufferConfig;

packages/opencensus-core/src/exporters/console-exporter.ts

@@ -43,11 +43,16 @@ export * from './exporters/console-exporter';
 // STATS CLASSES
 
 // domain models impls
-export * from './stats/model/aggregation';
+export * from './stats/model/metrics/counter';
+export * from './stats/model/metrics/gauge';
+export * from './stats/model/metrics/histogram';
+export * from './stats/model/metrics/metric';
 export * from './stats/model/measure';
-export * from './stats/model/stats-manager';
+export * from './stats/model/view';
+export * from './stats/stats';
 
 // interfaces
+export * from './stats/model/metrics/types';
 export * from './stats/model/types';
 
 // logger

packages/opencensus-core/src/exporters/types.ts

@@ -14,34 +14,68 @@
  * limitations under the License.
  */
 
-import {Measure} from './types';
+import {Measure, MeasureUnit, RegisteredMeasures} from './types';
+
 
 /** Measure class for double type */
-export class MeasureDouble implements Measure {
-  name: string;
-  description: string;
-  unit: string;
-  type: string;
+abstract class AbstractMeasure implements Measure {
+  readonly name: string;
+  readonly description: string;
+  readonly unit: MeasureUnit;
+  abstract get type(): string;
 
-  constructor(name: string, description: string, unit: string) {
+  constructor(name: string, description: string, unit: MeasureUnit) {
     this.name = name;
     this.description = description;
     this.unit = unit;
+  }
+}
+
+/** Measure class for double type */
+class MeasureDouble extends AbstractMeasure {
+  readonly type: string;
+  constructor(name: string, description: string, unit: MeasureUnit) {
+    super(name, description, unit);
     this.type = 'DOUBLE';
   }
 }
 
 /** Measure class for int64 type */
-export class MeasureInt64 implements Measure {
-  name: string;
-  description: string;
-  unit: string;
-  type: string;
-
-  constructor(name: string, description: string, unit: string) {
-    this.name = name;
-    this.description = description;
-    this.unit = unit;
+class MeasureInt64 extends AbstractMeasure {
+  readonly type: string;
+  constructor(name: string, description: string, unit: MeasureUnit) {
+    super(name, description, unit);
     this.type = 'INT64';
   }
 }
+
+/**
+ * Simple Mesure Builder and Register
+ */
+export class MeasureManager {
+  private static registeredMeasures: RegisteredMeasures = {};
+
+  private static registerMeasure(measure: Measure) {
+    const existingMeasure = MeasureManager.registeredMeasures[measure.name];
+    if (existingMeasure) {
+      return;
+    }
+    MeasureManager.registeredMeasures[measure.name] = measure;
+  }
+
+  /** Factory method that createas a Measure of type DOUBLE */
+  static createMeasureDouble(
+      name: string, description: string, unit: MeasureUnit): Measure {
+    const newMesure = new MeasureDouble(name, description, unit);
+    MeasureManager.registerMeasure(newMesure);
+    return newMesure;
+  }
+
+  /** Factory method that createas a Measure of type INT64 */
+  static createMeasureInt64(
+      name: string, description: string, unit: MeasureUnit): Measure {
+    const newMesure = new MeasureInt64(name, description, unit);
+    MeasureManager.registerMeasure(newMesure);
+    return newMesure;
+  }
+}