open-telemetry · sgracias1 · Jun 29, 2022 · Jun 29, 2022 · Jun 29, 2022 · Jul 27, 2022
@@ -8,6 +8,7 @@ All notable changes to this project will be documented in this file.
 
 ### :rocket: (Enhancement)
 
+* feat(SpanExpoter): Add optional forceFlush to SpanExporter interface [#3067] @sgracias1
 * feat(sdk-trace-base): move Sampler declaration into sdk-trace-base [#3088](https:/open-telemetry/opentelemetry-js/pull/3088) @legendecas
 * fix(grpc-instrumentation): added grpc attributes in instrumentation [#3127](https:/open-telemetry/opentelemetry-js/pull/3127) @andrewzenkov
 

@@ -49,6 +49,11 @@ class DummySpanExporter implements tracing.SpanExporter {
  shutdown() {
  return Promise.resolve();
  }
+
+ forceFlush(): Promise<void> {
+ return Promise.resolve();
+ }
+
 }
 
 const getData = (url: string, method?: string) => {

@@ -47,6 +47,10 @@ class DummySpanExporter implements tracing.SpanExporter {
  shutdown() {
  return Promise.resolve();
  }
+
+ forceFlush(): Promise<void> {
+ return Promise.resolve();
+ }
 }
 
 const XHR_TIMEOUT = 2000;

@@ -110,16 +110,20 @@ export abstract class OTLPExporterBase<
  return this._shutdownOnce.call();
  }
 
+ /**
+ * Exports any pending spans in the exporter
+ */
+ forceFlush(): Promise<void> {
+ return Promise.all(this._sendingPromises).then(() => {});
+ }
+
  /**
  * Called by _shutdownOnce with BindOnceFuture
  */
  private _shutdown(): Promise<void> {
  diag.debug('shutdown started');
  this.onShutdown();
- return Promise.all(this._sendingPromises)
- .then(() => {
- /** ignore resolved values */
- });
+ return this.forceFlush();
  }
 
  abstract onShutdown(): void;

@@ -60,6 +60,13 @@ class Exporter extends OTLPExporterNodeBase<object,object> {
  }
 }
 
+describe('force flush', () => {
+ it('forceFlush should flush spans and return', async () => {
+ const exporter = new Exporter({});
+ await exporter.forceFlush();
+ });
+});
+
 describe('configureExporterTimeout', () => {
  const envSource = process.env;
  it('should use timeoutMillis parameter as export timeout value', () => {

@@ -82,6 +82,13 @@ export class JaegerExporter implements SpanExporter {
  return this._shutdownOnce.call();
  }
 
+ /**
+ * Exports any pending spans in exporter
+ */
+ forceFlush(): Promise<void> {
+ return this._flush();
+ }
+
  private _shutdown(): Promise<void> {
  return Promise.race([
  new Promise<void>((_resolve, reject) => {

@@ -166,6 +166,14 @@ describe('JaegerExporter', () => {
  });
  });
 
+ describe('force flush', () => {
+ let exporter: JaegerExporter;
+ it('forceFlush should flush spans and return', async () => {
+ exporter = new JaegerExporter();
+ await exporter.forceFlush();
+ });
+ });
+
  describe('export', () => {
  let exporter: JaegerExporter;
 

@@ -102,6 +102,13 @@ export class ZipkinExporter implements SpanExporter {
  shutdown(): Promise<void> {
  diag.debug('Zipkin exporter shutdown');
  this._isShutdown = true;
+ return this.forceFlush();
+ }
+
+ /**
+ * Exports any pending spans in exporter
+ */
+ forceFlush(): Promise<void> {
  return new Promise((resolve, reject) => {
  Promise.all(this._sendingPromises).then(() => {
  resolve();

@@ -509,6 +509,13 @@ describe('Zipkin Exporter - node', () => {
  });
  });
 
+ describe('force flush', () => {
+ it('forceFlush should flush spans and return', async () => {
+ const exporter = new ZipkinExporter({});
+ await exporter.forceFlush();
+ });
+ });
+
  describe('when env.OTEL_EXPORTER_ZIPKIN_ENDPOINT is set', () => {
  before(() => {
  process.env.OTEL_EXPORTER_ZIPKIN_ENDPOINT = 'http://localhost:9412';

@@ -46,6 +46,13 @@ export class ConsoleSpanExporter implements SpanExporter {
  */
  shutdown(): Promise<void> {
  this._sendSpans([]);
+ return this.forceFlush();
+ }
+
+ /**
+ * Exports any pending spans in exporter
+ */
+ forceFlush(): Promise<void> {
  return Promise.resolve();
  }
 

@@ -48,6 +48,13 @@ export class InMemorySpanExporter implements SpanExporter {
  shutdown(): Promise<void> {
  this._stopped = true;
  this._finishedSpans = [];
+ return this.forceFlush();
+ }
+
+ /**
+ * Exports any pending spans in the exporter
+ */
+ forceFlush(): Promise<void> {
  return Promise.resolve();
  }
 

@@ -40,8 +40,7 @@ export class SimpleSpanProcessor implements SpanProcessor {
  }
 
  forceFlush(): Promise<void> {
- // do nothing as all spans are being exported without waiting
- return Promise.resolve();
+ return this._exporter.forceFlush();
  }
 
  // does nothing.

@@ -36,4 +36,7 @@ export interface SpanExporter {
 
  /** Stops the exporter. */
  shutdown(): Promise<void>;
+
+ /** Immediately export all spans */
+ forceFlush(): Promise<void>;
 }
@@ -99,4 +99,11 @@ describe('ConsoleSpanExporter', () => {
  });
  });
  });
+
+ describe('force flush', () => {
+ it('forceFlush should flush spans and return', async () => {
+ consoleExporter = new ConsoleSpanExporter();
+ await consoleExporter.forceFlush();
+ });
+ });
 });
@@ -80,6 +80,13 @@ describe('InMemorySpanExporter', () => {
  assert.strictEqual(memoryExporter.getFinishedSpans().length, 0);
  });
 
+ describe('force flush', () => {
+ it('forceFlush should flush spans and return', async () => {
+ memoryExporter = new InMemorySpanExporter();
+ await memoryExporter.forceFlush();
+ });
+ });
+
  it('should return the success result', () => {
  const exorter = new InMemorySpanExporter();
  exorter.export([], (result: ExportResult) => {

@@ -149,6 +149,14 @@ describe('SimpleSpanProcessor', () => {
  });
 
  describe('force flush', () => {
+ it('should call forceflush on exporter', () => {
+ const spyflush = sinon.spy(exporter, 'forceFlush');
+ const processor = new SimpleSpanProcessor(exporter);
+ processor.forceFlush().then(() => {
+ });
+ assert.ok(spyflush.calledOnce);
+ });
+
  describe('when flushing complete', () => {
  it('should call an async callback', done => {
  const processor = new SimpleSpanProcessor(exporter);