Skip to content
← All rules
ObservabilityTelemetry cardinality

observability/require-stable-telemetry-names

Telemetry names should be stable literals or visibly bounded templates rather than dynamic values that create unbounded cardinality.

metricsspanscardinality
TypeScript
metrics.increment(`request.${userId}`);
Finding

Require stable event, span, and metric names.

Setup

Install the package, register its plugin factory, then enable the rule.

Install the package

pnpm add -D @scruple/observability

Register the plugin

In scruple.config.ts, register the factory under the observability namespace used by the rule ID.

import { observability } from "@scruple/observability";

plugins: {
  "observability": observability(),
},

Enable the rule

"observability/require-stable-telemetry-names": "warn"
Package
@scruple/observability
Default threshold
Plugin default
Minimum confidence
0.7

Released under the MIT License.