Cloady Docs
API ReferenceEndpointsApplications

Search a service's traces

Returns a sample of the requests the service handled in the range, one per trace, with their method, route, status and duration, plus the range's request count and median and 95th-percentile duration. Filter on `route`, `method` and `status` (2xx to 5xx, or a code). Needs tracing on for the app and an OpenTelemetry SDK in the service; traces are kept for 7 days. `serviceName` is a compose service.

GET
/api/workspaces/{workspaceSlug}/apps/{appSlug}/services/{serviceName}/traces

Authorization

cloady
AuthorizationBearer <token>

Personal API token (cldy_…)

In: header

Path Parameters

workspaceSlug*string
appSlug*string
serviceName*string

Query Parameters

env?string

Value in

  • "production"
  • "preview"
  • "development"
region?string
range?string

How far back to look; the answer has 30 to 96 points across it

Default"1h"

Value in

  • "15m"
  • "1h"
  • "6h"
  • "24h"
  • "7d"
filter?array<>

Filters, each written <field><op><value> with op =, !=, =~ or !~; =~ and !~ take a regular expression matched against the whole value, ignoring case. Repeat the parameter for several; every one must hold

Itemsitems <= 20
sort?string

recent lists the newest traces; slowest adds the range's traces above its 95th percentile and lists the slowest first; errors adds the range's failed traces and lists them first

Default"recent"

Value in

  • "recent"
  • "slowest"
  • "errors"

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/workspaces/string/apps/string/services/string/traces"
{  "query": "string",  "start": 0,  "end": 0,  "traces": [    {      "id": "string",      "span": "string",      "name": "string",      "method": "string",      "route": "string",      "status": 0,      "error": true,      "start": 0,      "duration": 0    }  ],  "total": 0,  "p50": 0,  "p95": 0}

Turn an app's tracing on or off PUT

Turns OpenTelemetry tracing on or off for every compose service of the app. Turning it on adds the app variables OTEL_EXPORTER_OTLP_ENDPOINT, OTEL_EXPORTER_OTLP_PROTOCOL, OTEL_EXPORTER_OTLP_COMPRESSION, OTEL_RESOURCE_ATTRIBUTES, OTEL_METRICS_EXPORTER and OTEL_LOGS_EXPORTER, which point an OpenTelemetry SDK at Cloady's trace store; turning it off deletes them. Each service then also gets OTEL_SERVICE_NAME. The app is reconciled, so its running services restart once; setting the current value changes nothing. Needs the developer role.

Read what a service calls and what calls it GET

Returns the calls observed in the range's traces between the service and other services, databases and hosts, with their rate, failure share and 95th-percentile duration. Without observed calls it falls back to the compose file: depends_on entries and environment values that name another service as a host. `serviceName` is a compose service.