@vzn/vx-otel 0.0.638 → 0.0.639

package/README.md

@@ -31,7 +31,7 @@ to declare in every environment:
 
 | Variable                                                | Purpose                                                                                                                                                                            |
 | ------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `OTEL_EXPORTER_OTLP_ENDPOINT`                           | base collector URL (e.g. `http://localhost:4318`)                                                                                                                                  |
+| `OTEL_EXPORTER_OTLP_ENDPOINT`                           | base collector URL (e.g. `http://localhost:4318`); one with no `http://` or `https://` is refused with a warning                                                                   |
 | `OTEL_EXPORTER_OTLP_TRACES_ENDPOINT`                    | full traces URL override                                                                                                                                                           |
 | `OTEL_EXPORTER_OTLP_METRICS_ENDPOINT`                   | full metrics URL override                                                                                                                                                          |
 | `OTEL_EXPORTER_OTLP_LOGS_ENDPOINT`                      | full logs URL override                                                                                                                                                             |
@@ -93,8 +93,7 @@ otel({
   `vcs.ref.head.name`, `vx.command` (the command line; what follows `--`
   is counted, `-- <N arguments>`, never quoted, and a secret value
   before it is `***`), CI provider,
-  host/os/arch, vx version, `--tag k=v` →
-  `vx.tag.<k>`, and `cicd.pipeline.result` (`success`, `failure`, or
+  host/os/arch, vx version, and `cicd.pipeline.result` (`success`, `failure`, or
   `cancellation` for a run stopped with nothing failed); a red run sets
   span status `ERROR`;
 - a child `vx.task` span per task — `cicd.pipeline.task.name`,
@@ -191,8 +190,7 @@ same CPU live as with one send at the end (median of 10: 815 ms both).
 
 No send ever holds a task: a task's end only queues its records. A collector
 that never answers holds nothing either: at the end of the run every send
-still in flight is cut at core's teardown deadline (3 s,
-`VX_RUN_TEARDOWN_TIMEOUT`), and the process exits.
+still in flight is cut at core's teardown deadline (3 s), and the process exits.
 
 ## Behavior note
 
@@ -219,5 +217,5 @@ userinfo and query string replaced by `***`, so an endpoint that carries
 its credential in the URL does not leak it into a CI log. The run stays
 green either way; a collector that
 takes too long is cut off by core's end-of-run deadline
-(`VX_RUN_TEARDOWN_TIMEOUT`, 3 s by default) with a line saying the buffered
+(3 s) with a line saying the buffered
 records were lost.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vzn/vx-otel",
-  "version": "0.0.638",
+  "version": "0.0.639",
   "license": "MIT",
   "description": "OpenTelemetry exporter for vx — a telemetry plugin mapping runs to OTLP traces + metrics (CI/CD + VCS semantic conventions).",
   "keywords": [
@@ -34,7 +34,7 @@
     "access": "public"
   },
   "peerDependencies": {
-    "@vzn/vx": "^0.0.638"
+    "@vzn/vx": "^0.0.639"
   },
   "repository": {
     "type": "git",

package/src/otlp.ts

@@ -109,7 +109,6 @@ const VX_ATTR = {
   version: 'vx.version',
   dirty: 'vx.dirty',
   defaultBranch: 'vx.default_branch',
-  tagPrefix: 'vx.tag.',
   // run summary (root span only)
   runStartedAt: 'vx.run.started_at',
   runEndedAt: 'vx.run.ended_at',
@@ -395,7 +394,6 @@ export function runSpanAttributes(run: RunContextRecord, summary?: RunSummaryRec
   if (run.dirty !== null) attrs.push(boolAttr(VX_ATTR.dirty, run.dirty))
   if (run.ciProvider !== null) attrs.push(strAttr(VX_ATTR.ciProvider, run.ciProvider))
   if (run.host !== null) attrs.push(strAttr(VX_ATTR.host, run.host))
-  for (const [k, v] of Object.entries(run.tags)) attrs.push(strAttr(`${VX_ATTR.tagPrefix}${k}`, v))
   if (summary !== undefined) {
     attrs.push(
       intAttr(VX_ATTR.runStartedAt, summary.startedAt),

package/src/plugin.ts

@@ -174,19 +174,47 @@ export function resolveOtelConfig(
   env: Record<string, string | undefined>,
   warn?: (m: string) => void,
 ): OtelSinkConfig | undefined {
-  const base = present(opts.endpoint) ?? present(env['OTEL_EXPORTER_OTLP_ENDPOINT'])
-  const tracesUrl =
-    present(opts.tracesEndpoint) ??
-    present(env['OTEL_EXPORTER_OTLP_TRACES_ENDPOINT']) ??
-    (base ? joinSignal(base, 'traces') : undefined)
-  const metricsUrl =
-    present(opts.metricsEndpoint) ??
-    present(env['OTEL_EXPORTER_OTLP_METRICS_ENDPOINT']) ??
-    (base ? joinSignal(base, 'metrics') : undefined)
-  const logsUrl =
-    present(opts.logsEndpoint) ??
-    present(env['OTEL_EXPORTER_OTLP_LOGS_ENDPOINT']) ??
-    (base ? joinSignal(base, 'logs') : undefined)
+  // Each URL with the setting it came from, so a refusal can name it
+  // without printing a value that may hold a credential.
+  const from = (option: keyof OtelPluginOptions, envName: string): [string, string] | undefined => {
+    const o = present(opts[option] as string | undefined)
+    if (o !== undefined) return [o, `the ${option} option`]
+    const e = present(env[envName])
+    return e === undefined ? undefined : [e, envName]
+  }
+  const base = from('endpoint', 'OTEL_EXPORTER_OTLP_ENDPOINT')
+  const pick = (
+    option: keyof OtelPluginOptions,
+    envName: string,
+    signal: string,
+  ): [string, string] | undefined =>
+    from(option, envName) ??
+    (base === undefined ? undefined : [joinSignal(base[0], signal), base[1]])
+  const picked = {
+    traces: pick('tracesEndpoint', 'OTEL_EXPORTER_OTLP_TRACES_ENDPOINT', 'traces'),
+    metrics: pick('metricsEndpoint', 'OTEL_EXPORTER_OTLP_METRICS_ENDPOINT', 'metrics'),
+    logs: pick('logsEndpoint', 'OTEL_EXPORTER_OTLP_LOGS_ENDPOINT', 'logs'),
+  }
+  // An endpoint with no http(s) scheme (`localhost:4318`) parses as a URL
+  // of scheme `localhost:`: every export failed "Unable to connect", once
+  // per signal, after a second of retries. It is refused here, once per
+  // setting, and its signals are not exported.
+  const refused = new Map<string, string[]>()
+  for (const signal of ['traces', 'metrics', 'logs'] as const) {
+    const p = picked[signal]
+    if (p === undefined) continue
+    const protocol = URL.parse(p[0])?.protocol
+    if (protocol === 'http:' || protocol === 'https:') continue
+    refused.set(p[1], [...(refused.get(p[1]) ?? []), signal])
+    picked[signal] = undefined
+  }
+  for (const [setting, signals] of refused) {
+    const names = signals.length === 3 ? 'traces, metrics and logs' : signals.join(' and ')
+    warn?.(`[vx-otel] ${setting} is not an http:// or https:// URL — ${names} are not exported`)
+  }
+  const tracesUrl = picked.traces?.[0]
+  const metricsUrl = picked.metrics?.[0]
+  const logsUrl = picked.logs?.[0]
   // Each signal has its own endpoint, as the spec has them: a pipeline that
   // set only a metrics (or logs) endpoint declined whole and exported
   // nothing (F-45). The plugin declines only when no signal has one.