Cloady Docs
API ReferenceEndpointsApplications

Read an app's tracing setting

Returns whether tracing is on, which is whether the app holds the variable OTEL_EXPORTER_OTLP_ENDPOINT, the OpenTelemetry variables each compose service gets while it is, and which services have sent spans in the last 7 days. Spans need an OpenTelemetry SDK or agent in the app.

GET
/api/workspaces/{workspaceSlug}/apps/{appSlug}/tracing

Authorization

cloady
AuthorizationBearer <token>

Personal API token (cldy_…)

In: header

Path Parameters

workspaceSlug*string
appSlug*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/tracing"
{  "enabled": true,  "services": [    {      "name": "string",      "env": {        "property1": "string",        "property2": "string"      },      "receiving": true    }  ]}

Download a session recording GET

Returns the session's recording as compressed rrweb segments, masked in the visitor's browser. A long session can return several megabytes. Needs the developer role, since recordings show what the app's visitors saw.

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.