packages/core/lib/middleware/sampling/local_reservoir.js

/**
 * Represents a LocalReservoir object that keeps track of the number of traces per second sampled and
 * the fixed rate for a given sampling rule defined locally.
 * It also decides if a given trace should be sampled or not based on the state of current second.
 * @constructor
 * @param {number} fixedTarget - An integer value to specify the maximum number of traces per second to sample.
 * @param {number} fallbackRate - A value between 0 and 1 indicating the sampling rate after the maximum traces per second has been hit.
 */

function LocalReservoir (fixedTarget, fallbackRate) {
  this.init(fixedTarget, fallbackRate);
}

LocalReservoir.prototype.init = function init(fixedTarget, fallbackRate) {
  this.usedThisSecond = 0;

  if (typeof fixedTarget === 'number' && fixedTarget % 1 === 0 && fixedTarget >= 0) {
    this.fixedTarget = fixedTarget;
  } else {
    throw new Error('Error in sampling file. Rule attribute "fixed_target" must be a non-negative integer.');
  }

  if (typeof fallbackRate === 'number' && fallbackRate >= 0 && fallbackRate <= 1) {
    this.fallbackRate = fallbackRate;
  } else {
    throw new Error('Error in sampling file. Rule attribute "rate" must be a number between 0 and 1 inclusive.');
  }
};

LocalReservoir.prototype.isSampled = function isSampled() {
  var now = Math.round(new Date().getTime() / 1000);

  if (now !== this.thisSecond) {
    this.usedThisSecond = 0;
    this.thisSecond = now;
  }

  if (this.usedThisSecond >= this.fixedTarget) {
    return Math.random() < this.fallbackRate;
  }

  this.usedThisSecond++;
  return true;
};

module.exports = LocalReservoir;