fix(span): rename span recording flag (open-telemetry#454)

xiao-lix · mayurkale22 · commit 972faa241c2a · 2019-10-22T16:31:30.000-07:00
* fix(span): rename span recording flag

* Update packages/opentelemetry-types/src/trace/SpanOptions.ts

Co-Authored-By: Mayur Kale &lt;mayurkale@google.com&gt;

* fix: linting errors
diff --git a/packages/opentelemetry-core/src/trace/NoopSpan.ts b/packages/opentelemetry-core/src/trace/NoopSpan.ts
@@ -66,8 +66,8 @@ export class NoopSpan implements types.Span {
   // By default does nothing
   end(endTime?: types.TimeInput): void {}
 
-  // isRecordingEvents always returns false for noopSpan.
-  isRecordingEvents(): boolean {
+  // isRecording always returns false for noopSpan.
+  isRecording(): boolean {
     return false;
   }
 }
diff --git a/packages/opentelemetry-core/test/trace/NoopSpan.test.ts b/packages/opentelemetry-core/test/trace/NoopSpan.test.ts
@@ -51,7 +51,7 @@ describe('NoopSpan', () => {
 
     span.updateName('my-span');
 
-    assert.ok(!span.isRecordingEvents());
+    assert.ok(!span.isRecording());
     assert.deepStrictEqual(span.context(), {
       traceId: INVALID_TRACEID,
       spanId: INVALID_SPANID,
diff --git a/packages/opentelemetry-core/test/trace/NoopTracer.test.ts b/packages/opentelemetry-core/test/trace/NoopTracer.test.ts
@@ -32,7 +32,7 @@ describe('NoopTracer', () => {
     assert.deepStrictEqual(
       tracer.startSpan('span-name2', {
         kind: SpanKind.CLIENT,
-        isRecordingEvents: true,
+        isRecording: true,
       }),
       NOOP_SPAN
     );
diff --git a/packages/opentelemetry-node/test/NodeTracer.test.ts b/packages/opentelemetry-node/test/NodeTracer.test.ts
@@ -146,7 +146,7 @@ describe('NodeTracer', () => {
       const span = tracer.startSpan('my-span');
       assert.ok(span instanceof NoRecordingSpan);
       assert.strictEqual(span.context().traceFlags, TraceFlags.UNSAMPLED);
-      assert.strictEqual(span.isRecordingEvents(), false);
+      assert.strictEqual(span.isRecording(), false);
     });
 
     // @todo: implement
diff --git a/packages/opentelemetry-tracing/src/BasicTracer.ts b/packages/opentelemetry-tracing/src/BasicTracer.ts
@@ -88,7 +88,7 @@ export class BasicTracer implements types.Tracer {
       ? TraceFlags.SAMPLED
       : TraceFlags.UNSAMPLED;
     const spanContext = { traceId, spanId, traceFlags, traceState };
-    const recordEvents = options.isRecordingEvents || false;
+    const recordEvents = options.isRecording || false;
     if (!recordEvents && !samplingDecision) {
       this.logger.debug('Sampling is off, starting no recording span');
       return new NoRecordingSpan(spanContext);
diff --git a/packages/opentelemetry-tracing/src/Span.ts b/packages/opentelemetry-tracing/src/Span.ts
@@ -148,7 +148,7 @@ export class Span implements types.Span, ReadableSpan {
     this._spanProcessor.onEnd(this);
   }
 
-  isRecordingEvents(): boolean {
+  isRecording(): boolean {
     return true;
   }
 
diff --git a/packages/opentelemetry-tracing/src/SpanProcessor.ts b/packages/opentelemetry-tracing/src/SpanProcessor.ts
@@ -22,14 +22,14 @@ import { Span } from '@opentelemetry/types';
  */
 export interface SpanProcessor {
   /**
-   * Called when a {@link Span} is started, if the `span.isRecordingEvents()`
+   * Called when a {@link Span} is started, if the `span.isRecording()`
    * returns true.
    * @param span the Span that just started.
    */
   onStart(span: Span): void;
 
   /**
-   * Called when a {@link Span} is ended, if the `span.isRecordingEvents()`
+   * Called when a {@link Span} is ended, if the `span.isRecording()`
    * returns true.
    * @param span the Span that just ended.
    */
diff --git a/packages/opentelemetry-tracing/test/BasicTracer.test.ts b/packages/opentelemetry-tracing/test/BasicTracer.test.ts
@@ -251,21 +251,21 @@ describe('BasicTracer', () => {
       const tracer = new BasicTracer({
         sampler: NEVER_SAMPLER,
       });
-      const span = tracer.startSpan('my-span', { isRecordingEvents: true });
+      const span = tracer.startSpan('my-span', { isRecording: true });
       assert.ok(span instanceof Span);
       assert.strictEqual(span.context().traceFlags, TraceFlags.UNSAMPLED);
-      assert.strictEqual(span.isRecordingEvents(), true);
+      assert.strictEqual(span.isRecording(), true);
     });
 
     it('should not create real span when not sampled and recording events false', () => {
       const tracer = new BasicTracer({
         sampler: NEVER_SAMPLER,
         logger: new NoopLogger(),
       });
-      const span = tracer.startSpan('my-span', { isRecordingEvents: false });
+      const span = tracer.startSpan('my-span', { isRecording: false });
       assert.ok(span instanceof NoRecordingSpan);
       assert.strictEqual(span.context().traceFlags, TraceFlags.UNSAMPLED);
-      assert.strictEqual(span.isRecordingEvents(), false);
+      assert.strictEqual(span.isRecording(), false);
     });
 
     it('should not create real span when not sampled and no recording events configured', () => {
@@ -276,18 +276,18 @@ describe('BasicTracer', () => {
       const span = tracer.startSpan('my-span');
       assert.ok(span instanceof NoRecordingSpan);
       assert.strictEqual(span.context().traceFlags, TraceFlags.UNSAMPLED);
-      assert.strictEqual(span.isRecordingEvents(), false);
+      assert.strictEqual(span.isRecording(), false);
     });
 
     it('should create real span when sampled and recording events true', () => {
       const tracer = new BasicTracer({
         sampler: ALWAYS_SAMPLER,
         scopeManager: new NoopScopeManager(),
       });
-      const span = tracer.startSpan('my-span', { isRecordingEvents: true });
+      const span = tracer.startSpan('my-span', { isRecording: true });
       assert.ok(span instanceof Span);
       assert.strictEqual(span.context().traceFlags, TraceFlags.SAMPLED);
-      assert.strictEqual(span.isRecordingEvents(), true);
+      assert.strictEqual(span.isRecording(), true);
     });
 
     it('should set default attributes on span', () => {
diff --git a/packages/opentelemetry-tracing/test/Span.test.ts b/packages/opentelemetry-tracing/test/Span.test.ts
@@ -93,13 +93,13 @@ describe('Span', () => {
     assert.strictEqual(context.traceFlags, TraceFlags.SAMPLED);
     assert.strictEqual(context.traceState, undefined);
     assert.ok(context.spanId.match(/[a-f0-9]{16}/));
-    assert.ok(span.isRecordingEvents());
+    assert.ok(span.isRecording());
     span.end();
   });
 
-  it('should return true when isRecordingEvents:true', () => {
+  it('should return true when isRecording:true', () => {
     const span = new Span(tracer, name, spanContext, SpanKind.CLIENT);
-    assert.ok(span.isRecordingEvents());
+    assert.ok(span.isRecording());
     span.end();
   });
 
diff --git a/packages/opentelemetry-tracing/test/export/BatchSpanProcessor.test.ts b/packages/opentelemetry-tracing/test/export/BatchSpanProcessor.test.ts
@@ -37,7 +37,7 @@ function createUnSampledSpan(spanName: string): Span {
     sampler: NEVER_SAMPLER,
     logger: new NoopLogger(),
   });
-  const span = tracer.startSpan(spanName, { isRecordingEvents: false });
+  const span = tracer.startSpan(spanName, { isRecording: false });
   span.end();
   return span as Span;
 }
diff --git a/packages/opentelemetry-types/src/trace/SpanOptions.ts b/packages/opentelemetry-types/src/trace/SpanOptions.ts
@@ -29,8 +29,8 @@ export interface SpanOptions {
   /** A spans attributes */
   attributes?: Attributes;
 
-  /** Indicates that events are being recorded for a span */
-  isRecordingEvents?: boolean;
+  /** Indicates that if this Span is active and recording information like events with the `AddEvent` operation and attributes using `setAttributes`. */
+  isRecording?: boolean;
 
   /**
    * A parent SpanContext (or Span, for convenience) that the newly-started
diff --git a/packages/opentelemetry-types/src/trace/span.ts b/packages/opentelemetry-types/src/trace/span.ts
@@ -102,5 +102,5 @@ export interface Span {
    * @returns true if this Span is active and recording information like events
    * with the AddEvent operation and attributes using setAttributes.
    */
-  isRecordingEvents(): boolean;
+  isRecording(): boolean;
 }

Original file line number	Diff line number	Diff line change
`@@ -66,8 +66,8 @@ export class NoopSpan implements types.Span {`
`66`	`66`	`// By default does nothing`
`67`	`67`	`end(endTime?: types.TimeInput): void {}`
`68`	`68`
`69`		`- // isRecordingEvents always returns false for noopSpan.`
`70`		`- isRecordingEvents(): boolean {`
	`69`	`+ // isRecording always returns false for noopSpan.`
	`70`	`+ isRecording(): boolean {`
`71`	`71`	`return false;`
`72`	`72`	`}`
`73`	`73`	`}`
Original file line number	Diff line number	Diff line change
`@@ -148,7 +148,7 @@ export class Span implements types.Span, ReadableSpan {`
`148`	`148`	`this._spanProcessor.onEnd(this);`
`149`	`149`	`}`
`150`	`150`
`151`		`- isRecordingEvents(): boolean {`
	`151`	`+ isRecording(): boolean {`
`152`	`152`	`return true;`
`153`	`153`	`}`
`154`	`154`
Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,7 @@ function createUnSampledSpan(spanName: string): Span {`
`37`	`37`	`sampler: NEVER_SAMPLER,`
`38`	`38`	`logger: new NoopLogger(),`
`39`	`39`	`});`
`40`		`- const span = tracer.startSpan(spanName, { isRecordingEvents: false });`
	`40`	`+ const span = tracer.startSpan(spanName, { isRecording: false });`
`41`	`41`	`span.end();`
`42`	`42`	`return span as Span;`
`43`	`43`	`}`