feat: TraceIdRatioBasedSampler and re-sync cross agent tests
#3501
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,83 @@ | ||
| /* | ||
| * Copyright 2025 New Relic Corporation. All rights reserved. | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| 'use strict' | ||
| const Sampler = require('./sampler') | ||
|
|
||
| /** | ||
| * Trace ID ratio-based sampler adapted for New Relic agent use, | ||
| * based on OpenTelemetry's sampler of the same name. | ||
| */ | ||
| class TraceIdRatioBasedSampler extends Sampler { | ||
| /** | ||
| * @param {object} opts Sampler options. | ||
| * @param {Agent} opts.agent - The New Relic agent instance. | ||
| * @param {number} opts.ratio - The sampling ratio (0 to 1). | ||
| */ | ||
| constructor(opts) { | ||
| super() // no-op | ||
| if (!opts.agent) { | ||
| throw new Error('must have an agent instance') | ||
| } | ||
| this._ratio = this._normalize(opts.ratio) | ||
| this._upperBound = Math.floor(this._ratio * 0xffffffff) | ||
| } | ||
|
|
||
| applySamplingDecision({ transaction }) { | ||
| if (!transaction) return | ||
| // eslint-disable-next-line sonarjs/pseudo-random | ||
| const initPriority = Math.random() | ||
|
Member
There was a problem hiding this comment. This is the sample logic as the adaptive, it's just that it calls its
Contributor
Author
There was a problem hiding this comment. I agree, that was my first thought too. However the parameters passed into |
||
| transaction.sampled = this.shouldSample(transaction.traceId) | ||
| transaction.priority = transaction.sampled ? initPriority + 1 : initPriority | ||
| // Truncate the priority after potentially modifying it to avoid floating | ||
| // point errors. | ||
| transaction.priority = ((transaction.priority * 1e6) | 0) / 1e6 | ||
| } | ||
|
|
||
| /** | ||
| * | ||
| * @param {string} traceId transaction trace id | ||
| * @returns {boolean} whether to sample a transaction based on given trace id | ||
| */ | ||
| shouldSample(traceId) { | ||
| const accumulated = this._accumulate(traceId) | ||
| return accumulated <= this._upperBound | ||
| } | ||
|
|
||
| toString() { | ||
| return 'TraceIdRatioBasedSampler' | ||
| } | ||
|
|
||
| /** | ||
| * Normalizes the sampling ratio. | ||
| * @param {number} ratio The ratio provided by the config. | ||
| * @returns {number} The normalized ratio [0, 1]. | ||
| */ | ||
| _normalize(ratio) { | ||
| if (typeof ratio !== 'number' || isNaN(ratio)) { | ||
| return 0 | ||
| } | ||
| if (ratio >= 1) return 1 | ||
|
|
||
| return ratio <= 0 ? 0 : ratio | ||
| } | ||
|
|
||
| /** | ||
| * Accumulates a value from the trace ID. | ||
| * @param {string} traceId The trace ID to accumulate. | ||
| * @returns {number} The accumulated value. | ||
| */ | ||
| _accumulate(traceId) { | ||
| let accumulation = 0 | ||
| for (let i = 0; i < traceId.length / 8; i++) { | ||
| const pos = i * 8 | ||
| const part = parseInt(traceId.slice(pos, pos + 8), 16) | ||
| accumulation = (accumulation ^ part) >>> 0 | ||
| } | ||
| return accumulation | ||
| } | ||
| } | ||
|
|
||
| module.exports = TraceIdRatioBasedSampler | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.