Skip to content

Commit 3e800fa

Browse files
committed
1 parent f9561c6 commit 3e800fa

File tree

1 file changed

+51
-292
lines changed

1 file changed

+51
-292
lines changed

relay/event.schema.json

Lines changed: 51 additions & 292 deletions
Original file line numberDiff line numberDiff line change
@@ -1423,56 +1423,15 @@
14231423
},
14241424
"EventType": {
14251425
"description": "The type of an event.\n\nThe event type determines how Sentry handles the event and has an impact on processing, rate limiting, and quotas. There are three fundamental classes of event types:\n\n- **Error monitoring events** (`default`, `error`): Processed and grouped into unique issues based on their exception stack traces and error messages. - **Security events** (`csp`, `hpkp`, `expectct`, `expectstaple`): Derived from Browser security violation reports and grouped into unique issues based on the endpoint and violation. SDKs do not send such events. - **Transaction events** (`transaction`): Contain operation spans and collected into traces for performance monitoring.",
1426-
"oneOf": [
1427-
{
1428-
"description": "Events that carry an exception payload.",
1429-
"type": "string",
1430-
"enum": [
1431-
"error"
1432-
]
1433-
},
1434-
{
1435-
"description": "A CSP violation payload.",
1436-
"type": "string",
1437-
"enum": [
1438-
"csp"
1439-
]
1440-
},
1441-
{
1442-
"description": "An HPKP violation payload.",
1443-
"type": "string",
1444-
"enum": [
1445-
"hpkp"
1446-
]
1447-
},
1448-
{
1449-
"description": "An ExpectCT violation payload.",
1450-
"type": "string",
1451-
"enum": [
1452-
"expectct"
1453-
]
1454-
},
1455-
{
1456-
"description": "An ExpectStaple violation payload.",
1457-
"type": "string",
1458-
"enum": [
1459-
"expectstaple"
1460-
]
1461-
},
1462-
{
1463-
"description": "Performance monitoring transactions carrying spans.",
1464-
"type": "string",
1465-
"enum": [
1466-
"transaction"
1467-
]
1468-
},
1469-
{
1470-
"description": "All events that do not qualify as any other type.",
1471-
"type": "string",
1472-
"enum": [
1473-
"default"
1474-
]
1475-
}
1426+
"type": "string",
1427+
"enum": [
1428+
"error",
1429+
"csp",
1430+
"hpkp",
1431+
"expectct",
1432+
"expectstaple",
1433+
"transaction",
1434+
"default"
14761435
]
14771436
},
14781437
"Exception": {
@@ -2032,35 +1991,12 @@
20321991
},
20331992
"InstructionAddrAdjustment": {
20341993
"description": "Controls the mechanism by which the `instruction_addr` of a [`Stacktrace`] [`Frame`] is adjusted.\n\nThe adjustment tries to transform *return addresses* to *call addresses* for symbolication. Typically, this adjustment needs to be done for all frames but the first, as the first frame is usually taken directly from the cpu context of a hardware exception or a suspended thread and the stack trace is created from that.\n\nWhen the stack walking implementation truncates frames from the top, `\"all\"` frames should be adjusted. In case the stack walking implementation already does the adjustment when producing stack frames, `\"none\"` should be used here.",
2035-
"oneOf": [
2036-
{
2037-
"description": "The default. Applies a heuristic based on other event / exception attributes.",
2038-
"type": "string",
2039-
"enum": [
2040-
"auto"
2041-
]
2042-
},
2043-
{
2044-
"description": "All but the first frame needs to be adjusted. The first frame's address is not a *return address*, but points directly to the faulty instruction.",
2045-
"type": "string",
2046-
"enum": [
2047-
"all_but_first"
2048-
]
2049-
},
2050-
{
2051-
"description": "All frames should be adjusted, for example because the stack walking implementation truncated frames from the top of the stack, and all remaining frames' addresses are *return addresses*.",
2052-
"type": "string",
2053-
"enum": [
2054-
"all"
2055-
]
2056-
},
2057-
{
2058-
"description": "The stack walking implementation already provides correct addresses and no adjustment should be performed when symbolicating.",
2059-
"type": "string",
2060-
"enum": [
2061-
"none"
2062-
]
2063-
}
1994+
"type": "string",
1995+
"enum": [
1996+
"auto",
1997+
"all_but_first",
1998+
"all",
1999+
"none"
20642000
]
20652001
},
20662002
"JsonLenientString": {
@@ -2073,42 +2009,13 @@
20732009
},
20742010
"Level": {
20752011
"description": "Severity level of an event or breadcrumb.",
2076-
"oneOf": [
2077-
{
2078-
"description": "Indicates very spammy debug information.",
2079-
"type": "string",
2080-
"enum": [
2081-
"debug"
2082-
]
2083-
},
2084-
{
2085-
"description": "Informational messages.",
2086-
"type": "string",
2087-
"enum": [
2088-
"info"
2089-
]
2090-
},
2091-
{
2092-
"description": "A warning.",
2093-
"type": "string",
2094-
"enum": [
2095-
"warning"
2096-
]
2097-
},
2098-
{
2099-
"description": "An error.",
2100-
"type": "string",
2101-
"enum": [
2102-
"error"
2103-
]
2104-
},
2105-
{
2106-
"description": "Similar to error but indicates a critical event that usually causes a shutdown.",
2107-
"type": "string",
2108-
"enum": [
2109-
"fatal"
2110-
]
2111-
}
2012+
"type": "string",
2013+
"enum": [
2014+
"debug",
2015+
"info",
2016+
"warning",
2017+
"error",
2018+
"fatal"
21122019
]
21132020
},
21142021
"LogEntry": {
@@ -3047,126 +2954,25 @@
30472954
},
30482955
"SpanStatus": {
30492956
"description": "Trace status.\n\nValues from <https://github.com/open-telemetry/opentelemetry-specification/blob/8fb6c14e4709e75a9aaa64b0dbbdf02a6067682a/specification/api-tracing.md#status> Mapping to HTTP from <https://github.com/open-telemetry/opentelemetry-specification/blob/8fb6c14e4709e75a9aaa64b0dbbdf02a6067682a/specification/data-http.md#status>",
3050-
"oneOf": [
3051-
{
3052-
"description": "The operation completed successfully.\n\nHTTP status 100..299 + successful redirects from the 3xx range.",
3053-
"type": "string",
3054-
"enum": [
3055-
"ok"
3056-
]
3057-
},
3058-
{
3059-
"description": "The operation was cancelled (typically by the user).",
3060-
"type": "string",
3061-
"enum": [
3062-
"cancelled"
3063-
]
3064-
},
3065-
{
3066-
"description": "Unknown. Any non-standard HTTP status code.\n\n\"We do not know whether the transaction failed or succeeded\"",
3067-
"type": "string",
3068-
"enum": [
3069-
"unknown"
3070-
]
3071-
},
3072-
{
3073-
"description": "Client specified an invalid argument. 4xx.\n\nNote that this differs from FailedPrecondition. InvalidArgument indicates arguments that are problematic regardless of the state of the system.",
3074-
"type": "string",
3075-
"enum": [
3076-
"invalid_argument"
3077-
]
3078-
},
3079-
{
3080-
"description": "Deadline expired before operation could complete.\n\nFor operations that change the state of the system, this error may be returned even if the operation has been completed successfully.\n\nHTTP redirect loops and 504 Gateway Timeout",
3081-
"type": "string",
3082-
"enum": [
3083-
"deadline_exceeded"
3084-
]
3085-
},
3086-
{
3087-
"description": "404 Not Found. Some requested entity (file or directory) was not found.",
3088-
"type": "string",
3089-
"enum": [
3090-
"not_found"
3091-
]
3092-
},
3093-
{
3094-
"description": "Already exists (409)\n\nSome entity that we attempted to create already exists.",
3095-
"type": "string",
3096-
"enum": [
3097-
"already_exists"
3098-
]
3099-
},
3100-
{
3101-
"description": "403 Forbidden\n\nThe caller does not have permission to execute the specified operation.",
3102-
"type": "string",
3103-
"enum": [
3104-
"permission_denied"
3105-
]
3106-
},
3107-
{
3108-
"description": "429 Too Many Requests\n\nSome resource has been exhausted, perhaps a per-user quota or perhaps the entire file system is out of space.",
3109-
"type": "string",
3110-
"enum": [
3111-
"resource_exhausted"
3112-
]
3113-
},
3114-
{
3115-
"description": "Operation was rejected because the system is not in a state required for the operation's execution",
3116-
"type": "string",
3117-
"enum": [
3118-
"failed_precondition"
3119-
]
3120-
},
3121-
{
3122-
"description": "The operation was aborted, typically due to a concurrency issue.",
3123-
"type": "string",
3124-
"enum": [
3125-
"aborted"
3126-
]
3127-
},
3128-
{
3129-
"description": "Operation was attempted past the valid range.",
3130-
"type": "string",
3131-
"enum": [
3132-
"out_of_range"
3133-
]
3134-
},
3135-
{
3136-
"description": "501 Not Implemented\n\nOperation is not implemented or not enabled.",
3137-
"type": "string",
3138-
"enum": [
3139-
"unimplemented"
3140-
]
3141-
},
3142-
{
3143-
"description": "Other/generic 5xx.",
3144-
"type": "string",
3145-
"enum": [
3146-
"internal_error"
3147-
]
3148-
},
3149-
{
3150-
"description": "503 Service Unavailable",
3151-
"type": "string",
3152-
"enum": [
3153-
"unavailable"
3154-
]
3155-
},
3156-
{
3157-
"description": "Unrecoverable data loss or corruption",
3158-
"type": "string",
3159-
"enum": [
3160-
"data_loss"
3161-
]
3162-
},
3163-
{
3164-
"description": "401 Unauthorized (actually does mean unauthenticated according to RFC 7235)\n\nPrefer PermissionDenied if a user is logged in.",
3165-
"type": "string",
3166-
"enum": [
3167-
"unauthenticated"
3168-
]
3169-
}
2957+
"type": "string",
2958+
"enum": [
2959+
"ok",
2960+
"cancelled",
2961+
"unknown",
2962+
"invalid_argument",
2963+
"deadline_exceeded",
2964+
"not_found",
2965+
"already_exists",
2966+
"permission_denied",
2967+
"resource_exhausted",
2968+
"failed_precondition",
2969+
"aborted",
2970+
"out_of_range",
2971+
"unimplemented",
2972+
"internal_error",
2973+
"unavailable",
2974+
"data_loss",
2975+
"unauthenticated"
31702976
]
31712977
},
31722978
"Stacktrace": {
@@ -3582,63 +3388,16 @@
35823388
},
35833389
"TransactionSource": {
35843390
"description": "Describes how the name of the transaction was determined.",
3585-
"oneOf": [
3586-
{
3587-
"description": "User-defined name set through `set_transaction_name`.",
3588-
"type": "string",
3589-
"enum": [
3590-
"custom"
3591-
]
3592-
},
3593-
{
3594-
"description": "Raw URL, potentially containing identifiers.",
3595-
"type": "string",
3596-
"enum": [
3597-
"url"
3598-
]
3599-
},
3600-
{
3601-
"description": "Parametrized URL or route.",
3602-
"type": "string",
3603-
"enum": [
3604-
"route"
3605-
]
3606-
},
3607-
{
3608-
"description": "Name of the view handling the request.",
3609-
"type": "string",
3610-
"enum": [
3611-
"view"
3612-
]
3613-
},
3614-
{
3615-
"description": "Named after a software component, such as a function or class name.",
3616-
"type": "string",
3617-
"enum": [
3618-
"component"
3619-
]
3620-
},
3621-
{
3622-
"description": "The transaction name was updated to reduce the name cardinality.",
3623-
"type": "string",
3624-
"enum": [
3625-
"sanitized"
3626-
]
3627-
},
3628-
{
3629-
"description": "Name of a background task (e.g. a Celery task).",
3630-
"type": "string",
3631-
"enum": [
3632-
"task"
3633-
]
3634-
},
3635-
{
3636-
"description": "This is the default value set by Relay for legacy SDKs.",
3637-
"type": "string",
3638-
"enum": [
3639-
"unknown"
3640-
]
3641-
}
3391+
"type": "string",
3392+
"enum": [
3393+
"custom",
3394+
"url",
3395+
"route",
3396+
"view",
3397+
"component",
3398+
"sanitized",
3399+
"task",
3400+
"unknown"
36423401
]
36433402
},
36443403
"User": {

0 commit comments

Comments
 (0)