solarwinds-apm/dist/appoptics/sampler.js

OpenTelemetry-based SolarWinds APM library

/*
Copyright 2023-2025 SolarWinds Worldwide, LLC.

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.
*/
import { trace, TraceFlags, } from "@opentelemetry/api";
import { SamplingDecision, } from "@opentelemetry/sdk-trace-base";
import { oboe } from "@solarwinds-apm/bindings";
import { BUCKET_CAPACITY_ATTRIBUTE, BUCKET_RATE_ATTRIBUTE, parseTraceOptions, SAMPLE_RATE_ATTRIBUTE, SAMPLE_SOURCE_ATTRIBUTE, SpanType, spanType, stringifyTraceOptionsResponse, SW_KEYS_ATTRIBUTE, TracingMode, TRIGGERED_TRACE_ATTRIBUTE, } from "@solarwinds-apm/sampling";
import { HEADERS_STORAGE, traceParent } from "../propagation/headers.js";
import { Sampler } from "../sampling/sampler.js";
import { componentLogger } from "../shared/logger.js";
export class AppopticsSampler extends Sampler {
    constructor(config) {
        super(config, componentLogger(AppopticsSampler));
    }
    shouldSample(...params) {
        const [context, , , , attributes] = params;
        const parentSpan = trace.getSpan(context);
        const parentSpanContext = parentSpan?.spanContext();
        const type = spanType(parentSpan);
        this.logger.debug(`span type is ${SpanType[type]}`);
        // for local spans we always trust the parent
        if (type === SpanType.LOCAL) {
            if (parentSpanContext.traceFlags & TraceFlags.SAMPLED) {
                return { decision: SamplingDecision.RECORD_AND_SAMPLED };
            }
            else {
                return { decision: SamplingDecision.NOT_RECORD };
            }
        }
        const customSettings = this.localSettings(...params);
        const headers = HEADERS_STORAGE.get(context)?.request ?? {};
        const traceOptions = headers["X-Trace-Options"]
            ? parseTraceOptions(headers["X-Trace-Options"], this.logger)
            : undefined;
        const options = intoOboeDecisionOptions(parentSpanContext, type, customSettings, headers, traceOptions);
        this.logger.debug("oboe sampling decisions options", options);
        const result = oboe.Context.getDecisions(options);
        this.logger.debug("oboe sampling decisions result", result);
        const { samplingResult, traceOptionsResponse } = fromOboeDecisionsResult(result, traceOptions);
        this.setResponseHeaders({
            ["X-Trace-Options-Response"]: stringifyTraceOptionsResponse(traceOptionsResponse),
        }, context);
        return {
            ...samplingResult,
            attributes: { ...attributes, ...samplingResult.attributes },
        };
    }
    toString() {
        return "AppOptics Sampler";
    }
    waitUntilReady(timeout) {
        return Promise.resolve(oboe.Context.isReady(timeout) === oboe.SERVER_RESPONSE_OK);
    }
}
export function intoOboeDecisionOptions(parentSpanContext, type, customSettings, headers, traceOptions) {
    const in_xtrace = type === SpanType.ENTRY ? traceParent(parentSpanContext) : null;
    const tracestate = parentSpanContext?.traceState?.get("sw");
    const custom_tracing_mode = customSettings.tracingMode === TracingMode.ALWAYS
        ? oboe.TRACE_ENABLED
        : customSettings.tracingMode === TracingMode.NEVER
            ? oboe.TRACE_DISABLED
            : customSettings.tracingMode;
    const custom_trigger_mode = customSettings.triggerMode
        ? oboe.TRIGGER_ENABLED
        : oboe.TRIGGER_DISABLED;
    const request_type = traceOptions?.triggerTrace
        ? oboe.REQUEST_TYPE_TRIGGER
        : oboe.REQUEST_TYPE_REGULAR;
    const header_options = headers["X-Trace-Options"];
    const header_signature = headers["X-Trace-Options-Signature"];
    const header_timestamp = traceOptions?.timestamp;
    return {
        in_xtrace,
        tracestate,
        custom_tracing_mode,
        custom_trigger_mode,
        request_type,
        header_options,
        header_signature,
        header_timestamp,
    };
}
export function fromOboeDecisionsResult(result, traceOptions) {
    const decision = result.do_sample
        ? SamplingDecision.RECORD_AND_SAMPLED
        : result.do_metrics
            ? SamplingDecision.RECORD
            : SamplingDecision.NOT_RECORD;
    const attributes = { ...traceOptions?.custom };
    if (result.do_sample) {
        attributes[BUCKET_CAPACITY_ATTRIBUTE] = result.bucket_cap;
        attributes[BUCKET_RATE_ATTRIBUTE] = result.bucket_rate;
        if (traceOptions?.triggerTrace) {
            attributes[TRIGGERED_TRACE_ATTRIBUTE] = true;
        }
        else {
            attributes[SAMPLE_RATE_ATTRIBUTE] = result.sample_rate;
            attributes[SAMPLE_SOURCE_ATTRIBUTE] = result.sample_source;
        }
    }
    if (traceOptions?.swKeys) {
        attributes[SW_KEYS_ATTRIBUTE] = traceOptions.swKeys;
    }
    const traceOptionsResponse = {
        triggerTrace: traceOptions?.triggerTrace
            ? result.status_msg
            : undefined,
        auth: result.auth_msg ? result.auth_msg : undefined,
        ignored: traceOptions?.ignored.map(([k]) => k),
    };
    return {
        samplingResult: {
            decision,
            attributes,
        },
        traceOptionsResponse,
    };
}
//# sourceMappingURL=sampler.js.map