Embrace Config

Embrace configuration file

embrace-config.json

Validate

Check your file against this schema

Opens the validator with this schema already loaded. Paste your embrace-config.json and it validates in your browser — nothing is uploaded.

Validate a embrace-config.json → View raw schema

Reference

Fields

Generated directly from the schema, following local $refs, to two levels of nesting.

Field	Type	Description
`app_id`	`string`	Your 5 character app ID.
`api_token`	`string`	Your API 32-hexdigit token.
`ndk_enabled`	`boolean`	Enables NDK crash capture. Defaults to false.
`sdk_config`	`object`	—
`sdk_config.automatic_data_capture`	`object`	—
`sdk_config.automatic_data_capture.memory_info`	`boolean`	Enables memory warning capture. Defaults to true.
`sdk_config.automatic_data_capture.power_save_mode_info`	`boolean`	Enables power save mode capture. Defaults to true.
`sdk_config.automatic_data_capture.network_connectivity_info`	`boolean`	Enables network connectivity capture. Defaults to true.
`sdk_config.automatic_data_capture.anr_info`	`boolean`	Enables ANR capture. Defaults to true.
`sdk_config.taps`	`object`	—
`sdk_config.taps.capture_coordinates`	`boolean`	Set to false to disable capturing tap coordinates. Defaults to true.
`sdk_config.view_config`	`object`	—
`sdk_config.view_config.enable_automatic_activity_capture`	`boolean`	Enables capturing activity lifecycle changes in breadcrumbs. Defaults to true.
`sdk_config.webview`	`object`	—
`sdk_config.webview.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.
`sdk_config.webview.enable`	`boolean`	Set to false to disable capturing of web views. Defaults to true.
`sdk_config.crash_handler`	`object`	—
`sdk_config.crash_handler.enabled`	`boolean`	Set to false to prevent the SDK from connecting to the uncaught exception handler. Defaults to true.
`sdk_config.compose`	`object`	—
`sdk_config.compose.capture_compose_onclick`	`boolean`	Enables capture of Jetpack Compose click events. Defaults to false.
`sdk_config.capture_fcm_pii_data`	`boolean`	Enables PII data within FCM capture. Defaults to false.
`sdk_config.networking`	`object`	—
`sdk_config.networking.default_capture_limit`	`integer`	Default capture limit for specified domains. Defaults to 1000.
`sdk_config.networking.domains`	`array<object>`	List of domain names and their respective limits.
`sdk_config.networking.capture_request_content_length`	`boolean`	Disable capture of network length which can interfere with certain streaming network requests. Defaults to true.
`sdk_config.networking.disabled_url_patterns`	`array<string>`	Specify one or more regular expressions to exclude network request with URLs matching one of the regular expressions from being captured.
`sdk_config.networking.enable_native_monitoring`	`boolean`	Enable capture of network requests made using the native Java network API. Defaults to true.
`sdk_config.networking.enable_network_span_forwarding`	`boolean`	Enables network span forwarding. Defaults to false.
`sdk_config.capture_public_key`	`string`	Declares the key that should be used to capture network request bodies, if any.
`sdk_config.sensitive_keys_denylist`	`array<string>`	List of sensitive keys whose values should be redacted on capture.
`sdk_config.anr`	`object`	—
`sdk_config.anr.capture_unity_thread`	`boolean`	Enables Unity ANR capture. Defaults to false.
`sdk_config.app`	`object`	—
`sdk_config.app.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.
`sdk_config.background_activity`	`object`	—
`sdk_config.background_activity.capture_enabled`	`boolean`	Enables background activity capture. Defaults to false.
`sdk_config.base_urls`	`object`	—
`sdk_config.base_urls.config`	`string`	Base config URL for the SDK.
`sdk_config.base_urls.data`	`integer`	Base data URL for the SDK.
`sdk_config.session`	`object`	—
`sdk_config.session.components`	`array<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.
`sdk_config.session.send_full_for`	`array<string>`	List of events allowed to send a full session payload if the gating feature is enabled.
`sdk_config.sig_handler_detection`	`boolean`	Enables 3rd party signal handler detection. Defaults to true.
`sdk_config.app_exit_info`	`object`	—
`sdk_config.app_exit_info.app_exit_info_traces_limit`	`boolean`	Defines the max size of bytes to allow capturing AppExitInfo NDK/ANR traces.
`sdk_config.app_exit_info.aei_enabled`	`boolean`	Enables Application Exit Info capture. Defaults to true.
`sdk_config.app_framework`	`string`	Project's app framework, one of react_native, unity, flutter or native.
`unity`	`object`	—
`unity.symbols_archive_name`	`string`	Custom file name for unity symbols

Audit

What we found in this schema

Declared draft: draft-07
Validates cleanly against its own meta-schema.
51 properties, 71% carrying a description, max nesting depth 10.

Standards

Specification sections for the keywords in this schema

Keyword	Document	Section
`$id`	JSON Schema Core, draft 2020-12	§8.2.1 — The "$id" Keyword
`$schema`	JSON Schema Core, draft 2020-12	§8.1.1 — "$schema"
`description`	JSON Schema Validation, draft 2020-12	§9.1 — "title" and "description"
`items`	JSON Schema Core, draft 2020-12	§10.3.1.2 — "items"
`maxLength`	JSON Schema Validation, draft 2020-12	§6.3.1 — "maxLength"
`minItems`	JSON Schema Validation, draft 2020-12	§6.4.2 — "minItems"
`minLength`	JSON Schema Validation, draft 2020-12	§6.3.2 — "minLength"
`minProperties`	JSON Schema Validation, draft 2020-12	§6.5.2 — "minProperties"
`properties`	JSON Schema Core, draft 2020-12	§10.3.2.1 — "properties"
`type`	JSON Schema Validation, draft 2020-12	§6.1.1 — "type"
`uniqueItems`	JSON Schema Validation, draft 2020-12	§6.4.3 — "uniqueItems"

Documents

JSON Schema Core, draft 2020-12 — JSON Schema: A Media Type for Describing JSON Documents, A. Wright, H. Andrews, B. Hutton, G. Dennis, Eds., 2022. draft-bhutton-json-schema-01. An expired Internet-Draft with no formal standing in the IETF standards process; it is nonetheless the specification of record for JSON Schema 2020-12, published by json-schema.org.
JSON Schema Validation, draft 2020-12 — JSON Schema Validation: A Vocabulary for Structural Validation of JSON, A. Wright, H. Andrews, B. Hutton, Eds., 2022.
RFC 8259 (STD 90) — The JavaScript Object Notation (JSON) Data Interchange Format, T. Bray, Ed., 2017. The format a schema describes.
RFC 6901 — JavaScript Object Notation (JSON) Pointer. Defines the pointer syntax used by $ref fragments and the ~0 / ~1 escapes.

Source

Attribution

This schema comes from SchemaStore, distributed under the Apache License 2.0. Copyright 2015–present Mads Kristensen and contributors. View the original file. The field table and audit on this page are generated by JSONTools.tools; the schema itself is unmodified.

← All schemas