Manage OpenTelemetry Agents Using APIs

How to use the Client Inventory API to monitor, troubleshoot, and audit your agent fleet.

Monitor the Fleet Health

By default, fleet health is monitored when you use the Get Client by ID API (GET /v1/clients/{id}).

To monitor your fleet without the overhead of health data, use the include_health=false parameter. This is ideal for analytical queries or large-scale inventory reports.

CODE 
GET /v1/clients?filter=region:us-east&include_health=false

Troubleshoot the Agent Configuration

If an agent is not performing as expected, retrieve its effective configuration to compare it against the target state. Use stringify=true to view the configuration in a human-readable format.

CODE 
GET /v1/clients/{id}/config?stringify=true

Audit the Fleet Configuration

For compliance or troubleshooting across a cluster, use the batch endpoint to retrieve configurations for multiple agents in a single request.

JSON 
POST /v1/clients/configs:batch
{
  "clientIds": ["01FXQZ9Y5K6J7V8W9X0Y1Z2A3B", "01FXQZ9Y5K6J7V8W9X0Y1Z2A3C"],
  "stringify": true
}