Home > @iamelevich/opossum-prometheus > CircuitBreakerMetricsOptions
Circuit breaker metrics options
Signature:
export interface CircuitBreakerMetricsOptions| Property | Modifiers | Type | Description |
|---|---|---|---|
| circuitBreakers? | CircuitBreaker[] | (Optional) List of circuit breakers to collect metrics for | |
| client | typeof PromClient | Prometheus client | |
| customLabels? | Record<string, string> | (Optional) Custom labels | |
| enabled? | boolean | (Optional) If disabled - will not collect metrics | |
| eventsBlacklist? | string[] | (Optional) List of opossum circuit breaker events to ignore | |
| exposePerformanceMetrics? | boolean | (Optional) Expose performance metrics circuit_breaker_performance for events success and failure |
|
| overrides? | CircuitBreakerMetricsOptionsOverrides | (Optional) Overrides for metrics. Let you change metric name and default labels | |
| prefix? | string | (Optional) Prefix for metrics. Will be added to the beginning of metric name if no override provided |
|
| registry? | PromClient.Registry | (Optional) Prometheus registry |