@devopsplaybook.io/otel-utils/dist/src/StandardTracer.js

Utility to simplify integration with Open Telemetry

"use strict";
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
    if (k2 === undefined) k2 = k;
    var desc = Object.getOwnPropertyDescriptor(m, k);
    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
      desc = { enumerable: true, get: function() { return m[k]; } };
    }
    Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
    if (k2 === undefined) k2 = k;
    o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
    Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
    o["default"] = v;
});
var __importStar = (this && this.__importStar) || (function () {
    var ownKeys = function(o) {
        ownKeys = Object.getOwnPropertyNames || function (o) {
            var ar = [];
            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
            return ar;
        };
        return ownKeys(o);
    };
    return function (mod) {
        if (mod && mod.__esModule) return mod;
        var result = {};
        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
        __setModuleDefault(result, mod);
        return result;
    };
})();
Object.defineProperty(exports, "__esModule", { value: true });
exports.StandardTracer = void 0;
const api_1 = __importStar(require("@opentelemetry/api"));
const context_async_hooks_1 = require("@opentelemetry/context-async-hooks");
const core_1 = require("@opentelemetry/core");
const exporter_trace_otlp_http_1 = require("@opentelemetry/exporter-trace-otlp-http");
const id_generator_aws_xray_1 = require("@opentelemetry/id-generator-aws-xray");
const resources_1 = require("@opentelemetry/resources");
const sdk_trace_base_1 = require("@opentelemetry/sdk-trace-base");
const sdk_trace_node_1 = require("@opentelemetry/sdk-trace-node");
const semantic_conventions_1 = require("@opentelemetry/semantic-conventions");
const os = __importStar(require("os"));
class StandardTracer {
    constructor(config) {
        this.serviceName = config.SERVICE_ID;
        this.serviceVersion = config.VERSION;
        const spanProcessors = [];
        if (config.OPENTELEMETRY_COLLECTOR_HTTP_TRACES) {
            const exporterHeaders = {};
            if (config.OPENTELEMETRY_COLLECT_AUTHORIZATION_HEADER) {
                exporterHeaders["Authorization"] = `Bearer ${config.OPENTELEMETRY_COLLECT_AUTHORIZATION_HEADER}`;
            }
            const exporter = new exporter_trace_otlp_http_1.OTLPTraceExporter({
                url: config.OPENTELEMETRY_COLLECTOR_HTTP_TRACES,
                headers: exporterHeaders,
            });
            spanProcessors.push(new sdk_trace_base_1.BatchSpanProcessor(exporter));
        }
        const traceProvider = new sdk_trace_node_1.NodeTracerProvider({
            idGenerator: new id_generator_aws_xray_1.AWSXRayIdGenerator(),
            resource: (0, resources_1.resourceFromAttributes)({
                [semantic_conventions_1.ATTR_SERVICE_NAME]: `${this.serviceName}`,
                [semantic_conventions_1.ATTR_SERVICE_VERSION]: `${this.serviceVersion}`,
                [semantic_conventions_1.ATTR_NETWORK_LOCAL_ADDRESS]: os.hostname(),
            }),
            spanProcessors,
        });
        traceProvider.register();
        const contextManager = new context_async_hooks_1.AsyncHooksContextManager();
        contextManager.enable();
        api_1.default.context.setGlobalContextManager(contextManager);
        this.tracer = api_1.default.trace.getTracer(`${this.serviceName}:${this.serviceVersion}`);
    }
    startSpan(name, parentSpan) {
        const sanitizedName = String(name).replace(/[^a-zA-Z0-9-_/]/g, "_");
        if (parentSpan) {
            return this.tracer.startSpan(sanitizedName, undefined, api_1.default.trace.setSpan(api_1.default.context.active(), parentSpan));
        }
        const span = this.tracer.startSpan(sanitizedName);
        span.setAttribute(semantic_conventions_1.ATTR_HTTP_REQUEST_METHOD, `BACKEND`);
        span.setAttribute(semantic_conventions_1.ATTR_HTTP_ROUTE, `${this.serviceName}-${this.serviceVersion}-${sanitizedName}`);
        return span;
    }
    // eslint-disable-next-line @typescript-eslint/no-explicit-any
    static updateHttpHeader(context, headers = {}) {
        if (!headers) {
            headers = {};
        }
        const propagator = new core_1.W3CTraceContextPropagator();
        propagator.inject(api_1.trace.setSpanContext(api_1.ROOT_CONTEXT, context.spanContext()), 
        // eslint-disable-next-line @typescript-eslint/no-explicit-any
        headers, api_1.defaultTextMapSetter);
        return headers;
    }
}
exports.StandardTracer = StandardTracer;