@intentius/chant-lexicon-otel 0.124.46 → 0.124.49

package/dist/lint/post-synth/otel128.js

@@ -0,0 +1,17 @@
+/**
+ * OTEL128: The collector config uses a component the declared Distribution does not build
+ *
+ * When a project declares a `Distribution` (an ocb builder manifest), every component a collector config declares must be one the distribution builds; a collector built from it fails at start with "unknown type" otherwise. A project without a `Distribution` is not checked.
+ */
+import { distributionIssues, isDistributionEntity } from "../../distribution.js";
+import { collectorConfigs, toDiagnostic } from "./otel-helpers.js";
+export const otel128 = {
+    id: "OTEL128",
+    description: "The collector config uses a component the declared Distribution does not build",
+    check(ctx) {
+        const dist = [...(ctx.entities?.values() ?? [])].find(isDistributionEntity);
+        if (!dist)
+            return [];
+        return collectorConfigs(ctx).flatMap(({ config, ...found }) => distributionIssues(config, dist).map((i) => toDiagnostic(i, found)));
+    },
+};

package/dist/lint/post-synth/otel129.d.ts

@@ -0,0 +1,15 @@
+/**
+ * OTEL129: A clickhouse exporter writes a table the sql build in the same root does not declare
+ *
+ * When the build root also declares ClickHouse tables with the sql lexicon, every table a `clickhouse` exporter writes (for the signals whose pipelines use it) must be one of them, in the database the exporter writes to, with every column the exporter's insert statement names. A renamed or dropped table fails here instead of at the exporter's first insert. When `create_schema` is true (the exporter's default) for tables the build declares, it warns: the exporter would run its own `CREATE TABLE IF NOT EXISTS` beside the sql lexicon's plan. A build root with no sql ClickHouse tables is not checked. Sees one build root at a time (#1939); across workspace members the otel lexicon's workspace links check the same tables (#3931).
+ */
+import type { PostSynthCheck } from "@intentius/chant/lint/post-synth";
+import type { Declarable } from "@intentius/chant/declarable";
+interface DeclaredTable {
+    columns: Set<string>;
+}
+/** Every ClickHouse table the build declares, by `database.name`. */
+export declare function declaredClickHouseTables(entities: Iterable<Declarable>): Map<string, DeclaredTable>;
+export declare const otel129: PostSynthCheck;
+export {};
+//# sourceMappingURL=otel129.d.ts.map

package/dist/lint/post-synth/otel129.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"otel129.d.ts","sourceRoot":"","sources":["../../../src/lint/post-synth/otel129.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,cAAc,EAAyC,MAAM,kCAAkC,CAAC;AAC9G,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,6BAA6B,CAAC;AAO9D,UAAU,aAAa;IACrB,OAAO,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;CACtB;AAED,qEAAqE;AACrE,wBAAgB,wBAAwB,CAAC,QAAQ,EAAE,QAAQ,CAAC,UAAU,CAAC,GAAG,GAAG,CAAC,MAAM,EAAE,aAAa,CAAC,CAenG;AASD,eAAO,MAAM,OAAO,EAAE,cAuDrB,CAAC"}

package/dist/lint/post-synth/otel129.js

@@ -0,0 +1,92 @@
+/**
+ * OTEL129: A clickhouse exporter writes a table the sql build in the same root does not declare
+ *
+ * When the build root also declares ClickHouse tables with the sql lexicon, every table a `clickhouse` exporter writes (for the signals whose pipelines use it) must be one of them, in the database the exporter writes to, with every column the exporter's insert statement names. A renamed or dropped table fails here instead of at the exporter's first insert. When `create_schema` is true (the exporter's default) for tables the build declares, it warns: the exporter would run its own `CREATE TABLE IF NOT EXISTS` beside the sql lexicon's plan. A build root with no sql ClickHouse tables is not checked. Sees one build root at a time (#1939); across workspace members the otel lexicon's workspace links check the same tables (#3931).
+ */
+import { clickhouseExportersOf } from "../../clickhouse-tables.js";
+import { collectorConfigs } from "./otel-helpers.js";
+/** The sql lexicon's ClickHouse table entity type, matched by name so otel needs no dependency on the sql lexicon. */
+const CLICKHOUSE_TABLE = "ClickHouse::Table";
+/** Every ClickHouse table the build declares, by `database.name`. */
+export function declaredClickHouseTables(entities) {
+    const out = new Map();
+    for (const e of entities) {
+        if (e.entityType !== CLICKHOUSE_TABLE)
+            continue;
+        const props = e.props;
+        if (typeof props?.name !== "string")
+            continue;
+        const database = typeof props.database === "string" && props.database !== "" ? props.database : "default";
+        const columns = new Set();
+        for (const c of Array.isArray(props.columns) ? props.columns : []) {
+            const name = c?.name;
+            if (typeof name === "string")
+                columns.add(name);
+        }
+        out.set(`${database}.${props.name}`, { columns });
+    }
+    return out;
+}
+/** A column the insert names is declared as itself, or as the flattened fields of a Nested column (`Events.Timestamp`). */
+function hasColumn(declared, column) {
+    if (declared.has(column))
+        return true;
+    for (const c of declared)
+        if (c.startsWith(`${column}.`))
+            return true;
+    return false;
+}
+export const otel129 = {
+    id: "OTEL129",
+    description: "A clickhouse exporter writes a table the sql build in the same root does not declare",
+    check(ctx) {
+        const declared = declaredClickHouseTables(ctx.entities?.values() ?? []);
+        if (declared.size === 0)
+            return [];
+        const known = [...declared.keys()].sort();
+        const diagnostics = [];
+        for (const { config } of collectorConfigs(ctx)) {
+            for (const exp of clickhouseExportersOf(config)) {
+                const createsDeclared = [];
+                for (const t of exp.tables) {
+                    const qualified = `${exp.database}.${t.name}`;
+                    const table = declared.get(qualified);
+                    if (!table) {
+                        diagnostics.push({
+                            checkId: "OTEL129",
+                            severity: "error",
+                            message: `exporter ${exp.id} writes ${t.signal} to ${qualified} (${t.key}), which the sql build does not declare. ` +
+                                `Declare it (OtelTables from @intentius/chant-lexicon-sql/clickhouse declares the exporter's tables) or point ${t.key} at a declared table. ` +
+                                `Declared ClickHouse tables: ${known.join(", ")}`,
+                            entity: exp.id,
+                            lexicon: "otel",
+                        });
+                        continue;
+                    }
+                    const missing = t.columns.filter((c) => !hasColumn(table.columns, c));
+                    if (missing.length > 0) {
+                        diagnostics.push({
+                            checkId: "OTEL129",
+                            severity: "error",
+                            message: `exporter ${exp.id} inserts ${t.signal} into ${qualified} with column${missing.length === 1 ? "" : "s"} ${missing.join(", ")}, which the declared table does not have; the insert would fail`,
+                            entity: exp.id,
+                            lexicon: "otel",
+                        });
+                    }
+                    createsDeclared.push(qualified);
+                }
+                if (exp.createSchema && createsDeclared.length > 0) {
+                    diagnostics.push({
+                        checkId: "OTEL129",
+                        severity: "warning",
+                        message: `exporter ${exp.id} has create_schema true (the default), so at start it runs CREATE TABLE IF NOT EXISTS for ${createsDeclared.join(", ")}, which the sql build declares. ` +
+                            `Set create_schema: false so the sql lexicon alone manages them`,
+                        entity: exp.id,
+                        lexicon: "otel",
+                    });
+                }
+            }
+        }
+        return diagnostics;
+    },
+};

package/dist/lsp/completions.d.ts

@@ -1,4 +1,13 @@
 import type { CompletionContext, CompletionItem } from "@intentius/chant/lsp/types";
-/** Completions for the otel entity classes: the built-in components, Pipeline and Service. */
+/** The text of `content` before the cursor. */
+export declare function textBefore(content: string, position: {
+    line: number;
+    character: number;
+}): string;
+/**
+ * Completions for the otel entity classes after `new`, and inside a built-in's
+ * constructor, the config properties at the cursor's depth, with upstream's
+ * descriptions (#3361).
+ */
 export declare function completions(ctx: CompletionContext): CompletionItem[];
 //# sourceMappingURL=completions.d.ts.map

package/dist/lsp/completions.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"completions.d.ts","sourceRoot":"","sources":["../../src/lsp/completions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAWpF,8FAA8F;AAC9F,wBAAgB,WAAW,CAAC,GAAG,EAAE,iBAAiB,GAAG,cAAc,EAAE,CAEpE"}
+{"version":3,"file":"completions.d.ts","sourceRoot":"","sources":["../../src/lsp/completions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAYpF,+CAA+C;AAC/C,wBAAgB,UAAU,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,MAAM,CAAA;CAAE,GAAG,MAAM,CAGjG;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,GAAG,EAAE,iBAAiB,GAAG,cAAc,EAAE,CAoBpE"}

package/dist/lsp/completions.js

@@ -1,11 +1,39 @@
 import { LexiconIndex, lexiconCompletions } from "@intentius/chant/lsp/lexicon-providers";
 import { lexiconRegistry } from "../catalog.js";
+import { propertiesAt, propertyMarkdown, propertyPosition } from "./properties.js";
 let cachedIndex = null;
 function getIndex() {
     cachedIndex ?? (cachedIndex = new LexiconIndex(lexiconRegistry()));
     return cachedIndex;
 }
-/** Completions for the otel entity classes: the built-in components, Pipeline and Service. */
+/** The text of `content` before the cursor. */
+export function textBefore(content, position) {
+    const lines = content.split("\n");
+    return [...lines.slice(0, position.line), (lines[position.line] ?? "").slice(0, position.character)].join("\n");
+}
+/**
+ * Completions for the otel entity classes after `new`, and inside a built-in's
+ * constructor, the config properties at the cursor's depth, with upstream's
+ * descriptions (#3361).
+ */
 export function completions(ctx) {
+    if (ctx?.content && ctx.position && !/\bnew\s+\w*$/.test(ctx.linePrefix ?? "")) {
+        const position = propertyPosition(textBefore(ctx.content, ctx.position));
+        const props = position && propertiesAt(position);
+        if (position && props) {
+            const prefix = (ctx.wordAtCursor ?? "").toLowerCase();
+            return Object.entries(props)
+                .filter(([name]) => name.toLowerCase().startsWith(prefix))
+                .sort(([a], [b]) => a.localeCompare(b))
+                .map(([name, doc]) => ({
+                label: name,
+                insertText: name,
+                kind: "property",
+                detail: doc.type,
+                documentation: propertyMarkdown(name, doc, position.className),
+                ...(doc.deprecated ? { deprecated: true } : {}),
+            }));
+        }
+    }
     return lexiconCompletions(ctx, getIndex(), "OpenTelemetry Collector entity");
 }

package/dist/lsp/hover.d.ts

@@ -1,4 +1,8 @@
 import type { HoverContext, HoverInfo } from "@intentius/chant/lsp/types";
-/** Hover for otel entity classes: what the component does and its collector id. */
+/**
+ * Hover for otel entity classes (what the component does and its collector
+ * id), and for a config property inside a built-in's constructor (upstream's
+ * description, #3361).
+ */
 export declare function hover(ctx: HoverContext): HoverInfo | undefined;
 //# sourceMappingURL=hover.d.ts.map

package/dist/lsp/hover.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"hover.d.ts","sourceRoot":"","sources":["../../src/lsp/hover.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAC;AAY1E,mFAAmF;AACnF,wBAAgB,KAAK,CAAC,GAAG,EAAE,YAAY,GAAG,SAAS,GAAG,SAAS,CAE9D"}
+{"version":3,"file":"hover.d.ts","sourceRoot":"","sources":["../../src/lsp/hover.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAC;AAc1E;;;;GAIG;AACH,wBAAgB,KAAK,CAAC,GAAG,EAAE,YAAY,GAAG,SAAS,GAAG,SAAS,CAO9D"}

package/dist/lsp/hover.js

@@ -1,14 +1,27 @@
 import { LexiconIndex, lexiconHover } from "@intentius/chant/lsp/lexicon-providers";
 import { BUILTIN_CATALOG, lexiconRegistry } from "../catalog.js";
 import { COLLECTOR_PIN } from "../define.js";
+import { propertiesAt, propertyMarkdown, propertyPosition } from "./properties.js";
+import { textBefore } from "./completions.js";
 let cachedIndex = null;
 function getIndex() {
     cachedIndex ?? (cachedIndex = new LexiconIndex(lexiconRegistry()));
     return cachedIndex;
 }
-/** Hover for otel entity classes: what the component does and its collector id. */
+/**
+ * Hover for otel entity classes (what the component does and its collector
+ * id), and for a config property inside a built-in's constructor (upstream's
+ * description, #3361).
+ */
 export function hover(ctx) {
-    return lexiconHover(ctx, getIndex(), resourceHover);
+    const entity = lexiconHover(ctx, getIndex(), resourceHover);
+    if (entity)
+        return entity;
+    if (!ctx?.content || !ctx.position || !ctx.word)
+        return undefined;
+    const position = propertyPosition(textBefore(ctx.content, ctx.position));
+    const doc = position && propertiesAt(position)?.[ctx.word];
+    return position && doc ? { contents: propertyMarkdown(ctx.word, doc, position.className) } : undefined;
 }
 function resourceHover(className, entry) {
     const cat = BUILTIN_CATALOG.find((c) => c.className === className);
@@ -17,7 +30,7 @@ function resourceHover(className, entry) {
         lines.push("", cat.description);
     if (cat?.type) {
         lines.push("", `Collector id \`${cat.type}\`, or \`${cat.type}/<name>\` with \`name\` set. ` +
-            `Config typed against ${COLLECTOR_PIN.source} ${COLLECTOR_PIN.version}.`);
+            `Config typed from upstream config.schema.yaml at ${COLLECTOR_PIN.source} ${COLLECTOR_PIN.version}.`);
     }
     return { contents: lines.join("\n") };
 }

package/dist/lsp/properties.d.ts

@@ -0,0 +1,34 @@
+/**
+ * Property-level completion and hover for the built-in components (#3361),
+ * from the descriptions in upstream's `config.schema.yaml`.
+ *
+ * Generation writes each built-in's property tree to
+ * `src/generated/properties.json`. Inside `new OtlpReceiver({ … })` the
+ * cursor's position is resolved to a path of keys (`protocols.grpc`), and the
+ * properties at that path are offered, with upstream's description and a short
+ * type. A word under the cursor at such a position hovers with the same text.
+ */
+import type { PropertyDoc } from "../spec/parse.js";
+type PropertyTrees = Record<string, Record<string, PropertyDoc>>;
+/** The generated property trees, or an empty set before `generate` has run. */
+export declare function propertyTrees(): PropertyTrees;
+/** Test seam: replace the loaded trees. */
+export declare function setPropertyTrees(trees: PropertyTrees | undefined): void;
+/** Where the cursor is inside a constructor's config object. */
+export interface PropertyPosition {
+    className: string;
+    /** The keys of the objects enclosing the cursor, outermost first. */
+    path: string[];
+}
+/**
+ * Resolve the text before the cursor to the built-in whose constructor
+ * argument holds it and the keys of the objects around it. Undefined when the
+ * cursor is not inside `new X({ … })`.
+ */
+export declare function propertyPosition(before: string): PropertyPosition | undefined;
+/** The properties at a path of a built-in's tree, or undefined when the path leaves it. */
+export declare function propertiesAt(position: PropertyPosition): Record<string, PropertyDoc> | undefined;
+/** Markdown for one property: its type, deprecation and upstream description. */
+export declare function propertyMarkdown(name: string, doc: PropertyDoc, className: string): string;
+export {};
+//# sourceMappingURL=properties.d.ts.map

package/dist/lsp/properties.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"properties.d.ts","sourceRoot":"","sources":["../../src/lsp/properties.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAKH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAEjD,KAAK,aAAa,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC,CAAC;AAIjE,+EAA+E;AAC/E,wBAAgB,aAAa,IAAI,aAAa,CAK7C;AAED,2CAA2C;AAC3C,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,aAAa,GAAG,SAAS,GAAG,IAAI,CAEvE;AAED,gEAAgE;AAChE,MAAM,WAAW,gBAAgB;IAC/B,SAAS,EAAE,MAAM,CAAC;IAClB,qEAAqE;IACrE,IAAI,EAAE,MAAM,EAAE,CAAC;CAChB;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,gBAAgB,GAAG,SAAS,CAsE7E;AASD,2FAA2F;AAC3F,wBAAgB,YAAY,CAAC,QAAQ,EAAE,gBAAgB,GAAG,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,GAAG,SAAS,CAOhG;AAED,iFAAiF;AACjF,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,GAAG,MAAM,CAK1F"}

package/dist/lsp/properties.js

@@ -0,0 +1,135 @@
+/**
+ * Property-level completion and hover for the built-in components (#3361),
+ * from the descriptions in upstream's `config.schema.yaml`.
+ *
+ * Generation writes each built-in's property tree to
+ * `src/generated/properties.json`. Inside `new OtlpReceiver({ … })` the
+ * cursor's position is resolved to a path of keys (`protocols.grpc`), and the
+ * properties at that path are offered, with upstream's description and a short
+ * type. A word under the cursor at such a position hovers with the same text.
+ */
+import { existsSync, readFileSync } from "fs";
+import { dirname, join } from "path";
+import { moduleSourceDir } from "@intentius/chant/module-source";
+let cached;
+/** The generated property trees, or an empty set before `generate` has run. */
+export function propertyTrees() {
+    if (cached)
+        return cached;
+    const file = join(dirname(moduleSourceDir(import.meta.url)), "generated", "properties.json");
+    cached = existsSync(file) ? JSON.parse(readFileSync(file, "utf-8")) : {};
+    return cached;
+}
+/** Test seam: replace the loaded trees. */
+export function setPropertyTrees(trees) {
+    cached = trees;
+}
+/**
+ * Resolve the text before the cursor to the built-in whose constructor
+ * argument holds it and the keys of the objects around it. Undefined when the
+ * cursor is not inside `new X({ … })`.
+ */
+export function propertyPosition(before) {
+    const re = /\bnew\s+(\w+)\s*\(\s*\{/g;
+    let match;
+    let last;
+    while ((match = re.exec(before)) !== null)
+        last = { className: match[1], start: match.index + match[0].length };
+    if (!last)
+        return undefined;
+    // Walk from the constructor's `{`: each `{` opens the object of the key
+    // written just before it; `[` opens a list whose objects share that key.
+    const stack = [];
+    let pendingKey = null;
+    let i = last.start;
+    const text = before;
+    while (i < text.length) {
+        const ch = text[i];
+        if (ch === '"' || ch === "'" || ch === "`") {
+            const end = skipString(text, i);
+            const literal = text.slice(i + 1, end - 1);
+            // A quoted key: `"k8s.pod.name": …`
+            if (/^\s*:/.test(text.slice(end)))
+                pendingKey = literal;
+            i = end;
+            continue;
+        }
+        if (ch === "/" && text[i + 1] === "/") {
+            const nl = text.indexOf("\n", i);
+            i = nl < 0 ? text.length : nl;
+            continue;
+        }
+        if (ch === "/" && text[i + 1] === "*") {
+            const close = text.indexOf("*/", i + 2);
+            i = close < 0 ? text.length : close + 2;
+            continue;
+        }
+        const ident = /^[A-Za-z_$][\w$]*/.exec(text.slice(i));
+        if (ident) {
+            if (/^\s*:/.test(text.slice(i + ident[0].length)))
+                pendingKey = ident[0];
+            i += ident[0].length;
+            continue;
+        }
+        if (ch === "{" || ch === "[") {
+            // A list keeps its key, so its objects resolve to the list's items.
+            stack.push(ch === "[" ? `[${pendingKey ?? ""}` : pendingKey);
+            pendingKey = null;
+        }
+        else if (ch === "}" || ch === "]") {
+            if (stack.length === 0)
+                return undefined; // the constructor's object closed
+            stack.pop();
+        }
+        else if (ch === "," || ch === "(" || ch === ")") {
+            pendingKey = null;
+        }
+        i++;
+    }
+    const path = [];
+    let inList;
+    for (const entry of stack) {
+        if (entry === null) {
+            if (inList === undefined)
+                return undefined; // an object whose key is unknown
+            inList = undefined; // an item of the list just entered
+            continue;
+        }
+        if (entry.startsWith("[")) {
+            inList = entry.slice(1);
+            if (inList)
+                path.push(inList);
+            continue;
+        }
+        path.push(entry);
+        inList = undefined;
+    }
+    if (inList !== undefined)
+        return undefined; // directly inside a list, not an item
+    return { className: last.className, path };
+}
+function skipString(text, start) {
+    const quote = text[start];
+    let i = start + 1;
+    while (i < text.length && text[i] !== quote)
+        i += text[i] === "\\" ? 2 : 1;
+    return Math.min(i + 1, text.length);
+}
+/** The properties at a path of a built-in's tree, or undefined when the path leaves it. */
+export function propertiesAt(position) {
+    let level = propertyTrees()[position.className];
+    for (const key of position.path) {
+        level = level?.[key]?.properties;
+        if (!level)
+            return undefined;
+    }
+    return level;
+}
+/** Markdown for one property: its type, deprecation and upstream description. */
+export function propertyMarkdown(name, doc, className) {
+    const lines = [`**${name}**: \`${doc.type}\`${doc.deprecated ? " (deprecated)" : ""}`];
+    if (doc.description)
+        lines.push("", doc.description);
+    lines.push("", `\`${className}\` config, from upstream config.schema.yaml.`);
+    return lines.join("\n");
+}

package/dist/manifest.json

@@ -1,6 +1,6 @@
 {
   "name": "otel",
-  "version": "0.124.46",
+  "version": "0.124.49",
   "chantVersion": ">=0.1.0",
   "namespace": "OTel",
   "intrinsics": [],

package/dist/meta.json

@@ -9,6 +9,11 @@
     "kind": "resource",
     "lexicon": "otel"
   },
+  "ClickHouseExporter": {
+    "resourceType": "OTel::Exporter::clickhouse",
+    "kind": "resource",
+    "lexicon": "otel"
+  },
   "CountConnector": {
     "resourceType": "OTel::Connector::count",
     "kind": "resource",

package/dist/metric-names.d.ts

@@ -11,9 +11,16 @@
  * with the exporter's defaults: `.` and any other character Prometheus does
  * not allow become `_`; counters take `_total`; a unit becomes a suffix
  * (`ms` is `_milliseconds`, `s` is `_seconds`); the exporter's `namespace`
- * is a prefix joined with `_`; `add_metric_suffixes: false` drops the
- * suffixes. Attribute names become label names the same way
- * (`service.name` is `service_name`).
+ * is a prefix joined with `_`. The exporter's `translation_strategy` decides
+ * the escaping and the suffixes: the default, `UnderscoreEscapingWithSuffixes`,
+ * is what is described here; `UnderscoreEscapingWithoutSuffixes` drops the
+ * suffixes; `NoUTF8EscapingWithSuffixes` keeps the name's characters;
+ * `NoTranslation` does neither. From collector-contrib v0.154.0 the
+ * `prometheus` exporter ignores the deprecated `add_metric_suffixes`, so a
+ * name read from that exporter follows `translation_strategy` alone; the
+ * `prometheusremotewrite` exporter still honours it when no strategy is set.
+ * Attribute names become label names the same way (`service.name` is
+ * `service_name`).
  *
  * This module holds types and string functions only, so a lexicon that
  * builds queries from it does not load the collector components.
@@ -35,13 +42,34 @@ export declare const SPANMETRICS_DEFAULT_DIMENSIONS: readonly string[];
 export declare const SPANMETRICS_DEFAULT_NAMESPACE = "traces.span.metrics";
 /** The `status.code` value of a span that ended in error: the value an error-ratio query selects. */
 export declare const SPAN_STATUS_ERROR = "STATUS_CODE_ERROR";
+/** The `translation_strategy` values the Prometheus exporters take. */
+export type PrometheusTranslationStrategy = "UnderscoreEscapingWithSuffixes" | "UnderscoreEscapingWithoutSuffixes" | "NoUTF8EscapingWithSuffixes" | "NoTranslation";
 /** How the `prometheus` exporter is configured, as far as naming goes. */
 export interface PrometheusNaming {
     /** The exporter's `namespace`, put in front of every name and joined with `_`. */
     namespace?: string;
-    /** The exporter's `add_metric_suffixes` (default true): unit and `_total` suffixes. */
+    /** The exporter's `translation_strategy`. Default `UnderscoreEscapingWithSuffixes`. */
+    translation_strategy?: PrometheusTranslationStrategy | (string & {});
+    /**
+     * `false` drops the unit and `_total` suffixes when no `translation_strategy`
+     * is set, as the `prometheusremotewrite` exporter reads it. The `prometheus`
+     * exporter ignores it at the pinned release, and {@link exporterNaming}
+     * leaves it out for that exporter.
+     *
+     * @deprecated Upstream deprecates it for `translation_strategy`.
+     */
     add_metric_suffixes?: boolean;
 }
+/**
+ * The naming a declared `prometheus` exporter (or its config) applies: its
+ * `namespace` and `translation_strategy`. `add_metric_suffixes` is left out,
+ * since the exporter ignores it at the pinned release. A plain
+ * `PrometheusNaming` is returned as given.
+ */
+export declare function exporterNaming(exporter: PrometheusNaming | {
+    props?: PrometheusNaming;
+    componentType?: unknown;
+} | undefined): PrometheusNaming;
 /** An attribute name as a Prometheus label: `service.name` is `service_name`. */
 export declare function prometheusLabel(attribute: string): string;
 /**
@@ -55,23 +83,23 @@ export declare function prometheusMetricName(name: string, type: "sum" | "histog
 export interface SpanMetricsNamingConfig {
     namespace?: string;
     dimensions?: Array<{
-        name: string;
+        name?: string;
     }>;
     calls_dimensions?: Array<{
-        name: string;
+        name?: string;
     }>;
     exclude_dimensions?: string[];
     histogram?: {
         disable?: boolean;
         unit?: "ms" | "s";
         dimensions?: Array<{
-            name: string;
+            name?: string;
         }>;
     };
     events?: {
         enabled?: boolean;
         dimensions?: Array<{
-            name: string;
+            name?: string;
         }>;
     };
 }

package/dist/metric-names.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"metric-names.d.ts","sourceRoot":"","sources":["../src/metric-names.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AAIH,oGAAoG;AACpG,MAAM,WAAW,eAAe;IAC9B,4BAA4B;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,gGAAgG;IAChG,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,KAAK,GAAG,WAAW,CAAC;IAC1B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,uGAAuG;IACvG,UAAU,EAAE,MAAM,EAAE,CAAC;CACtB;AAED,mGAAmG;AACnG,eAAO,MAAM,8BAA8B,EAAE,SAAS,MAAM,EAA6E,CAAC;AAE1I,8DAA8D;AAC9D,eAAO,MAAM,6BAA6B,wBAAwB,CAAC;AAEnE,qGAAqG;AACrG,eAAO,MAAM,iBAAiB,sBAAsB,CAAC;AAYrD,0EAA0E;AAC1E,MAAM,WAAW,gBAAgB;IAC/B,kFAAkF;IAClF,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,uFAAuF;IACvF,mBAAmB,CAAC,EAAE,OAAO,CAAC;CAC/B;AAED,iFAAiF;AACjF,wBAAgB,eAAe,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,CAGzD;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,GAAG,WAAW,EAAE,IAAI,CAAC,EAAE,MAAM,EAAE,MAAM,GAAE,gBAAqB,GAAG,MAAM,CAQlI;AAED,oEAAoE;AACpE,MAAM,WAAW,uBAAuB;IACtC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,KAAK,CAAC;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IACrC,gBAAgB,CAAC,EAAE,KAAK,CAAC;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAC3C,kBAAkB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC9B,SAAS,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,OAAO,CAAC;QAAC,IAAI,CAAC,EAAE,IAAI,GAAG,GAAG,CAAC;QAAC,UAAU,CAAC,EAAE,KAAK,CAAC;YAAE,IAAI,EAAE,MAAM,CAAA;SAAE,CAAC,CAAA;KAAE,CAAC;IAC3F,MAAM,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,OAAO,CAAC;QAAC,UAAU,CAAC,EAAE,KAAK,CAAC;YAAE,IAAI,EAAE,MAAM,CAAA;SAAE,CAAC,CAAA;KAAE,CAAC;CACtE;AAED,6FAA6F;AAC7F,MAAM,WAAW,gBAAgB;IAC/B,oDAAoD;IACpD,SAAS,EAAE,MAAM,CAAC;IAClB,0EAA0E;IAC1E,KAAK,EAAE,eAAe,CAAC;IACvB,uEAAuE;IACvE,QAAQ,CAAC,EAAE,eAAe,CAAC;IAC3B,mEAAmE;IACnE,MAAM,CAAC,EAAE,eAAe,CAAC;IACzB;;;OAGG;IACH,MAAM,EAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;QAAC,UAAU,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IACxF,gDAAgD;IAChD,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,KAAK,QAAQ,GAAG;IAAE,aAAa,CAAC,EAAE,OAAO,CAAC;IAAC,KAAK,CAAC,EAAE,OAAO,CAAA;CAAE,CAAC;AAW7D;;;;;;;;;;;GAWG;AACH,wBAAgB,gBAAgB,CAC9B,SAAS,EAAE,uBAAuB,GAAG,QAAQ,EAC7C,QAAQ,CAAC,EAAE,gBAAgB,GAAG;IAAE,KAAK,CAAC,EAAE,gBAAgB,CAAA;CAAE,GACzD,gBAAgB,CAsClB;AAED,uGAAuG;AACvG,eAAO,MAAM,sBAAsB,yBAAyB,CAAC;AAE7D,sEAAsE;AACtE,MAAM,WAAW,wBAAwB;IACvC,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,wBAAwB,CAAC,EAAE,OAAO,CAAC;CACpC;AAED,sDAAsD;AACtD,MAAM,WAAW,iBAAiB;IAChC,yBAAyB;IACzB,QAAQ,EAAE,eAAe,CAAC;IAC1B,gCAAgC;IAChC,MAAM,EAAE,eAAe,CAAC;IACxB,0DAA0D;IAC1D,cAAc,EAAE,eAAe,CAAC;IAChC,0DAA0D;IAC1D,cAAc,EAAE,eAAe,CAAC;CACjC;AAED;;;;;;;GAOG;AACH,wBAAgB,iBAAiB,CAC/B,SAAS,EAAE,wBAAwB,GAAG,QAAQ,EAC9C,QAAQ,CAAC,EAAE,gBAAgB,GAAG;IAAE,KAAK,CAAC,EAAE,gBAAgB,CAAA;CAAE,GACzD,iBAAiB,CA6BnB;AASD,6CAA6C;AAC7C,MAAM,MAAM,WAAW,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,EAAE,GAAG,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;AAEvF,+DAA+D;AAC/D,wBAAgB,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,WAAW,EAAE,GAAG,MAAM,CAG5E;AAED,2EAA2E;AAC3E,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,CAE5E;AAED;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,CAGpG;AAED,yDAAyD;AACzD,wBAAgB,UAAU,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAE5C;AAED,0EAA0E;AAC1E,wBAAgB,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,CAE9F;AAED,qEAAqE;AACrE,MAAM,MAAM,eAAe,GACvB,uBAAuB,GACvB,oBAAoB,GACpB,kBAAkB,GAClB,kBAAkB,GAClB,oBAAoB,GACpB,oBAAoB,CAAC;AAEzB,iEAAiE;AACjE,eAAO,MAAM,kBAAkB,EAAE,SAAS,eAAe,EAOvD,CAAC;AAEH,8GAA8G;AAC9G,eAAO,MAAM,sBAAsB,EAAE,SAAS,eAAe,EAA8D,CAAC;AAE5H,4DAA4D;AAC5D,MAAM,WAAW,eAAe;IAC9B,uFAAuF;IACvF,KAAK,EAAE,MAAM,CAAC;IACd,0EAA0E;IAC1E,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB,wFAAwF;IACxF,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;;OAIG;IACH,SAAS,CAAC,EAAE,SAAS,eAAe,EAAE,CAAC;IACvC,iEAAiE;IACjE,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC;IACd,+DAA+D;IAC/D,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,yDAAyD;AACzD,MAAM,WAAW,UAAU;IACzB,kDAAkD;IAClD,OAAO,EAAE,MAAM,CAAC;IAChB,sCAAsC;IACtC,YAAY,EAAE,WAAW,EAAE,CAAC;IAC5B,gCAAgC;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,4DAA4D;IAC5D,UAAU,EAAE,MAAM,CAAC;IACnB,uGAAuG;IACvG,QAAQ,EAAE,KAAK,CAAC;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;CACrD;AAID;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,gBAAgB,EAAE,KAAK,EAAE,SAAS,eAAe,EAAE,GAAG,SAAS,EAAE,KAAK,SAAqB,GAAG,WAAW,EAAE,CASlJ;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,KAAK,EAAE,gBAAgB,EAAE,OAAO,EAAE,eAAe,GAAG,UAAU,CAoBnG"}
+{"version":3,"file":"metric-names.d.ts","sourceRoot":"","sources":["../src/metric-names.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AAIH,oGAAoG;AACpG,MAAM,WAAW,eAAe;IAC9B,4BAA4B;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,gGAAgG;IAChG,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,KAAK,GAAG,WAAW,CAAC;IAC1B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,uGAAuG;IACvG,UAAU,EAAE,MAAM,EAAE,CAAC;CACtB;AAED,mGAAmG;AACnG,eAAO,MAAM,8BAA8B,EAAE,SAAS,MAAM,EAA6E,CAAC;AAE1I,8DAA8D;AAC9D,eAAO,MAAM,6BAA6B,wBAAwB,CAAC;AAEnE,qGAAqG;AACrG,eAAO,MAAM,iBAAiB,sBAAsB,CAAC;AAYrD,uEAAuE;AACvE,MAAM,MAAM,6BAA6B,GACrC,gCAAgC,GAChC,mCAAmC,GACnC,4BAA4B,GAC5B,eAAe,CAAC;AAEpB,0EAA0E;AAC1E,MAAM,WAAW,gBAAgB;IAC/B,kFAAkF;IAClF,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,uFAAuF;IACvF,oBAAoB,CAAC,EAAE,6BAA6B,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC;IACrE;;;;;;;OAOG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;CAC/B;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,QAAQ,EAAE,gBAAgB,GAAG;IAAE,KAAK,CAAC,EAAE,gBAAgB,CAAC;IAAC,aAAa,CAAC,EAAE,OAAO,CAAA;CAAE,GAAG,SAAS,GAAG,gBAAgB,CAO/I;AAWD,iFAAiF;AACjF,wBAAgB,eAAe,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,CAGzD;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,GAAG,WAAW,EAAE,IAAI,CAAC,EAAE,MAAM,EAAE,MAAM,GAAE,gBAAqB,GAAG,MAAM,CAUlI;AAED,oEAAoE;AACpE,MAAM,WAAW,uBAAuB;IACtC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,KAAK,CAAC;QAAE,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IACtC,gBAAgB,CAAC,EAAE,KAAK,CAAC;QAAE,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAC5C,kBAAkB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC9B,SAAS,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,OAAO,CAAC;QAAC,IAAI,CAAC,EAAE,IAAI,GAAG,GAAG,CAAC;QAAC,UAAU,CAAC,EAAE,KAAK,CAAC;YAAE,IAAI,CAAC,EAAE,MAAM,CAAA;SAAE,CAAC,CAAA;KAAE,CAAC;IAC5F,MAAM,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,OAAO,CAAC;QAAC,UAAU,CAAC,EAAE,KAAK,CAAC;YAAE,IAAI,CAAC,EAAE,MAAM,CAAA;SAAE,CAAC,CAAA;KAAE,CAAC;CACvE;AAED,6FAA6F;AAC7F,MAAM,WAAW,gBAAgB;IAC/B,oDAAoD;IACpD,SAAS,EAAE,MAAM,CAAC;IAClB,0EAA0E;IAC1E,KAAK,EAAE,eAAe,CAAC;IACvB,uEAAuE;IACvE,QAAQ,CAAC,EAAE,eAAe,CAAC;IAC3B,mEAAmE;IACnE,MAAM,CAAC,EAAE,eAAe,CAAC;IACzB;;;OAGG;IACH,MAAM,EAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;QAAC,UAAU,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IACxF,gDAAgD;IAChD,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,KAAK,QAAQ,GAAG;IAAE,aAAa,CAAC,EAAE,OAAO,CAAC;IAAC,KAAK,CAAC,EAAE,OAAO,CAAA;CAAE,CAAC;AAW7D;;;;;;;;;;;GAWG;AACH,wBAAgB,gBAAgB,CAC9B,SAAS,EAAE,uBAAuB,GAAG,QAAQ,EAC7C,QAAQ,CAAC,EAAE,gBAAgB,GAAG;IAAE,KAAK,CAAC,EAAE,gBAAgB,CAAA;CAAE,GACzD,gBAAgB,CAsClB;AAED,uGAAuG;AACvG,eAAO,MAAM,sBAAsB,yBAAyB,CAAC;AAE7D,sEAAsE;AACtE,MAAM,WAAW,wBAAwB;IACvC,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,wBAAwB,CAAC,EAAE,OAAO,CAAC;CACpC;AAED,sDAAsD;AACtD,MAAM,WAAW,iBAAiB;IAChC,yBAAyB;IACzB,QAAQ,EAAE,eAAe,CAAC;IAC1B,gCAAgC;IAChC,MAAM,EAAE,eAAe,CAAC;IACxB,0DAA0D;IAC1D,cAAc,EAAE,eAAe,CAAC;IAChC,0DAA0D;IAC1D,cAAc,EAAE,eAAe,CAAC;CACjC;AAED;;;;;;;GAOG;AACH,wBAAgB,iBAAiB,CAC/B,SAAS,EAAE,wBAAwB,GAAG,QAAQ,EAC9C,QAAQ,CAAC,EAAE,gBAAgB,GAAG;IAAE,KAAK,CAAC,EAAE,gBAAgB,CAAA;CAAE,GACzD,iBAAiB,CA4BnB;AASD,6CAA6C;AAC7C,MAAM,MAAM,WAAW,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,EAAE,GAAG,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;AAEvF,+DAA+D;AAC/D,wBAAgB,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,WAAW,EAAE,GAAG,MAAM,CAG5E;AAED,2EAA2E;AAC3E,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,CAE5E;AAED;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,CAGpG;AAED,yDAAyD;AACzD,wBAAgB,UAAU,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAE5C;AAED,0EAA0E;AAC1E,wBAAgB,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,CAE9F;AAED,qEAAqE;AACrE,MAAM,MAAM,eAAe,GACvB,uBAAuB,GACvB,oBAAoB,GACpB,kBAAkB,GAClB,kBAAkB,GAClB,oBAAoB,GACpB,oBAAoB,CAAC;AAEzB,iEAAiE;AACjE,eAAO,MAAM,kBAAkB,EAAE,SAAS,eAAe,EAOvD,CAAC;AAEH,8GAA8G;AAC9G,eAAO,MAAM,sBAAsB,EAAE,SAAS,eAAe,EAA8D,CAAC;AAE5H,4DAA4D;AAC5D,MAAM,WAAW,eAAe;IAC9B,uFAAuF;IACvF,KAAK,EAAE,MAAM,CAAC;IACd,0EAA0E;IAC1E,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB,wFAAwF;IACxF,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;;OAIG;IACH,SAAS,CAAC,EAAE,SAAS,eAAe,EAAE,CAAC;IACvC,iEAAiE;IACjE,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC;IACd,+DAA+D;IAC/D,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,yDAAyD;AACzD,MAAM,WAAW,UAAU;IACzB,kDAAkD;IAClD,OAAO,EAAE,MAAM,CAAC;IAChB,sCAAsC;IACtC,YAAY,EAAE,WAAW,EAAE,CAAC;IAC5B,gCAAgC;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,4DAA4D;IAC5D,UAAU,EAAE,MAAM,CAAC;IACnB,uGAAuG;IACvG,QAAQ,EAAE,KAAK,CAAC;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;CACrD;AAID;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,gBAAgB,EAAE,KAAK,EAAE,SAAS,eAAe,EAAE,GAAG,SAAS,EAAE,KAAK,SAAqB,GAAG,WAAW,EAAE,CASlJ;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,KAAK,EAAE,gBAAgB,EAAE,OAAO,EAAE,eAAe,GAAG,UAAU,CAoBnG"}

package/dist/metric-names.js

@@ -11,9 +11,16 @@
  * with the exporter's defaults: `.` and any other character Prometheus does
  * not allow become `_`; counters take `_total`; a unit becomes a suffix
  * (`ms` is `_milliseconds`, `s` is `_seconds`); the exporter's `namespace`
- * is a prefix joined with `_`; `add_metric_suffixes: false` drops the
- * suffixes. Attribute names become label names the same way
- * (`service.name` is `service_name`).
+ * is a prefix joined with `_`. The exporter's `translation_strategy` decides
+ * the escaping and the suffixes: the default, `UnderscoreEscapingWithSuffixes`,
+ * is what is described here; `UnderscoreEscapingWithoutSuffixes` drops the
+ * suffixes; `NoUTF8EscapingWithSuffixes` keeps the name's characters;
+ * `NoTranslation` does neither. From collector-contrib v0.154.0 the
+ * `prometheus` exporter ignores the deprecated `add_metric_suffixes`, so a
+ * name read from that exporter follows `translation_strategy` alone; the
+ * `prometheusremotewrite` exporter still honours it when no strategy is set.
+ * Attribute names become label names the same way (`service.name` is
+ * `service_name`).
  *
  * This module holds types and string functions only, so a lexicon that
  * builds queries from it does not load the collector components.
@@ -34,6 +41,29 @@ const UNIT_WORDS = {
     By: "bytes",
     "1": "ratio",
 };
+/**
+ * The naming a declared `prometheus` exporter (or its config) applies: its
+ * `namespace` and `translation_strategy`. `add_metric_suffixes` is left out,
+ * since the exporter ignores it at the pinned release. A plain
+ * `PrometheusNaming` is returned as given.
+ */
+export function exporterNaming(exporter) {
+    if (!exporter)
+        return {};
+    if ("props" in exporter && typeof exporter.props === "object" && exporter.props !== null) {
+        const { add_metric_suffixes: _ignored, ...rest } = exporter.props;
+        return { ...(rest.namespace !== undefined ? { namespace: rest.namespace } : {}), ...(rest.translation_strategy !== undefined ? { translation_strategy: rest.translation_strategy } : {}) };
+    }
+    return exporter;
+}
+/** Whether a naming escapes names to `[A-Za-z0-9_:]` and whether it adds suffixes. */
+function strategyOf(naming) {
+    const strategy = naming.translation_strategy ?? (naming.add_metric_suffixes === false ? "UnderscoreEscapingWithoutSuffixes" : "UnderscoreEscapingWithSuffixes");
+    return {
+        escape: strategy.startsWith("UnderscoreEscaping"),
+        suffixes: strategy !== "UnderscoreEscapingWithoutSuffixes" && strategy !== "NoTranslation",
+    };
+}
 /** An attribute name as a Prometheus label: `service.name` is `service_name`. */
 export function prometheusLabel(attribute) {
     const label = attribute.replace(/[^A-Za-z0-9_]/g, "_");
@@ -46,10 +76,12 @@ export function prometheusLabel(attribute) {
  * @param unit The metric's unit, e.g. `ms`. Units in braces (`{call}`) add nothing.
  */
 export function prometheusMetricName(name, type, unit, naming = {}) {
-    let out = name.replace(/[^A-Za-z0-9_:]/g, "_");
+    const { escape, suffixes } = strategyOf(naming);
+    const clean = (s) => (escape ? s.replace(/[^A-Za-z0-9_:]/g, "_") : s);
+    let out = clean(name);
     if (naming.namespace)
-        out = `${naming.namespace.replace(/[^A-Za-z0-9_:]/g, "_")}_${out}`;
-    if (naming.add_metric_suffixes === false)
+        out = `${clean(naming.namespace)}_${out}`;
+    if (!suffixes)
         return out;
     const word = unit && !unit.startsWith("{") ? (UNIT_WORDS[unit] ?? unit.replace(/[^A-Za-z0-9_:]/g, "_")) : undefined;
     if (word && !out.endsWith(`_${word}`))
@@ -81,12 +113,13 @@ function configOf(connector) {
  */
 export function spanMetricsNames(connector, exporter) {
     const c = configOf(connector);
-    const naming = exporter && "props" in exporter && typeof exporter.props === "object" ? exporter.props : (exporter ?? {});
+    const naming = exporterNaming(exporter);
     const namespace = c.namespace ?? SPANMETRICS_DEFAULT_NAMESPACE;
     const metricName = (n) => (namespace === "" ? n : `${namespace}.${n}`);
     const excluded = new Set(c.exclude_dimensions ?? []);
     const defaults = SPANMETRICS_DEFAULT_DIMENSIONS.filter((d) => !excluded.has(d));
-    const names = (extra) => (extra ?? []).map((d) => d.name);
+    // A `glob` dimension names no single attribute, so it adds no fixed label.
+    const names = (extra) => (extra ?? []).flatMap((d) => (d.name === undefined ? [] : [d.name]));
     const common = [...defaults, ...names(c.dimensions)];
     const metric = (n, type, dims, unit) => ({
         name: metricName(n),
@@ -134,7 +167,7 @@ export function serviceGraphNames(connector, exporter) {
         throw new Error(`serviceGraphNames: expected a servicegraph connector, got ${d.componentType}`);
     }
     const c = (typeof d.componentType === "string" ? (d.props ?? {}) : connector);
-    const naming = exporter && "props" in exporter && typeof exporter.props === "object" ? exporter.props : (exporter ?? {});
+    const naming = exporterNaming(exporter);
     const dimensions = [
         "client",
         "server",