Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 | 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x | /**
* Observability Endpoints
* Client-side error tracking, RUM, and tracing collection
*/
import type { ApiEndpoint } from '@/types/api-docs';
export const observabilityEndpoints: ApiEndpoint[] = [
{
id: 'observability-errors',
method: 'POST',
path: '/api/monitoring/errors',
summary: 'Report client error',
description: 'Reports a client-side error for tracking',
category: 'observability',
requiresAuth: false,
requestBody: {
contentType: 'application/json',
fields: [
{ name: 'message', type: 'string', required: true, description: 'Error message' },
{ name: 'stack', type: 'string', required: false, description: 'Stack trace' },
{ name: 'url', type: 'string', required: true, description: 'Page URL where error occurred' },
{ name: 'userAgent', type: 'string', required: false, description: 'Browser user agent' },
{ name: 'metadata', type: 'object', required: false, description: 'Additional context' },
],
},
responses: [
{ status: 200, description: 'Error recorded' },
],
},
{
id: 'observability-rum',
method: 'POST',
path: '/api/rum/collect',
summary: 'Collect RUM data',
description: 'Collects Real User Monitoring performance data',
category: 'observability',
requiresAuth: false,
requestBody: {
contentType: 'application/json',
fields: [
{ name: 'metrics', type: 'object', required: true, description: 'Performance metrics (LCP, CLS, FID, etc.)' },
{ name: 'url', type: 'string', required: true, description: 'Page URL' },
{ name: 'connectionType', type: 'string', required: false, description: 'Network connection type' },
{ name: 'deviceType', type: 'string', required: false, description: 'Device type' },
],
},
responses: [
{ status: 200, description: 'Metrics recorded' },
],
},
{
id: 'observability-traces',
method: 'POST',
path: '/api/traces/collect',
summary: 'Collect traces',
description: 'Collects distributed trace data',
category: 'observability',
requiresAuth: false,
requestBody: {
contentType: 'application/json',
fields: [
{ name: 'traceId', type: 'string', required: true, description: 'Trace ID' },
{ name: 'spans', type: 'array', required: true, description: 'Array of trace spans' },
],
},
responses: [
{ status: 200, description: 'Trace recorded' },
],
},
{
id: 'observability-client-logs',
method: 'POST',
path: '/api/monitoring/client-logs',
summary: 'Ship client logs',
description: 'Receives batched client-side logs for server-side aggregation and storage. Logs are automatically buffered and sent by the client logger.',
category: 'observability',
requiresAuth: false,
requestBody: {
contentType: 'application/json',
fields: [
{
name: 'entries',
type: 'array',
required: true,
description: 'Array of log entries to record',
},
{
name: 'entries[].level',
type: 'string',
required: true,
description: 'Log level: debug, info, warn, or error',
},
{
name: 'entries[].message',
type: 'string',
required: true,
description: 'Log message',
},
{
name: 'entries[].timestamp',
type: 'string',
required: true,
description: 'ISO 8601 timestamp',
},
{
name: 'entries[].url',
type: 'string',
required: true,
description: 'Page URL where log was generated',
},
{
name: 'entries[].userAgent',
type: 'string',
required: true,
description: 'Browser user agent',
},
{
name: 'entries[].sessionId',
type: 'string',
required: false,
description: 'Client session identifier',
},
{
name: 'entries[].data',
type: 'object',
required: false,
description: 'Additional structured data',
},
{
name: 'entries[].error',
type: 'object',
required: false,
description: 'Error details (name, message, stack)',
},
],
},
responses: [
{
status: 200,
description: 'Logs processed successfully',
fields: [
{ name: 'success', type: 'boolean', description: 'Whether processing succeeded', required: true },
{ name: 'processed', type: 'number', description: 'Number of entries processed', required: true },
{ name: 'errors', type: 'number', description: 'Number of processing errors', required: true },
],
},
{ status: 400, description: 'Invalid request body' },
{ status: 500, description: 'Server error' },
],
},
];
|