Skip to content

Commit

Permalink
feat(jaeger-exporter): adds flushing on an interval (#341)
Browse files Browse the repository at this point in the history
* feat(jaeger-exporter): adds flushing on an interval

closes open-telemetry/opentelemetry-js#340

* respond to comments

* yarn fix
  • Loading branch information
bg451 authored Sep 26, 2019
1 parent 75251fc commit c1ce949
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 5 deletions.
20 changes: 15 additions & 5 deletions packages/opentelemetry-exporter-jaeger/src/jaeger.ts
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ import * as jaegerTypes from './types';
import { NoopLogger } from '@opentelemetry/core';
import * as types from '@opentelemetry/types';
import { spanToThrift } from './transform';
import { unrefTimer } from '@opentelemetry/core';

/**
* Format and sends span information to Jaeger Exporter.
Expand All @@ -33,6 +34,7 @@ export class JaegerExporter implements SpanExporter {
private readonly _sender: typeof jaegerTypes.UDPSender;
private readonly _forceFlush: boolean = true;
private readonly _flushTimeout: number;
private _timer: NodeJS.Timeout;

constructor(config: jaegerTypes.ExporterConfig) {
this._logger = config.logger || new NoopLogger();
Expand All @@ -48,6 +50,10 @@ export class JaegerExporter implements SpanExporter {
tags: jaegerTypes.ThriftUtils.getThriftTags(tags),
};
this._sender.setProcess(this._process);

const flushInterval = config.flushInterval || 5000;
this._timer = setInterval(this._flush, flushInterval);
unrefTimer(this._timer);
}

/** Exports a list of spans to Jaeger. */
Expand All @@ -63,11 +69,7 @@ export class JaegerExporter implements SpanExporter {
shutdown(): void {
if (!this._forceFlush) return;
// Make an optimistic flush.
this._sender.flush((numSpans: number, err?: string) => {
if (err) {
this._logger.error(`failed to flush span: ${err}`);
}
});
this._flush();
// Sleeping x seconds before closing the sender's connection to ensure
// all spans are flushed.
setTimeout(() => {
Expand Down Expand Up @@ -95,4 +97,12 @@ export class JaegerExporter implements SpanExporter {
this._logger.debug('successful append for : %s', thriftSpan.length);
if (done) return done(ExportResult.SUCCESS);
}

private _flush(): void {
this._sender.flush((numSpans: number, err?: string) => {
if (err) {
this._logger.error(`failed to flush ${numSpans} spans: ${err}`);
}
});
}
}
1 change: 1 addition & 0 deletions packages/opentelemetry-exporter-jaeger/src/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ export interface ExporterConfig {
maxPacketSize?: number; // default: 65000
forceFlush?: boolean; // default: true
flushTimeout?: number; // default: 2000
flushInterval?: number; // default(ms): 5000
}

// Below require is needed as jaeger-client types does not expose the thrift,
Expand Down

0 comments on commit c1ce949

Please sign in to comment.