Client errors

Report a frontend error to Cloud Error Reporting (public; body at most 16 KiB)

Changed on

No authentication and no organization header: errors happen on the sign-in page and the public survey. The server sanitises every field again (URL query strings and fragments, email addresses, bearer and JWT tokens and long hex/base64 secrets are removed) and caps message at 1,000 characters, stack at 8,000, route at 300 and release at 100. Unknown fields are ignored. Each accepted report is logged once as an Error Reporting event for the service greentally-fe; no header, IP address, user or organization is recorded. Rate-limited per client IP (about 10 a minute) and per instance (429 RATE_LIMITED, nothing logged).

post/client-errors

Request

  • Base URL: https://api.greentally.ai/v1
  • URL: https://api.greentally.ai/v1/client-errors
  • Auth: none required

Request body

kind'error' | 'unhandledrejection' | 'boundary' required

window error, unhandled promise rejection, or a React error boundary

messagestring required

The error message (non-empty; kept to 1,000 characters)

releasestring

The frontend release, Error Reporting's serviceContext.version; kept only when it is a semantic version (v1.2.3, optional -suffix) or a 7-40 character commit SHA, otherwise "unknown"

routestring

The page's path; everything from the first '?' or '#' is dropped (kept to 300 characters)

stackstring

The JavaScript stack as the browser gives it (kept to 8,000 characters)

Response

Accepted (also when the report was sanitised or capped)

Changes