refactor(fix): changes to address review comments

Author: eduardoemery

docs/design/opencensus.nodejs.first.design.pdf

@@ -18,7 +18,7 @@ import {Measurement, View} from '../stats/types';
 import * as configTypes from '../trace/config/types';
 import * as modelTypes from '../trace/model/types';
 
-/** Defines an exporter interface. */
+/** Defines a trace exporter interface. */
 export interface Exporter extends modelTypes.SpanEventListener {
   /**
    * Sends a list of root spans to the service.
@@ -27,9 +27,21 @@ export interface Exporter extends modelTypes.SpanEventListener {
   publish(rootSpans: modelTypes.RootSpan[]): Promise<number|string|void>;
 }
 
-/** Defines a StatsEventListener interface */
+/**
+ * An interface that describes the possible events that will be emitted from a
+ * Stats instance. Stats exporters should implement this interface.
+ */
 export interface StatsEventListener {
+  /**
+   * Is called whenever a new view is registered
+   * @param view The registered view
+   */
   onRegisterView(view: View): void;
+  /**
+   * Is called whenever a new measurement is recorded.
+   * @param view The view related to the measurement
+   * @param measurement The recorded measurement
+   */
   onRecord(view: View, measurement: Measurement): void;
 }
 

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

@@ -45,13 +45,9 @@ export * from './exporters/console-exporter';
 // classes
 export * from './stats/stats';
 export * from './stats/view';
-export * from './stats/aggregation/count-aggregation';
-export * from './stats/aggregation/sum-aggregation';
-export * from './stats/aggregation/last-value-aggregation';
-export * from './stats/aggregation/distribution-aggregation';
+export * from './stats/recorder';
 
 // interfaces
-export * from './stats/aggregation/types';
 export * from './stats/types';
 
 // logger

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

@@ -14,23 +14,12 @@
  * limitations under the License.
  */
 
-import {Measurement, Tags} from '../types';
+import {AggregationData, Measurement} from './types';
 
-import {AggregationType, SumData} from './types';
-
-export class SumAggregation implements SumData {
-  /** The aggregation type of the aggregation data */
-  readonly type: AggregationType;
-  /** The tags/labels that this AggregationData collects and aggregates */
-  readonly tags: Tags;
-  /** The latest timestamp a new data point was recorded */
-  timestamp: number;
-  /** The current accumulated value */
-  value: number;
-
-  constructor() {}
-
-  addMeasurement(measurement: Measurement): void {
-    // TODO: To be implemented
+export class Recorder {
+  static addMeasurement(
+      aggregationData: AggregationData,
+      measurement: Measurement): AggregationData {
+    throw new Error('Not Implemented');
   }
 }

packages/opencensus-core/src/index.ts

@@ -16,8 +16,7 @@
 
 import {StatsEventListener} from '../exporters/types';
 
-import {AggregationType} from './aggregation/types';
-import {Measure, Measurement, MeasureUnit, View} from './types';
+import {AggregationType, Measure, Measurement, MeasureUnit, View} from './types';
 
 export class Stats {
   /** A list of Stats exporters */
@@ -33,7 +32,7 @@ export class Stats {
    * @param view The view to be registered
    */
   registerView(view: View) {
-    // TODO: To be implemented
+    throw new Error('Not Implemented');
   }
 
   /**
@@ -47,16 +46,15 @@ export class Stats {
   createView(
       name: string, measure: Measure, aggregation: AggregationType,
       tagKeys: string[], description?: string): View {
-    // TODO: To be implemented
-    return null;
+    throw new Error('Not Implemented');
   }
 
   /**
    * Registers an exporter to send stats data to a service.
    * @param exporter An stats exporter
    */
   registerExporter(exporter: StatsEventListener) {
-    // TODO: To be implemented
+    throw new Error('Not Implemented');
   }
 
   /**
@@ -67,27 +65,26 @@ export class Stats {
    */
   createMeasureDouble(name: string, unit: MeasureUnit, description?: string):
       Measure {
-    // TODO: To be implemented
-    return null;
+    throw new Error('Not Implemented');
   }
 
   /**
-   * Creates a measure of type Int64.
+   * Creates a measure of type Int64. Values must be integers up to
+   * Number.MAX_SAFE_INTERGER.
    * @param name The measure name
    * @param unit The measure unit
    * @param description The measure description
    */
-  createMeasureInt(name: string, unit: MeasureUnit, description?: string):
+  createMeasureInt64(name: string, unit: MeasureUnit, description?: string):
       Measure {
-    // TODO: To be implemented
-    return null;
+    throw new Error('Not Implemented');
   }
 
   /**
    * Updates all views with the new measurements.
    * @param measurements A list of measurements to record
    */
   record(measurements: Measurement[]) {
-    // TODO: To be implemented
+    throw new Error('Not Implemented');
   }
-}
+}