Skip to content

Commit

Permalink
Merge pull request #7184 from segmentio/MichaelGHSeg/Swift-Telemetry
Browse files Browse the repository at this point in the history
Adding Telemetry info for Analytics-Swift and Analytics-Kotlin SDKs
  • Loading branch information
stayseesong authored Nov 14, 2024
2 parents 96c90be + c356537 commit 3a03006
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -165,6 +165,13 @@ If you proxy your events through the `apiHost` config option, you must forward t
> warning ""
> 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.
## Telemetry
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.
You can disable telemetry at any time by setting `Telemetry.shared.enable = false`.
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`.
## Timestamps in Swift
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).
Original file line number Diff line number Diff line change
Expand Up @@ -201,5 +201,13 @@ Analytics-Kotlin is built with extensibility in mind. Use the tools list below t
> warning ""
> 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.

## Telemetry
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.
You can disable telemetry at any time by setting `Telemetry.enable = false`.
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`.
## Timestamps in Kotlin
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 comments on commit 3a03006

Please sign in to comment.