Skip to content

Commit 4221880

Browse files
authored
Adding Telemetry info for Analytics-Swift SDK
1 parent 50edd9e commit 4221880

File tree

1 file changed

+7
-0
lines changed
  • src/connections/sources/catalog/libraries/mobile/apple

1 file changed

+7
-0
lines changed

src/connections/sources/catalog/libraries/mobile/apple/index.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -165,6 +165,13 @@ If you proxy your events through the `apiHost` config option, you must forward t
165165
> warning ""
166166
> If you are using the Analytics iOS (Classic) SDK, you can find [the documentation here](/docs/connections/sources/catalog/libraries/mobile/ios). Many of the features available in the Analytics-Swift SDK are not available in the Analytics iOS (Classic) SDK.
167167
168+
## Telemetry
169+
Telemetry data related to the configuration and usage of the Analytics-Swift SDK is collected and sent to Segment by default. This includes some basic configuration information, plugins and event types used, and basic error information. No PII is collected and the information is downsampled to reduce traffic.
170+
171+
The Telemetry system can be disabled at any time by setting `Telemetry.shared.enable = false`.
172+
173+
When internal errors or errors from plugins occur, the writekey may be included with the error data to help customers track down problems. This can be disabled by setting `Telemetry.shared.sendWriteKeyOnError = false`.
174+
168175
## Timestamps in Swift
169176
Due to efficiency updates made to Segment's Swift library, Segment now adds the `sentAt` timestamp to an event when the batch is complete and initially tried to the Segment API. This can impact the value of the `timestamp` field calculated by Segment if users are operating in an offline mode. More details on this change can be seen in Segment's [timestamp documentation](/docs/connections/spec/common/#sentat).
170177

0 commit comments

Comments
 (0)