cloadyDocs
Referencia de la APIEndpointsApplications

Read the settings behind a service's log

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.

GET
/api/workspaces/{workspaceSlug}/apps/{appSlug}/services/{serviceName}/logs/settings

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

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/logs/settings"
{  "engine": "string",  "settings": [    {      "name": "string",      "value": "string"    }  ],  "notes": {    "property1": "string",    "property2": "string"  },  "rows": [    {      "ts": 0,      "category": "string",      "severity": "string",      "level": "error",      "message": "string",      "statement": "string",      "fields": {        "property1": "string",        "property2": "string"      },      "pod": "string"    }  ],  "error": "string"}

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.

Read a database or cache service's live statistics GET

Reads the engine behind a compose service (Postgres, MySQL, MariaDB, ClickHouse, MongoDB, Redis, Valkey or KeyDB) through its own protocol: throughput, latency, connections, cache hit ratio and memory, with the settings and opt-ins that shape them. Returns one frame of cumulative counters with every per-second value null. Sending `Accept: text/event-stream` instead follows it live, a frame every five seconds with rates over the interval, which never completes on its own.