Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface EndpointCircuitBreaker

Hierarchy

  • EndpointCircuitBreaker

Index

Properties

Optional enabled

enabled: boolean

true if the module will be applied to traffic, false to disable. default true if unspecified

errorThresholdPercentage

errorThresholdPercentage: number

Error threshold percentage should be between 0 - 1.0, not 0-100.0

numBuckets

numBuckets: number

Integer number of buckets into which metrics are retained. Max 128.

rollingWindow

rollingWindow: number

Integer number of seconds in the statistical rolling window that metrics are retained for.

trippedDuration

trippedDuration: number

Integer number of seconds after which the circuit is tripped to wait before re-evaluating upstream health

volumeThreshold

volumeThreshold: number

Integer number of requests in a rolling window that will trip the circuit. Helpful if traffic volume is low.

Generated using TypeDoc