solarwinds-apm
Version:
OpenTelemetry-based SolarWinds APM library
211 lines (208 loc) • 7.7 kB
JavaScript
/*
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 { DiagLogLevel } from "@opentelemetry/api";
import { getStringFromEnv } from "@opentelemetry/core";
import * as v from "valibot";
export const schemas = {
boolean: v.union([
v.boolean(),
v.pipe(v.picklist(["true", "false", "1", "0"]), v.transform((b) => b === "true" || b === "1")),
]),
logLevel: v.pipe(v.picklist(["all", "verbose", "debug", "info", "warn", "error", "none"]), v.transform((ll) => {
switch (ll) {
case "all": {
return DiagLogLevel.ALL;
}
case "verbose": {
return DiagLogLevel.VERBOSE;
}
case "debug": {
return DiagLogLevel.DEBUG;
}
case "info": {
return DiagLogLevel.INFO;
}
case "warn": {
return DiagLogLevel.WARN;
}
case "error": {
return DiagLogLevel.ERROR;
}
case "none": {
return DiagLogLevel.NONE;
}
}
})),
regex: v.union([
v.instance(RegExp),
v.pipe(v.string(), v.rawTransform(({ dataset: { value }, addIssue, NEVER }) => {
try {
return new RegExp(value);
}
catch {
addIssue({ label: RegExp.name });
return NEVER;
}
})),
]),
serviceKey: v.pipe(v.string(), v.regex(/:.+$/), v.transform((sk) => {
const [token, ...name] = sk.split(":");
return {
// eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing
token: token || undefined,
name: name.join(":"),
};
})),
tracingMode: v.pipe(v.picklist(["enabled", "disabled"]), v.transform((tm) => tm === "enabled")),
url: v.union([
v.instance(URL),
v.pipe(v.string(), v.rawTransform(({ dataset: { value }, addIssue, NEVER }) => {
if (!/^https?:/.test(value)) {
value = `https://${value}`;
}
try {
return new URL(value);
}
catch {
addIssue({ label: URL.name });
return NEVER;
}
})),
]),
};
export const schema = (defaults) => v.pipe(v.object({
enabled: v.optional(schemas.boolean, true),
serviceKey: defaults.serviceKey
? v.optional(schemas.serviceKey, defaults.serviceKey)
: schemas.serviceKey,
collector: v.optional(schemas.url, "apm.collector.na-01.cloud.solarwinds.com"),
logLevel: v.optional(schemas.logLevel, "warn"),
tracingMode: v.optional(schemas.tracingMode),
triggerTraceEnabled: v.optional(schemas.boolean, defaults.triggerTraceEnabled),
exportLogsEnabled: v.optional(schemas.boolean, false),
transactionName: v.optional(v.union([
v.pipe(v.string(), v.transform((name) => () => name)),
v.pipe(v.custom((name) => typeof name === "function"), v.transform((f) => (span) => {
const name = f(span);
if (name != null) {
/* eslint-disable-next-line @typescript-eslint/no-base-to-string --
* we want whatever the user function returns to be converted to a string */
return String(name);
}
else {
return undefined;
}
})),
v.pipe(v.array(v.object({
scheme: v.literal("spanAttribute"),
delimiter: v.string(),
attributes: v.pipe(v.array(v.string()), v.minLength(1)),
})), v.transform((schemas) => (span) => {
for (const { attributes, delimiter } of schemas) {
const components = [];
for (const a of attributes) {
const component = span.attributes[a];
if (component != null) {
components.push(String(component));
}
}
if (components.length === attributes.length) {
return components.join(delimiter);
}
}
return undefined;
})),
])),
transactionSettings: v.optional(v.array(v.union([
v.pipe(v.object({ tracing: schemas.tracingMode, regex: schemas.regex }), v.transform(({ tracing, regex }) => ({
tracing,
matcher: (ident) => regex.test(ident),
}))),
v.pipe(v.object({
tracing: schemas.tracingMode,
matcher: v.custom((matcher) => typeof matcher === "function"),
}), v.transform(({ tracing, matcher }) => ({
tracing,
matcher: (ident) => Boolean(matcher(ident)),
}))),
]))),
}), v.transform((raw) => {
const service = getStringFromEnv("OTEL_SERVICE_NAME") ?? raw.serviceKey.name;
const token = raw.serviceKey.token;
const collector = raw.collector;
const headers = {};
const otlp = Object.fromEntries(["traces", "metrics", "logs"].map((signal) => [
signal,
signalEndpoint(signal, collector),
]));
return {
enabled: raw.enabled,
service,
token,
collector,
headers,
otlp,
logLevel: raw.logLevel,
tracingMode: raw.tracingMode,
triggerTraceEnabled: raw.triggerTraceEnabled,
exportLogsEnabled: raw.exportLogsEnabled,
transactionName: raw.transactionName,
transactionSettings: raw.transactionSettings,
};
}));
export const env = {
PREFIX: "SW_APM_",
/**
* Returns a config object from an environment object by filtering the keys
* by prefix then stripping it and renaming them to camelCase
*/
object(object, prefix) {
prefix ??= env.PREFIX;
return Object.fromEntries(Object.entries(object)
.filter(([k]) => k.startsWith(prefix))
.map(([k, v]) => [env.fromKey(k, prefix), v]));
},
/** Converts an environment variable name to a config key */
fromKey(k, prefix) {
prefix ??= env.PREFIX;
return k
.slice(prefix.length)
.toLowerCase()
.replace(/_[a-z]/g, (c) => c.slice(1).toUpperCase());
},
/** Converts a config key to an environment variable name */
toKey(k, prefix) {
prefix ??= env.PREFIX;
return `${prefix}${k.replace(/[A-Z]/g, (c) => `_${c}`).toUpperCase()}`;
},
};
/**
* Computes the collector endpoint for the given signal
* based on the config and environment
*/
function signalEndpoint(signal, collector) {
const path = `/v1/${signal}`;
const specific = getStringFromEnv(`OTEL_EXPORTER_OTLP_${signal.toUpperCase()}_ENDPOINT`);
if (specific) {
return specific;
}
const generic = getStringFromEnv("OTEL_EXPORTER_OTLP_ENDPOINT");
if (generic) {
return `${generic}${path}`;
}
const endpoint = new URL(collector);
endpoint.hostname = collector.hostname.replace(/^apm\.collector\./, "otel.collector.");
endpoint.pathname = path;
return endpoint.href;
}
//# sourceMappingURL=config.js.map