Merge pull request #230 from embrace-io/eliabsisay-patch-2

Create Data-Marshaling-and-Transmission.md

docs/product/Data-Marshaling-and-Transmission.md

@@ -0,0 +1,39 @@
+---
+title: Data Marshaling and Transmission
+sidebar_position: 11
+description: How about keeping it simple with something like "How Embrace SDKs Transfer Data from Devices to Our Servers
+---
+
+# Overview
+
+---
+
+Embrace is designed to be a “good citizen” within your mobile application. We’re aware that many of our customers have critical user journeys (such as completing a transaction) that cannot be interrupted or slowed by non-essential network activity. To address these concerns:
+
+- **Data is batched and tranmitted to balance reliability with resource usage.**
+  - On Android, requests are sent serially, i.e. only one payload is actively being sent at one time.
+  - On iOS, payloads are enqueued with a low-priority.
+- **We do not send data if we detect there is no network connection** and use an exponential backoff scheme to handle retries so the queue won't be overwhelmed by requests timing out if the network condition is poor.
+- **We do not share any domain or session resources** with your primary application requests, so there is no direct contention with your core APIs.
+
+These design principles ensure that user-facing requests (such as booking flows, checkouts, or other high-priority transactions) will be impacted as little as possible by the overhead of transimitting telemetry.
+
+# FAQs
+
+---
+
+## **Will Embrace SDK’s network requests block or slow down my main APIs?**
+
+No. We send data in small, batched increments and only one batch at a time. On Android, this is a single network call at a time. On iOS, we use a separate URLSession with lower priority. This ensures Embrace’s requests do not interfere with higher-priority user or application traffic and limits bandwidth consumption.
+
+## **What happens if the user is on a weak connection?**
+
+We employ exponential backoff for retries when a connection fails and do not attempt to send if the device is offline. This means that if the first request fails, we retry in 1 minute, then 2 minutes, then 4 minutes, doubling at every interval. This prevents us from continuously saturating a weak network when timeouts or transmission failure are likely.
+
+## **Can we configure the SDK to only send data when on Wi-Fi or in the background?**
+
+No. We prioritize quick, low-frequency uploads to avoid large backlogs and ensure timely observability. Restricting uploads to Wi-Fi or background-only would risk missing critical data if the app is not backgrounded for a long enough period or closed altogether.
+
+## **Is it possible to disable data sending entirely during critical user flows?**
+
+We do not offer an official toggle for this. However, if needed, please reach out to discuss advanced use cases. Be aware that disabling data transmission for extended periods can create gaps in observability.