Chapter 04 · Cloudflare Deploy
Subchapter 4.193
references/smart-placement/api.mdMarkdown5 KBView on GitHub
Query Worker placement status via Cloudflare API:
curl -X GET "https://api.cloudflare.com/client/v4/accounts/{ACCOUNT_ID}/workers/services/{WORKER_NAME}" \
-H "Authorization: Bearer <TOKEN>" \
-H "Content-Type: application/json"Response includes placement_status field:
type PlacementStatus =
| undefined // Not yet analyzed
| 'SUCCESS' // Successfully optimized
| 'INSUFFICIENT_INVOCATIONS' // Not enough traffic
| 'UNSUPPORTED_APPLICATION'; // Made Worker slower (reverted)undefined (not present)
SUCCESS
INSUFFICIENT_INVOCATIONS
UNSUPPORTED_APPLICATION (rare, <1% of Workers)
Smart Placement adds response header indicating routing decision:
// Remote placement (Smart Placement routed request)
"cf-placement: remote-LHR" // Routed to London
// Local placement (default edge routing)
"cf-placement: local-EWR" // Stayed at Newark edgeFormat: {placement-type}-{IATA-code}
remote-* = Smart Placement routed to remote locationlocal-* = Stayed at default edge locationWarning: Beta feature, may be removed before GA.
Note: cf-placement header is a beta feature and may change or be removed.
export default {
async fetch(request: Request, env: Env): Promise<Response> {
const placementHeader = request.headers.get('cf-placement');
if (placementHeader?.startsWith('remote-')) {
const location = placementHeader.split('-')[1];
console.log(`Smart Placement routed to ${location}`);
} else if (placementHeader?.startsWith('local-')) {
const location = placementHeader.split('-')[1];
console.log(`Running at edge location ${location}`);
}
return new Response('OK');
}
} satisfies ExportedHandler<Env>;Available in Cloudflare dashboard when Smart Placement enabled:
Workers & Pages → [Your Worker] → Metrics → Request Duration
Shows histogram comparing:
Request Duration vs Execution Duration:
Use request duration to measure Smart Placement impact.
| Metric Comparison | Interpretation | Action |
|---|---|---|
| WITH < WITHOUT | Smart Placement helping | Keep enabled |
| WITH ≈ WITHOUT | Neutral impact | Consider disabling to free resources |
| WITH > WITHOUT | Smart Placement hurting | Disable with mode: "off" |
Why Smart Placement might hurt performance:
assets.run_worker_first = trueTypical improvements when Smart Placement helps:
# Tail Worker logs
wrangler tail your-worker-name
# Tail with filters
wrangler tail your-worker-name --status error
wrangler tail your-worker-name --header cf-placement
# Check placement status via API
curl -H "Authorization: Bearer $TOKEN" \
https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/workers/services/$WORKER_NAME \
| jq .result.placement_status// Placement status returned by API (field may be absent)
type PlacementStatus =
| 'SUCCESS'
| 'INSUFFICIENT_INVOCATIONS'
| 'UNSUPPORTED_APPLICATION'
| undefined;
// Placement configuration in wrangler.jsonc
type PlacementMode = 'smart' | 'off';
interface PlacementConfig {
mode: PlacementMode;
// Legacy fields (deprecated/removed):
// hint?: string; // REMOVED - no longer supported
}
// Explicit placement (separate feature from Smart Placement)
interface ExplicitPlacementConfig {
region?: string;
host?: string;
hostname?: string;
// Cannot combine with mode field
}
// Worker metadata from API response
interface WorkerMetadata {
placement?: PlacementConfig | ExplicitPlacementConfig;
placement_status?: PlacementStatus;
}
// Service Binding for backend Worker
interface Env {
BACKEND_SERVICE: Fetcher; // Service Binding to backend Worker
DATABASE: D1Database;
}
// Example Worker with Service Binding
export default {
async fetch(request: Request, env: Env): Promise<Response> {
// Forward to backend Worker with Smart Placement enabled
const response = await env.BACKEND_SERVICE.fetch(request);
return response;
}
} satisfies ExportedHandler<Env>;