solarwinds-apm/dist/init.js

OpenTelemetry-based SolarWinds APM library

/*
Copyright 2023-2026 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 { diag, metrics, } from "@opentelemetry/api";
import { CompositePropagator, W3CBaggagePropagator } from "@opentelemetry/core";
import { registerInstrumentations } from "@opentelemetry/instrumentation";
import { defaultResource, detectResources, resourceFromAttributes, } from "@opentelemetry/resources";
import { MeterProvider } from "@opentelemetry/sdk-metrics";
import { BatchSpanProcessor, } from "@opentelemetry/sdk-trace-base";
import { NodeTracerProvider } from "@opentelemetry/sdk-trace-node";
import { ATTR_SERVICE_NAME } from "@opentelemetry/semantic-conventions";
import { getInstrumentations, getResourceDetectors, } from "@solarwinds-apm/instrumentations";
import log from "./commonjs/log.js";
import { printError, read } from "./config.js";
import { environment } from "./env.js";
import { MetricReader } from "./exporters/metrics.js";
import { Logger } from "./logger.js";
import { patch, patchEnv } from "./patches.js";
import { ParentSpanProcessor } from "./processing/parent-span.js";
import { ResponseTimeProcessor } from "./processing/response-time.js";
import { StacktraceProcessor } from "./processing/stacktrace.js";
import { TransactionNameProcessor } from "./processing/transaction-name.js";
import { RequestHeadersPropagator, ResponseHeadersPropagator, } from "./propagation/headers.js";
import { TraceContextPropagator } from "./propagation/trace-context.js";
import { LOGGER_PROVIDER, METER_PROVIDER, SAMPLER, TRACER_PROVIDER, } from "./shared/init.js";
import { componentLogger } from "./shared/logger.js";
import { VERSION } from "./version.js";
export async function init() {
    let config;
    try {
        config = await read();
    }
    catch (err) {
        log("Invalid SolarWinds APM configuration, application will not be instrumented.");
        printError(err);
        return false;
    }
    diag.setLogger(new Logger(config), config.logLevel);
    const logger = componentLogger(init);
    logger.debug("working directory", process.cwd());
    logger.debug("config", config);
    if (!config.enabled) {
        logger.warn("Library disabled, application will not be instrumented.");
        return false;
    }
    patchEnv(config);
    const registerInstrumentations = await initInstrumentations(config, logger);
    const detectors = await getResourceDetectors(config.resourceDetectors.configs, config.resourceDetectors.set);
    const resource = detectResources({
        detectors: [...detectors, ...config.resourceDetectors.extra],
    })
        .merge(defaultResource())
        .merge(resourceFromAttributes({
        [ATTR_SERVICE_NAME]: config.service,
        "sw.data.module": "apm",
        "sw.apm.version": VERSION,
    }));
    if (resource.asyncAttributesPending) {
        await resource.waitForAsyncAttributes?.();
    }
    const meterProvider = await initMetrics(config, resource, logger);
    const [tracerProvider] = await Promise.all([
        initTracing(config, resource, logger),
        initLogs(config, resource, logger),
    ]);
    registerInstrumentations(tracerProvider, meterProvider);
    logger.debug("resource", resource.attributes);
    return true;
}
async function initInstrumentations(config, logger) {
    logger.debug("initialising instrumentations");
    const provided = await getInstrumentations(patch(config.instrumentations.configs, {
        ...config,
        responsePropagator: new ResponseHeadersPropagator(),
    }, logger), config.instrumentations.set);
    const extra = config.instrumentations.extra;
    return (tracerProvider, meterProvider) => {
        registerInstrumentations({
            instrumentations: [...provided, ...extra],
            tracerProvider,
            meterProvider,
        });
        logger.debug("initialised instrumentations");
    };
}
async function initTracing(config, resource, logger) {
    logger.debug("initialising tracing");
    let sampler;
    let processors;
    const propagator = new CompositePropagator({
        propagators: [
            new RequestHeadersPropagator(),
            new TraceContextPropagator(),
            new W3CBaggagePropagator(),
        ],
    });
    if (environment.IS_AWS_LAMBDA) {
        const [{ JsonSampler }, { TraceExporter }] = await Promise.all([
            import("./sampling/json.js"),
            import("./exporters/traces.js"),
        ]);
        sampler = new JsonSampler(config, "/tmp/solarwinds-apm-settings.json");
        processors = [
            new TransactionNameProcessor(config),
            new ResponseTimeProcessor(),
            new BatchSpanProcessor(new TraceExporter(config)),
            new ParentSpanProcessor(),
            new StacktraceProcessor(config),
        ];
    }
    else {
        const [{ HttpSampler }, { TraceExporter }] = await Promise.all([
            import("./sampling/http.js"),
            import("./exporters/traces.js"),
        ]);
        sampler = new HttpSampler(config);
        processors = [
            new TransactionNameProcessor(config),
            new ResponseTimeProcessor(),
            new BatchSpanProcessor(new TraceExporter(config)),
            new ParentSpanProcessor(),
            new StacktraceProcessor(config),
        ];
    }
    const provider = new NodeTracerProvider({
        resource,
        sampler,
        spanProcessors: processors,
    });
    provider.register({ propagator });
    SAMPLER.resolve(sampler);
    TRACER_PROVIDER.resolve(provider);
    logger.debug("initialised tracing");
    return provider;
}
async function initMetrics(config, resource, logger) {
    logger.debug("initialiing metrics");
    const { MetricExporter } = await import("./exporters/metrics.js");
    const readers = [
        new MetricReader({
            exporter: new MetricExporter(config),
        }),
    ];
    const provider = new MeterProvider({
        resource,
        readers,
    });
    metrics.setGlobalMeterProvider(provider);
    if (config.runtimeMetrics) {
        logger.debug("initialising runtime metrics");
        const { enable } = await import("./metrics.js");
        enable();
    }
    METER_PROVIDER.resolve(provider);
    logger.debug("initialised metrics");
    return provider;
}
async function initLogs(config, resource, logger) {
    if (!config.exportLogsEnabled) {
        LOGGER_PROVIDER.resolve(undefined);
        return;
    }
    logger.debug("initialising logs");
    const [{ logs }, { BatchLogRecordProcessor, LoggerProvider }, { LogExporter },] = await Promise.all([
        import("@opentelemetry/api-logs"),
        import("@opentelemetry/sdk-logs"),
        import("./exporters/logs.js"),
    ]);
    const provider = new LoggerProvider({
        resource,
        processors: [new BatchLogRecordProcessor(new LogExporter(config))],
    });
    logs.setGlobalLoggerProvider(provider);
    LOGGER_PROVIDER.resolve(provider);
    logger.debug("logs initialised");
    return provider;
}
//# sourceMappingURL=init.js.map