-
Notifications
You must be signed in to change notification settings - Fork 11
/
embrace-config-schema.json
291 lines (291 loc) · 9.31 KB
/
embrace-config-schema.json
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
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "JSON Schema definition for the Embrace configuration file.",
"id": "https://json.schemastore.org/embrace-config-schema-1.0.0.json",
"properties": {
"app_id": {
"description": "Your 5 character app ID.",
"type": "string",
"maxLength": 5,
"minLength": 5
},
"api_token": {
"description": "Your API 32-hexdigit token.",
"type": "string",
"maxLength": 32,
"minLength": 32
},
"ndk_enabled": {
"description": "Enables NDK crash capture",
"default": false,
"type": "boolean"
},
"sdk_config": {
"type": "object",
"properties": {
"automatic_data_capture": {
"type": "object",
"properties": {
"memory_info": {
"description": "Enables memory warning capture",
"default": true,
"type": "boolean"
},
"power_save_mode_info": {
"description": "Enables power save mode capture.",
"default": true,
"type": "boolean"
},
"network_connectivity_info": {
"description": "Enables network connectivity capture.",
"default": true,
"type": "boolean"
},
"anr_info": {
"description": "Enables ANR capture.",
"default": true,
"type": "boolean"
}
},
"minProperties": 1
},
"taps": {
"type": "object",
"properties": {
"capture_coordinates": {
"description": "Set to false to disable capturing tap coordinates.",
"default": true,
"type": "boolean"
}
},
"minProperties": 1
},
"view_config": {
"type": "object",
"properties": {
"enable_automatic_activity_capture": {
"description": "Enables capturing activity lifecycle changes in breadcrumbs.",
"default": true,
"type": "boolean"
}
},
"minProperties": 1
},
"webview": {
"type": "object",
"properties": {
"capture_query_params": {
"description": "Set to false to disable capturing of web view query parameters. If webview:enable is set to false, this setting has no effect since all capture of web view information is disabled.",
"default": true,
"type": "boolean"
},
"enable": {
"description": "Set to false to disable capturing of web views.",
"default": true,
"type": "boolean"
}
},
"minProperties": 1
},
"crash_handler": {
"type": "object",
"properties": {
"enabled": {
"description": "Set to false to prevent the SDK from connecting to the uncaught exception handler.",
"default": true,
"type": "boolean"
}
},
"minProperties": 1
},
"compose": {
"type": "object",
"properties": {
"capture_compose_onclick": {
"description": "Enables capture of Jetpack Compose click events.",
"default": false,
"type": "boolean"
}
},
"minProperties": 1
},
"capture_fcm_pii_data": {
"description": "Enables PII data within FCM capture.",
"default": false,
"type": "boolean"
},
"networking": {
"type": "object",
"properties": {
"default_capture_limit": {
"description": "Default capture limit for specified domains.",
"default": 1000,
"type": "integer"
},
"domains": {
"description": "List of domain names and their respective limits.",
"type": "array",
"items": {
"type": "object",
"properties": {
"domain_name": {
"description": "Domain URL.",
"type": "string"
},
"domain_limit": {
"description": "Limit for the number of requests to be tracked.",
"type": "integer"
}
},
"minProperties": 1
},
"minItems": 1,
"uniqueItems": true
},
"capture_request_content_length": {
"description": "Disable capture of network length which can interfere with certain streaming network requests.",
"default": true,
"type": "boolean"
},
"disabled_url_patterns": {
"description": "Specify one or more regular expressions to exclude network request with URLs matching one of the regular expressions from being captured.",
"type": "array",
"items": {
"type": "string"
},
"minItems": 1,
"uniqueItems": true
},
"enable_native_monitoring": {
"description": "Enable capture of network requests made using the native Java network API.",
"default": true,
"type": "boolean"
},
"enable_network_span_forwarding": {
"description": "Enables network span forwarding.",
"default": false,
"type": "boolean"
}
},
"minProperties": 1
},
"capture_public_key": {
"type": "string",
"description": "Declares the key that should be used to capture network request bodies, if any."
},
"sensitive_keys_denylist": {
"description": "List of sensitive keys whose values should be redacted on capture.",
"type": "array",
"items": {
"type": "string"
},
"minItems": 1,
"uniqueItems": true
},
"anr": {
"type": "object",
"properties": {
"capture_unity_thread": {
"description": "Enables Unity ANR capture.",
"default": false,
"type": "boolean"
}
},
"minProperties": 1
},
"app": {
"type": "object",
"properties": {
"report_disk_usage": {
"description": "The SDK collects the disk usage for the app. You can disable this if your app has a large number of local files to prevent excessive resource usage, especially on lower-end devices.",
"default": true,
"type": "boolean"
}
},
"minProperties": 1
},
"background_activity": {
"type": "object",
"properties": {
"capture_enabled": {
"description": "Enables background activity capture.",
"default": false,
"type": "boolean"
}
},
"minProperties": 1
},
"base_urls": {
"type": "object",
"properties": {
"config": {
"description": "Base config URL for the SDK.",
"type": "string"
},
"data": {
"description": "Base data URL for the SDK.",
"type": "string"
}
},
"minProperties": 1
},
"session": {
"type": "object",
"properties": {
"components": {
"description": "Allowlist of session components that should be included in the session payload. The presence of this property denotes that the gating feature is enabled.",
"type": "array",
"items": {
"type": "string"
},
"uniqueItems": true
},
"send_full_for": {
"description": "List of events allowed to send a full session payload if the gating feature is enabled.",
"type": "array",
"items": {
"type": "string"
},
"minItems": 1,
"uniqueItems": true
}
},
"minProperties": 1
},
"sig_handler_detection": {
"description": "Enables 3rd party signal handler detection.",
"default": true,
"type": "boolean"
},
"app_exit_info": {
"type": "object",
"properties": {
"aei_enabled": {
"description": "Enables Application Exit Info capture.",
"default": true,
"type": "boolean"
}
},
"minProperties": 1
},
"app_framework": {
"type": "string",
"description": "Project's app framework, one of react_native, unity, flutter or native."
}
},
"minProperties": 1
},
"unity": {
"type": "object",
"properties": {
"symbols_archive_name": {
"description": "Custom file name for unity symbols",
"type": "string"
}
},
"minProperties": 1
}
},
"title": "Embrace Config Schema",
"type": "object"
}