Skip to content
Ishvana Ishvana Docs

Get Swarm Metrics

GET
/api/agents/swarm/{swarm_id}/metrics

Get performance metrics for a specific swarm

Retrieves detailed performance metrics, resource usage statistics, and efficiency scores for a specific swarm. Includes agent-level metrics, task completion rates, resource utilization, and overall swarm efficiency scoring.

@param swarm_id: Unique swarm identifier @param management_interface: Injected swarm management interface @returns SwarmMetricsResponse with performance_metrics, resource_usage, and efficiency_score @raises HTTPException: If metrics not found (404) or retrieval fails (500)

Metrics Include:

  • Performance: Task completion rate, agent response times, throughput
  • Resources: CPU usage, memory consumption, network utilization
  • Efficiency: Overall swarm efficiency score (0.0-1.0)

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
swarm_id
required
Swarm Id
string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

SwarmMetricsResponse

Response model for swarm performance metrics.

Provides comprehensive performance and resource utilization metrics for a specific swarm execution, enabling performance analysis, optimization, and comparative benchmarking across different swarm types and configurations.

Fields:

  • swarm_id: Swarm identifier
  • performance_metrics: Performance data
  • resource_usage: Resource utilization
  • efficiency_score: Overall efficiency score

Performance Metrics Structure:

{
  "execution_time_seconds": 125.5,
  "agent_utilization": 0.85,
  "task_completion_rate": 0.95,
  "average_response_time": 2.3,
  "error_rate": 0.02
}

Resource Usage Structure:

{
  "cpu_usage_percent": 45.2,
  "memory_usage_mb": 1024,
  "network_requests": 150,
  "database_queries": 75,
  "api_calls": 200
}

Efficiency Score: 0.0 to 1.0 score calculated from:

  • Task completion rate (40%)
  • Resource utilization efficiency (30%)
  • Execution time vs. estimate (20%)
  • Error rate (10%)

Usage: GET /api/swarm/{id}/metrics for detailed swarm performance analysis.

JSON Example:

{
  "swarmId": "swarm_abc123",
  "performanceMetrics": {
    "executionTimeSeconds": 125.5,
    "agentUtilization": 0.85,
    "taskCompletionRate": 0.95
  },
  "resourceUsage": {
    "cpuUsagePercent": 45.2,
    "memoryUsageMb": 1024
  },
  "efficiencyScore": 0.88
}

Integration:

  • SwarmManagementInterface: Collects metrics during and after execution
  • Analytics System: Aggregates metrics for trend analysis
  • Performance Dashboard: Displays real-time and historical metrics
  • Optimization Engine: Uses metrics to improve swarm configurations
object
swarmId
required
Swarmid

Swarm identifier

string
performanceMetrics
required
Performancemetrics

Performance data

object
key
additional properties
Any of:
integer
resourceUsage
required
Resourceusage

Resource utilization

object
key
additional properties
Any of:
integer
efficiencyScore
required
Efficiencyscore

Overall efficiency score

number

422

Section titled “422 ”

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object