chore(eslint): no-console error rule (#2018)

open-telemetry · Mar 22, 2021 · f045eef · f045eef
1 parent 6025749
commit f045eef
Show file tree

Hide file tree

Showing 9 changed files with 17 additions and 4 deletions.
diff --git a/eslint.config.js b/eslint.config.js
@@ -26,6 +26,7 @@ module.exports = {
           "leadingUnderscore": "require"
         }
     ],
+    "no-console": "error",
     "no-shadow": "off",
     "@typescript-eslint/no-shadow": ["warn"],
     "@typescript-eslint/no-unused-vars": ["error", {"argsIgnorePattern": "^_", "args": "after-used"}],

diff --git a/packages/opentelemetry-metrics/src/export/ConsoleMetricExporter.ts b/packages/opentelemetry-metrics/src/export/ConsoleMetricExporter.ts
@@ -21,6 +21,8 @@ import { ExportResult, ExportResultCode } from '@opentelemetry/core';
  * This is implementation of {@link MetricExporter} that prints metrics data to
  * the console. This class can be used for diagnostic purposes.
  */
+
+/* eslint-disable no-console */
 export class ConsoleMetricExporter implements MetricExporter {
   export(
     metrics: MetricRecord[],

diff --git a/packages/opentelemetry-metrics/test/Meter.test.ts b/packages/opentelemetry-metrics/test/Meter.test.ts
@@ -804,7 +804,7 @@ describe('Meter', () => {
       let counter = 0;
 
       function getValue() {
-        console.log('getting value, counter:', counter);
+        diag.info('getting value, counter:', counter);
         if (++counter % 2 === 0) {
           return 3;
         }

diff --git a/packages/opentelemetry-metrics/test/export/ConsoleMetricExporter.test.ts b/packages/opentelemetry-metrics/test/export/ConsoleMetricExporter.test.ts
@@ -19,6 +19,7 @@ import * as sinon from 'sinon';
 import { ConsoleMetricExporter, MeterProvider, MetricKind } from '../../src';
 import { ValueType } from '@opentelemetry/api-metrics';
 
+/* eslint-disable no-console */
 describe('ConsoleMetricExporter', () => {
   let consoleExporter: ConsoleMetricExporter;
   let previousConsoleLog: any;

diff --git a/packages/opentelemetry-tracing/src/export/ConsoleSpanExporter.ts b/packages/opentelemetry-tracing/src/export/ConsoleSpanExporter.ts
@@ -26,6 +26,8 @@ import {
  * This is implementation of {@link SpanExporter} that prints spans to the
  * console. This class can be used for diagnostic purposes.
  */
+
+/* eslint-disable no-console */
 export class ConsoleSpanExporter implements SpanExporter {
   /**
    * Export spans.

diff --git a/packages/opentelemetry-tracing/test/export/BatchSpanProcessor.test.ts b/packages/opentelemetry-tracing/test/export/BatchSpanProcessor.test.ts
@@ -14,6 +14,7 @@
  * limitations under the License.
  */
 
+import { diag } from '@opentelemetry/api';
 import {
   AlwaysOnSampler,
   ExportResultCode,
@@ -237,7 +238,10 @@ describe('BatchSpanProcessor', () => {
             clock.tick(defaultBufferConfig.scheduledDelayMillis + 10);
             clock.restore();
 
-            console.log(exporter.getFinishedSpans().length);
+            diag.info(
+              'finished spans count',
+              exporter.getFinishedSpans().length
+            );
             assert.strictEqual(
               exporter.getFinishedSpans().length,
               totalSpans + 1

diff --git a/packages/opentelemetry-tracing/test/export/ConsoleSpanExporter.test.ts b/packages/opentelemetry-tracing/test/export/ConsoleSpanExporter.test.ts
@@ -22,6 +22,7 @@ import {
   SimpleSpanProcessor,
 } from '../../src';
 
+/* eslint-disable no-console */
 describe('ConsoleSpanExporter', () => {
   let consoleExporter: ConsoleSpanExporter;
   let previousConsoleLog: any;

diff --git a/packages/opentelemetry-web/src/WebTracerProvider.ts b/packages/opentelemetry-web/src/WebTracerProvider.ts
@@ -14,6 +14,7 @@
  * limitations under the License.
  */
 
+import { diag } from '@opentelemetry/api';
 import {
   BasicTracerProvider,
   SDKRegistrationConfig,
@@ -41,7 +42,7 @@ export class WebTracerProvider extends BasicTracerProvider {
    */
   constructor(config: WebTracerConfig = {}) {
     if (typeof config.plugins !== 'undefined') {
-      console.warn(
+      diag.warn(
         'plugins option was removed, please use' +
           ' "registerInstrumentations" to load plugins'
       );

diff --git a/packages/opentelemetry-web/test/WebTracerProvider.test.ts b/packages/opentelemetry-web/test/WebTracerProvider.test.ts
@@ -14,6 +14,7 @@
  * limitations under the License.
  */
 
+import { diag } from '@opentelemetry/api';
 import { context, getSpan, setSpan, ContextManager } from '@opentelemetry/api';
 import { ZoneContextManager } from '@opentelemetry/context-zone';
 import { B3Propagator } from '@opentelemetry/propagator-b3';
@@ -49,7 +50,7 @@ describe('WebTracerProvider', () => {
 
     it('should show warning when plugins are defined', () => {
       const dummyPlugin1 = {};
-      const spyWarn = sinon.spy(window.console, 'warn');
+      const spyWarn = sinon.spy(diag, 'warn');
 
       const plugins = [dummyPlugin1];