Rename prefix name for [StackdriverStatsExporter] (#185)

* Uses `require` instead of `import` for [hex2dec] package * Renames metrixPrefix to prefix for [stackdriver] * Adds package locks
census-instrumentation · Nov 13, 2018 · 18e8981 · 18e8981
1 parent 49b1185
commit 18e8981
Show file tree

Hide file tree

Showing 24 changed files with 10,710 additions and 14,746 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/opencensus-core/package-lock.json b/packages/opencensus-core/package-lock.json
diff --git a/packages/opencensus-exporter-instana/package-lock.json b/packages/opencensus-exporter-instana/package-lock.json
diff --git a/packages/opencensus-exporter-jaeger/package-lock.json b/packages/opencensus-exporter-jaeger/package-lock.json
diff --git a/packages/opencensus-exporter-ocagent/package-lock.json b/packages/opencensus-exporter-ocagent/package-lock.json
diff --git a/packages/opencensus-exporter-stackdriver/package-lock.json b/packages/opencensus-exporter-stackdriver/package-lock.json
diff --git a/packages/opencensus-exporter-stackdriver/src/modules.d.ts b/packages/opencensus-exporter-stackdriver/src/modules.d.ts
diff --git a/packages/opencensus-exporter-stackdriver/src/stackdriver-cloudtrace.ts b/packages/opencensus-exporter-stackdriver/src/stackdriver-cloudtrace.ts
@@ -18,7 +18,9 @@ import {Exporter, ExporterBuffer, ExporterConfig, RootSpan, Span, SpanContext} f
 import {logger, Logger} from '@opencensus/core';
 import {auth, JWT} from 'google-auth-library';
 import {google} from 'googleapis';
-import {hexToDec} from 'hex2dec';
+// TODO change to use import when types for hex2dec will be available
+const {hexToDec}: {[key: string]: (input: string) => string} =
+    require('hex2dec');
 
 import {StackdriverExporterOptions, TracesWithCredentials, TranslatedSpan, TranslatedTrace} from './types';
 

diff --git a/packages/opencensus-exporter-stackdriver/src/stackdriver-monitoring.ts b/packages/opencensus-exporter-stackdriver/src/stackdriver-monitoring.ts
@@ -45,8 +45,8 @@ export class StackdriverStatsExporter implements StatsEventListener {
         options.period :
         StackdriverStatsExporter.PERIOD;
     this.projectId = options.projectId;
-    this.metricPrefix = options.metricPrefix ||
-        StackdriverStatsExporter.CUSTOM_OPENCENSUS_DOMAIN;
+    this.metricPrefix =
+        options.prefix || StackdriverStatsExporter.CUSTOM_OPENCENSUS_DOMAIN;
     this.logger = options.logger || logger.logger();
     this.viewToUpload = {};
 

diff --git a/packages/opencensus-exporter-stackdriver/src/types.ts b/packages/opencensus-exporter-stackdriver/src/types.ts
@@ -49,7 +49,7 @@ export interface StackdriverExporterOptions extends ExporterConfig {
    * Prefix for metric overrides the OpenCensus prefix
    * of a stackdriver metric. Optional
    */
-  metricPrefix?: string;
+  prefix?: string;
 
   /**
    * Is called whenever the exporter fails to upload metrics to stackdriver.

diff --git a/packages/opencensus-exporter-stackdriver/test/test-stackdriver-cloudtrace.ts b/packages/opencensus-exporter-stackdriver/test/test-stackdriver-cloudtrace.ts
@@ -18,7 +18,9 @@ import {CoreTracer, RootSpan} from '@opencensus/core';
 import {logger} from '@opencensus/core';
 import * as assert from 'assert';
 import * as fs from 'fs';
-import {hexToDec} from 'hex2dec';
+// TODO change to use import when type package for hex2dec will be available
+const {hexToDec}: {[key: string]: (input: string) => string} =
+    require('hex2dec');
 import * as nock from 'nock';
 
 import {StackdriverExporterOptions, StackdriverTraceExporter, TranslatedTrace} from '../src/';

diff --git a/packages/opencensus-exporter-stackdriver/test/test-stackdriver-monitoring.ts b/packages/opencensus-exporter-stackdriver/test/test-stackdriver-monitoring.ts
@@ -330,43 +330,157 @@ describe('Stackdriver Stats Exporter', function() {
          });
     });
 
-    describe('With metricPrefix option', () => {
-      let prefixExporterOptions: StackdriverExporterOptions;
-      let prefixExporter: StackdriverStatsExporter;
-
-      before(() => {
-        prefixExporterOptions =
-            Object.assign(exporterOptions, {metricPrefix: 'test'});
-        prefixExporter = new StackdriverStatsExporter(prefixExporterOptions);
-        stats.registerExporter(prefixExporter);
-      });
+    describe('With prefix option', () => {
+      describe('should be reflected when onRegisterView is called', () => {
+        const {name} = viewMetricDescriptor;
+        let prefixExporter: StackdriverStatsExporter;
+        beforeEach(() => {
+          if (dryrun) {
+            nocks.metricDescriptors(PROJECT_ID, null, null, false);
+          }
+        });
 
-      after(() => {
-        prefixExporter.close();
-      });
+        afterEach(() => {
+          prefixExporter.close();
+        });
 
-      it(`should be reflected when onRegisterView is called`, async () => {
-        if (dryrun) {
-          nocks.metricDescriptors(PROJECT_ID, null, null, false);
-        }
-        await prefixExporter.onRegisterView(viewMetricDescriptor).then(() => {
-          return assertMetricDescriptor(
-              exporterTestLogger.debugBuffer[0], viewMetricDescriptor,
-              prefixExporterOptions.metricPrefix);
+        it('should use custom domain if prefix is undefined', async () => {
+          prefixExporter = new StackdriverStatsExporter(exporterOptions);
+          stats.registerExporter(prefixExporter);
+          await prefixExporter.onRegisterView(viewMetricDescriptor).then(() => {
+            const metricDescriptor: MetricDescriptor =
+                exporterTestLogger.debugBuffer[0];
+            assert.strictEqual(
+                metricDescriptor.type,
+                `${StackdriverStatsExporter.CUSTOM_OPENCENSUS_DOMAIN}/${name}`);
+          });
+        });
+
+        it('should use custom domain if prefix is null', async () => {
+          const prefixExporterOptions: StackdriverExporterOptions =
+              Object.assign({prefix: null}, exporterOptions);
+          prefixExporter = new StackdriverStatsExporter(prefixExporterOptions);
+          stats.registerExporter(prefixExporter);
+          await prefixExporter.onRegisterView(viewMetricDescriptor).then(() => {
+            const metricDescriptor: MetricDescriptor =
+                exporterTestLogger.debugBuffer[0];
+            assert.strictEqual(
+                metricDescriptor.type,
+                `${StackdriverStatsExporter.CUSTOM_OPENCENSUS_DOMAIN}/${name}`);
+          });
+        });
+
+        it('should use custom domain if prefix is empty', async () => {
+          const prefixExporterOptions: StackdriverExporterOptions =
+              Object.assign({prefix: ''}, exporterOptions);
+          prefixExporter = new StackdriverStatsExporter(prefixExporterOptions);
+          stats.registerExporter(prefixExporter);
+          await prefixExporter.onRegisterView(viewMetricDescriptor).then(() => {
+            const metricDescriptor: MetricDescriptor =
+                exporterTestLogger.debugBuffer[0];
+            assert.strictEqual(
+                metricDescriptor.type,
+                `${StackdriverStatsExporter.CUSTOM_OPENCENSUS_DOMAIN}/${name}`);
+          });
+        });
+
+        it('should use defined prefix', async () => {
+          const prefix = 'test';
+          const prefixExporterOptions: StackdriverExporterOptions =
+              Object.assign({prefix}, exporterOptions);
+          prefixExporter = new StackdriverStatsExporter(prefixExporterOptions);
+          stats.registerExporter(prefixExporter);
+          await prefixExporter.onRegisterView(viewMetricDescriptor).then(() => {
+            const metricDescriptor: MetricDescriptor =
+                exporterTestLogger.debugBuffer[0];
+            assert.strictEqual(metricDescriptor.type, `${prefix}/${name}`);
+          });
         });
       });
 
-      it(`should be reflected when onRecord is called`, async () => {
-        if (dryrun) {
-          nocks.timeSeries(PROJECT_ID, null, null, false);
-        }
-        viewTimeSeries.recordMeasurement(measurement);
-        prefixExporter.onRecord([viewTimeSeries], measurement);
+      describe('should be reflected when onRecord is called', () => {
+        let prefixExporter: StackdriverStatsExporter;
+        const {name} = viewTimeSeries;
 
-        await new Promise((resolve) => setTimeout(resolve, DELAY)).then(() => {
-          return assertTimeSeries(
-              exporterTestLogger.debugBuffer[0][0], viewTimeSeries, measurement,
-              PROJECT_ID, prefixExporterOptions.metricPrefix);
+        beforeEach(() => {
+          if (dryrun) {
+            nocks.timeSeries(PROJECT_ID, null, null, false);
+          }
+        });
+
+        afterEach(() => {
+          prefixExporter.close();
+        });
+
+        it('should use custom domain if prefix is undefined', async () => {
+          prefixExporter = new StackdriverStatsExporter(exporterOptions);
+          stats.registerExporter(prefixExporter);
+
+          viewTimeSeries.recordMeasurement(measurement);
+          prefixExporter.onRecord([viewTimeSeries], measurement);
+
+          await new Promise((resolve) => setTimeout(resolve, DELAY))
+              .then(() => {
+                const timeSeries = exporterTestLogger.debugBuffer[0][0];
+                assert.strictEqual(
+                    timeSeries.metric.type,
+                    `${StackdriverStatsExporter.CUSTOM_OPENCENSUS_DOMAIN}/${
+                        name}`);
+              });
+        });
+
+        it('should use custom domain if prefix is null', async () => {
+          const prefixExporterOptions: StackdriverExporterOptions =
+              Object.assign({prefix: null}, exporterOptions);
+          prefixExporter = new StackdriverStatsExporter(prefixExporterOptions);
+          stats.registerExporter(prefixExporter);
+
+          viewTimeSeries.recordMeasurement(measurement);
+          prefixExporter.onRecord([viewTimeSeries], measurement);
+
+          await new Promise((resolve) => setTimeout(resolve, DELAY))
+              .then(() => {
+                const timeSeries = exporterTestLogger.debugBuffer[0][0];
+                assert.strictEqual(
+                    timeSeries.metric.type,
+                    `${StackdriverStatsExporter.CUSTOM_OPENCENSUS_DOMAIN}/${
+                        name}`);
+              });
+        });
+
+        it('should use custom domain if prefix is empty', async () => {
+          const prefixExporterOptions: StackdriverExporterOptions =
+              Object.assign({prefix: ''}, exporterOptions);
+          prefixExporter = new StackdriverStatsExporter(prefixExporterOptions);
+          stats.registerExporter(prefixExporter);
+
+          viewTimeSeries.recordMeasurement(measurement);
+          prefixExporter.onRecord([viewTimeSeries], measurement);
+
+          await new Promise((resolve) => setTimeout(resolve, DELAY))
+              .then(() => {
+                const timeSeries = exporterTestLogger.debugBuffer[0][0];
+                assert.strictEqual(
+                    timeSeries.metric.type,
+                    `${StackdriverStatsExporter.CUSTOM_OPENCENSUS_DOMAIN}/${
+                        name}`);
+              });
+        });
+
+        it('should use defined prefix', async () => {
+          const prefix = 'test';
+          const prefixExporterOptions: StackdriverExporterOptions =
+              Object.assign(exporterOptions, {prefix});
+          prefixExporter = new StackdriverStatsExporter(prefixExporterOptions);
+
+          viewTimeSeries.recordMeasurement(measurement);
+          prefixExporter.onRecord([viewTimeSeries], measurement);
+
+          await new Promise((resolve) => setTimeout(resolve, DELAY))
+              .then(() => {
+                const timeSeries = exporterTestLogger.debugBuffer[0][0];
+                assert.strictEqual(timeSeries.metric.type, `${prefix}/${name}`);
+              });
         });
       });
     });

diff --git a/packages/opencensus-exporter-zipkin/package-lock.json b/packages/opencensus-exporter-zipkin/package-lock.json