Skip to content

Get System Metrics

GET
/api/v1/system/metrics

Get system-wide metrics.

Aggregates metrics from pipeline orchestrator including:

  • Messages received, completed, failed
  • Messages currently in flight
  • Number of running routes
  • Circuit breaker status by domain

Returns: SystemMetrics with aggregated statistics

Raises: HTTPException: 503 if orchestrator not available

Successful Response

SystemMetrics

System-wide metrics.

object
messages_received
Messages Received

Total messages received

integer
0
messages_completed
Messages Completed

Total messages completed

integer
0
messages_failed
Messages Failed

Total messages failed

integer
0
messages_in_flight
Messages In Flight

Current messages being processed

integer
0
routes_running
Routes Running

Number of active routes

integer
0
queue_depths
Queue Depths

Queue depths if available

object
key
additional properties
integer
circuit_breakers
Circuit Breakers

Circuit breaker metrics by route_id

object
key
additional properties
Array<object>
RouteCircuitBreaker

Circuit breaker data for a single adapter in a route.

object
adapter
required
Adapter

Adapter name

string
domains
Domains

Per-domain circuit breaker metrics

object
key
additional properties
CircuitBreakerMetrics

Metrics for a single circuit breaker domain.

object
state
required
State

Circuit state: closed, open, half_open

string
consecutive_failures
Consecutive Failures

Consecutive failures

integer
0
consecutive_successes
Consecutive Successes

Consecutive successes

integer
0
total_failures
Total Failures

Total failures

integer
0
total_successes
Total Successes

Total successes

integer
0
last_failure_time
Any of:
number
retry_after
Any of:
number
half_open_calls
Half Open Calls

Current calls in half-open state

integer
0
config
Any of:
CircuitBreakerConfigResponse

Circuit breaker configuration thresholds.

object
failure_threshold
required
Failure Threshold

Failures before opening

integer
success_threshold
required
Success Threshold

Successes before closing from half-open

integer
timeout_seconds
required
Timeout Seconds

Seconds before half-open transition

number
half_open_max_calls
required
Half Open Max Calls

Max concurrent calls in half-open

integer
timestamp
Timestamp

Metrics timestamp

string format: date-time