refactor: change design to better fit opencensus' sepecs

Author: eduardoemery

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

@@ -15,7 +15,7 @@
  */
 
 import * as loggerTypes from '../common/types';
-import {Measure, Measurement, View} from '../stats/model/types';
+import {Measure, Measurement, View} from '../stats/types';
 import * as modelTypes from '../trace/model/types';
 
 import {ExporterBuffer} from './exporter-buffer';
@@ -77,7 +77,7 @@ export class ConsoleExporter implements types.Exporter {
 }
 
 /** Exporter that receives stats data and shows in the log console. */
-export class ConsoleStatsExporter implements types.StatsExporter {
+export class ConsoleStatsExporter implements types.StatsEventListener {
   /**
    * Event called when a view is registered
    * @param view registered view
@@ -92,7 +92,7 @@ export class ConsoleStatsExporter implements types.StatsExporter {
    * @param view recorded view from measurement
    * @param measurement recorded measurement
    */
-  onRecord(view: View) {
+  onRecord(view: View, measurement: Measurement) {
     console.log(`Measurement recorded: ${view.measure.name}`);
   }
 }

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

@@ -14,8 +14,7 @@
  * limitations under the License.
  */
 
-
-import {Measure, Measurement, View, ViewEventListener} from '../stats/model/types';
+import {Measurement, View} from '../stats/types';
 import * as configTypes from '../trace/config/types';
 import * as modelTypes from '../trace/model/types';
 
@@ -28,7 +27,10 @@ export interface Exporter extends modelTypes.SpanEventListener {
   publish(rootSpans: modelTypes.RootSpan[]): Promise<number|string|void>;
 }
 
-/** Define a StatsExporter interface */
-export interface StatsExporter extends ViewEventListener {}
+/** Defines a StatsEventListener interface */
+export interface StatsEventListener {
+  onRegisterView(view: View): void;
+  onRecord(view: View, measurement: Measurement): void;
+}
 
 export type ExporterConfig = configTypes.BufferConfig;

packages/opencensus-core/src/index.ts

@@ -42,18 +42,17 @@ export * from './exporters/console-exporter';
 
 // STATS CLASSES
 
-// domain models impls
-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/view';
+// 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';
 
 // interfaces
-export * from './stats/model/metrics/types';
-export * from './stats/model/types';
+export * from './stats/aggregation/types';
+export * from './stats/types';
 
 // logger
 import * as logger from './common/console-logger';

packages/opencensus-core/src/stats/aggregation/count-aggregation.ts

@@ -0,0 +1,36 @@
+/**
+ * Copyright 2018, OpenCensus Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import {Measurement, Tags} from '../types';
+
+import {AggregationType, CountData} from './types';
+
+export class CountAggregation implements CountData {
+  /** 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 */
+  readonly timestamp: number;
+  /** The current counted value */
+  readonly value: number;
+
+  constructor() {}
+
+  addMeasurement(measurement: Measurement): void {
+    // TODO: To be implemented
+  }
+}

packages/opencensus-core/src/stats/aggregation/distribution-aggregation.ts

@@ -0,0 +1,60 @@
+/**
+ * Copyright 2018, OpenCensus Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import {Measurement, Tags} from '../types';
+
+import {AggregationType, Bucket, DistributionData} from './types';
+
+export class DistributionAggregation implements DistributionData {
+  /** 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 first timestamp a datapoint was added */
+  readonly startTime: number;
+  /** Get the total count of all recorded values in the histogram */
+  count: number;
+  /** Sum of all recorded values in the histogram */
+  sum: number;
+  /** Max value recorded in the histogram */
+  max: number;
+  /** Min value recorded in the histogram */
+  min: number;
+  /** Get the computed mean value of all recorded values in the histogram */
+  mean: number;
+  /**
+   * Get the computed standard deviation of all recorded values in the
+   * histogram
+   */
+  stdDeviation: number;
+  /**
+   * Get the computed sum of squared deviations of all recorded values in the
+   * histogram.
+   */
+  sumSquaredDeviations: number;
+  /** Bucket distribution of the histogram */
+  buckets: Bucket[];
+  /** The bucket boundaries for a histogram */
+  readonly bucketsBoundaries: number[];
+
+  constructor() {}
+
+  addMeasurement(measurement: Measurement): void {
+    // TODO: To be implemented
+  }
+}

packages/opencensus-core/src/stats/aggregation/last-value-aggregation.ts

@@ -0,0 +1,36 @@
+/**
+ * Copyright 2018, OpenCensus Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import {Measurement, Tags} from '../types';
+
+import {AggregationType, LastValueData} from './types';
+
+export class LastValueAggregation implements LastValueData {
+  /** 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 last recorded value */
+  value: number;
+
+  constructor() {}
+
+  addMeasurement(measurement: Measurement): void {
+    // TODO: To be implemented
+  }
+}

packages/opencensus-core/src/stats/aggregation/sum-aggregation.ts

@@ -0,0 +1,36 @@
+/**
+ * Copyright 2018, OpenCensus Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import {Measurement, Tags} 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
+  }
+}

packages/opencensus-core/src/stats/aggregation/types.ts

@@ -0,0 +1,108 @@
+/**
+ * Copyright 2018, OpenCensus Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import {Measurement, Tags} from '../types';
+
+/**
+ * Informs the type of the aggregation. It can be: count, sum, lastValue or
+ * distribution.
+ */
+export const enum AggregationType {
+  count = 0,
+  sum = 1,
+  lastValue = 2,
+  distribution = 3
+}
+
+/** Defines how data is collected and aggregated */
+export interface AggregationData {
+  /** 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;
+  /**
+   * Adds a new data point to the aggregation.
+   * @param measurement The new data point to aggregate
+   */
+  addMeasurement(measurement: Measurement): void;
+}
+
+/**
+ * Data collected and aggregated with this AggregationData will be summed up.
+ */
+export interface SumData extends AggregationData {
+  /** The current accumulated value */
+  value: number;
+}
+
+/**
+ * This AggregationData counts the number of measurements recorded.
+ */
+export interface CountData extends AggregationData {
+  /** The current counted value */
+  value: number;
+}
+
+/**
+ * This AggregationData represents the last recorded value. This is useful when
+ * giving support to Gauges.
+ */
+export interface LastValueData extends AggregationData {
+  /** The last recorded value */
+  value: number;
+}
+
+/** This AggregationData contains a histogram of the collected values. */
+export interface DistributionData extends AggregationData {
+  /** The first timestamp a datapoint was added */
+  readonly startTime: number;
+  /** Get the total count of all recorded values in the histogram */
+  count: number;
+  /** Sum of all recorded values in the histogram */
+  sum: number;
+  /** Max value recorded in the histogram */
+  max: number;
+  /** Min value recorded in the histogram */
+  min: number;
+  /** Get the computed mean value of all recorded values in the histogram */
+  mean: number;
+  /**
+   * Get the computed standard deviation of all recorded values in the
+   * histogram
+   */
+  stdDeviation: number;
+  /**
+   * Get the computed sum of squared deviations of all recorded values in the
+   * histogram.
+   */
+  sumSquaredDeviations: number;
+  /** Bucket distribution of the histogram */
+  buckets: Bucket[];
+  /** The bucket boundaries for a histogram */
+  readonly bucketsBoundaries: number[];
+}
+
+/** A simple histogram bucket interface. */
+export interface Bucket {
+  /** Number of occurrences in the domain */
+  count: number;
+  /** The maximum bucket limit in domain */
+  readonly max: number;
+  /** The minimum bucket limit in domain */
+  readonly min: number;
+}