PromClientAdapterOptionsType
Ce contenu n’est pas encore disponible dans votre langue.
PromClientAdapterOptionsType =
object
Defined in: src/metrics/PromClientAdapterOptions.ts:9
Plain options-object shape accepted by promClientRegistry.
Properties
Section titled “Properties”client
Section titled “client”
readonlyclient:PromClientLike
Defined in: src/metrics/PromClientAdapterOptions.ts:11
The prom-client API namespace (import client from 'prom-client').
maxSeriesPerFamily?
Section titled “maxSeriesPerFamily?”
readonlyoptionalmaxSeriesPerFamily?:number
Defined in: src/metrics/PromClientAdapterOptions.ts:31
Cap on distinct label tuples per metric family, mirroring the
DefaultMetricsRegistry cap on the bridge (#131). prom-client mints
a series inside its own Counter/Gauge/Histogram on every
.labels(...) call and never expires one, so without a cap here the
bridge is the more exposed of the two paths. Past the cap the
bridge folds further tuples into a single overflow series, leaving
prom-client with at most maxSeriesPerFamily + 1 tuples per family.
Default: DEFAULT_MAX_SERIES_PER_FAMILY, the same 10 000 the
in-process registry uses; 0 disables the cap.
namePrefix?
Section titled “namePrefix?”
readonlyoptionalnamePrefix?:string
Defined in: src/metrics/PromClientAdapterOptions.ts:18
Optional name prefix, e.g. 'actor_ts_'. Applied to every metric
name registered through the adapter. Default: empty.
registry
Section titled “registry”
readonlyregistry:PromClientRegistryLike
Defined in: src/metrics/PromClientAdapterOptions.ts:13
The prom-client Registry to publish into. Typically client.register.