Embrace Config

Embrace configuration file

Type object
File match embrace-config.json
Schema URL https://catalog.lintel.tools/schemas/schemastore/embrace-config/latest.json
Source https://www.schemastore.org/embrace-config-schema-1.0.0.json

Validate with Lintel

npx @lintel/lintel check
Type: object

JSON Schema definition for the Embrace configuration file.

Properties

app_id string

Your 5 character app ID.

minLength=5maxLength=5
api_token string

Your API 32-hexdigit token.

minLength=32maxLength=32
ndk_enabled boolean

Enables NDK crash capture. Defaults to false.

sdk_config object
18 nested properties
automatic_data_capture object
4 nested properties
memory_info boolean

Enables memory warning capture. Defaults to true.

power_save_mode_info boolean

Enables power save mode capture. Defaults to true.

network_connectivity_info boolean

Enables network connectivity capture. Defaults to true.

anr_info boolean

Enables ANR capture. Defaults to true.

taps object
1 nested properties
capture_coordinates boolean

Set to false to disable capturing tap coordinates. Defaults to true.

view_config object
1 nested properties
enable_automatic_activity_capture boolean

Enables capturing activity lifecycle changes in breadcrumbs. Defaults to true.

webview object
2 nested properties
capture_query_params boolean

Set to false to disable capturing of web view query parameters. Defaults to true. If webview:enable is set to false, this setting has no effect since all capture of web view information is disabled.

enable boolean

Set to false to disable capturing of web views. Defaults to true.

crash_handler object
1 nested properties
enabled boolean

Set to false to prevent the SDK from connecting to the uncaught exception handler. Defaults to true.

compose object
1 nested properties
capture_compose_onclick boolean

Enables capture of Jetpack Compose click events. Defaults to false.

capture_fcm_pii_data boolean

Enables PII data within FCM capture. Defaults to false.

networking object
6 nested properties
default_capture_limit integer

Default capture limit for specified domains. Defaults to 1000.

domains object[]

List of domain names and their respective limits.

minItems=1uniqueItems=true
capture_request_content_length boolean

Disable capture of network length which can interfere with certain streaming network requests. Defaults to true.

disabled_url_patterns string[]

Specify one or more regular expressions to exclude network request with URLs matching one of the regular expressions from being captured.

minItems=1uniqueItems=true
enable_native_monitoring boolean

Enable capture of network requests made using the native Java network API. Defaults to true.

enable_network_span_forwarding boolean

Enables network span forwarding. Defaults to false.

capture_public_key string

Declares the key that should be used to capture network request bodies, if any.

sensitive_keys_denylist string[]

List of sensitive keys whose values should be redacted on capture.

minItems=1uniqueItems=true
anr object
1 nested properties
capture_unity_thread boolean

Enables Unity ANR capture. Defaults to false.

app object
1 nested properties
report_disk_usage boolean

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. Defaults to true.

background_activity object
1 nested properties
capture_enabled boolean

Enables background activity capture. Defaults to false.

base_urls object
2 nested properties
config string

Base config URL for the SDK.

data integer

Base data URL for the SDK.

session object
2 nested properties
components string[]

Allowlist of session components that should be included in the session payload. The presence of this property denotes that the gating feature is enabled.

uniqueItems=true
send_full_for string[]

List of events allowed to send a full session payload if the gating feature is enabled.

minItems=1uniqueItems=true
sig_handler_detection boolean

Enables 3rd party signal handler detection. Defaults to true.

app_exit_info object
2 nested properties
app_exit_info_traces_limit boolean

Defines the max size of bytes to allow capturing AppExitInfo NDK/ANR traces.

aei_enabled boolean

Enables Application Exit Info capture. Defaults to true.

app_framework string

Project's app framework, one of react_native, unity, flutter or native.

unity object
1 nested properties
symbols_archive_name string

Custom file name for unity symbols