Skip to content

Commit 3a03006

Browse files
authored
Merge pull request #7184 from segmentio/MichaelGHSeg/Swift-Telemetry
Adding Telemetry info for Analytics-Swift and Analytics-Kotlin SDKs
2 parents 96c90be + c356537 commit 3a03006

File tree

2 files changed

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

2 files changed

+15
-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+
The Analytics-Swift SDK collects telemetry data on configuration and usage by default. This includes basic information on SDK setup, plugins and event types used, and basic error details. Segment downsamples the data to minimize traffic and doesn't collect any personally identifiable information (PII) or event data.
170+
171+
You can disable telemetry at any time by setting `Telemetry.shared.enable = false`.
172+
173+
When internal errors or errors from plugins occur, the write key may be included with error data to help Segment identify the issue(s). You can disable this 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

src/connections/sources/catalog/libraries/mobile/kotlin-android/index.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -201,5 +201,13 @@ Analytics-Kotlin is built with extensibility in mind. Use the tools list below t
201201
> warning ""
202202
> If you are using the Analytics Android (Classic) SDK, you can find [the documentation here](/docs/connections/sources/catalog/libraries/mobile/android). Many of the features available in the Analytics Kotlin SDK are not available in the Analytics Android (Classic) SDK.
203203

204+
## Telemetry
205+
The Analytics-Kotlin SDK collects telemetry data on configuration and usage by default. This includes basic information on SDK setup, plugins and event types used, and basic error details. Segment downsamples the data to minimize traffic and doesn't collect any personally identifiable information (PII) or event data.
206+
207+
You can disable telemetry at any time by setting `Telemetry.enable = false`.
208+
209+
When internal errors or errors from plugins occur, the write key may be included with error data to help Segment identify the issue(s). You can disable this by setting `Telemetry.sendWriteKeyOnError = false`.
210+
211+
204212
## Timestamps in Kotlin
205213
Due to efficiency updates made to Segment's Kotlin 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).

0 commit comments

Comments
 (0)