@opencensus/core/build/src/exporters/exporter-buffer.js

"use strict";
/**
 * Copyright 2018, OpenCensus Authors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
Object.defineProperty(exports, "__esModule", { value: true });
exports.ExporterBuffer = void 0;
const logger = require("../common/console-logger");
const DEFAULT_BUFFER_SIZE = 100;
const DEFAULT_BUFFER_TIMEOUT = 20000;
/** Controls the sending of traces to exporters. */
class ExporterBuffer {
    /**
     * Constructs a new Buffer instance.
     * @param exporter The service to send the collected spans.
     * @param config A buffer configuration object to create a buffer.
     */
    constructor(exporter, config) {
        /** Manage when the buffer timeout needs to be reseted */
        this.resetTimeout = false;
        /** Indicates when the buffer timeout is running */
        this.bufferTimeoutInProgress = false;
        /** Trace queue of a buffer */
        this.queue = [];
        this.exporter = exporter;
        this.logger = config.logger || logger.logger();
        this.bufferSize = isNaN(Number(config.bufferSize))
            ? DEFAULT_BUFFER_SIZE
            : Number(config.bufferSize);
        this.bufferTimeout = isNaN(Number(config.bufferTimeout))
            ? DEFAULT_BUFFER_TIMEOUT
            : Number(config.bufferTimeout);
        return this;
    }
    /**
     * Set the buffer size value.
     * @param bufferSize The new buffer size.
     */
    setBufferSize(bufferSize) {
        this.bufferSize = bufferSize;
        return this;
    }
    getBufferSize() {
        return this.bufferSize;
    }
    getQueue() {
        return this.queue;
    }
    /**
     * Add a span in the buffer.
     * @param span Span to be added in the buffer.
     */
    addToBuffer(span) {
        this.queue.push(span);
        this.logger.debug('ExporterBuffer: added new span');
        if (this.queue.length > this.bufferSize) {
            this.flush();
        }
        if (this.bufferTimeoutInProgress) {
            this.resetBufferTimeout();
        }
        else {
            this.setBufferTimeout();
        }
        return this;
    }
    /** Reset the buffer timeout */
    resetBufferTimeout() {
        this.logger.debug('ExporterBuffer: reset timeout');
        this.resetTimeout = true;
    }
    /** Start the buffer timeout, when finished calls flush method */
    setBufferTimeout() {
        this.logger.debug('ExporterBuffer: set timeout');
        this.bufferTimeoutInProgress = true;
        const timer = setTimeout(() => {
            if (this.queue.length === 0) {
                return;
            }
            if (this.resetTimeout) {
                this.resetTimeout = false;
                this.setBufferTimeout();
            }
            else {
                this.bufferTimeoutInProgress = false;
                this.flush();
            }
        }, this.bufferTimeout);
        // Don't let this timer be the only thing keeping the process alive
        timer.unref();
    }
    /** Send the trace queue to all exporters */
    flush() {
        this.exporter.publish(this.queue);
        this.queue = [];
        return this;
    }
}
exports.ExporterBuffer = ExporterBuffer;
//# sourceMappingURL=exporter-buffer.js.map