Read the settings behind a service's log
Returns the settings that decide what searchServiceRoleLog can find, 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 and, for Redis, lines built from its memory and error counters, which Redis never logs. `serviceName` is a compose service.
Authorization
cloady Personal API token (cldy_…)
In: header
Path Parameters
Query Parameters
Value in
- "production"
- "preview"
- "development"
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"}Search a service's log by category GET
Reads the service's log the way its software writes it and sorts the lines into categories: for the service the app's address routes to, the ingress access log by status class beside the service's own errors; for PostgreSQL, slow statements, lock waits, deadlocks, errors, connections, autovacuum, checkpoints and temporary files; likewise for MySQL, MongoDB, ClickHouse, Redis, RabbitMQ, Postfix, Sidekiq and Celery; other services by level. Returns each category's line count and volume per step, and the newest 200 lines of the requested categories with the fields parsed from them and, for PostgreSQL, the statement logged with them. Filters take the fields `level` and, on access logs, `route`. Logs are kept for seven days. `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.