cloadyDocs
Referencia de la APIEndpointsApplications

Read what a service calls and what calls it

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.

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

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"

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/dependencies"
{  "source": "traces",  "tracing": true,  "start": 0,  "step": 0,  "calls": [    {      "peer": {        "name": "string",        "app": "string",        "env": "production",        "service": "string",        "via": "service"      },      "rps": 0,      "errorRate": 0,      "p95": 0,      "trend": [        0      ]    }  ],  "calledBy": [    {      "peer": {        "name": "string",        "app": "string",        "env": "production",        "service": "string",        "via": "service"      },      "rps": 0,      "errorRate": 0,      "p95": 0,      "trend": [        0      ]    }  ]}

Search a service's traces GET

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.

Read the settings behind a service's log GET

Returns the settings that decide what the service's log holds, read from the running engine (PostgreSQL's log_* settings, MySQL's error log and deadlock settings, Redis's slowlog and memory policy) or, for the service the app's address routes to, from the ingress. Also returns what they mean for each category of the log, as the service's `logFormat` sorts it, and, for Redis, lines built from its memory and error counters, which Redis never logs. `serviceName` is a compose service.