Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding Telemetry info for Analytics-Swift and Analytics-Kotlin SDKs #7184

Merged
merged 8 commits into from
Nov 14, 2024
Merged

Adding Telemetry info for Analytics-Swift and Analytics-Kotlin SDKs #7184

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
4221880
Adding Telemetry info for Analytics-Swift SDK
MichaelGHSeg Oct 30, 2024
ba08ec2
Add mention that event data is not collected
MichaelGHSeg Nov 1, 2024
c6da846
Add Telemetry info for Kotlin
MichaelGHSeg Nov 12, 2024
7ec5080
Moving section
MichaelGHSeg Nov 12, 2024
2ec08cb
rewording - Analytics-Swift
pwseg Nov 14, 2024
ac34f84
Apply suggestions from code review
MichaelGHSeg Nov 14, 2024
30b94f0
Clarify writekey usage
MichaelGHSeg Nov 14, 2024
c356537
Bringing over Swift edits to Kotlin
MichaelGHSeg Nov 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions src/connections/sources/catalog/libraries/mobile/apple/index.md
View file
Open in desktop
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).

8 changes: 8 additions & 0 deletions src/connections/sources/catalog/libraries/mobile/kotlin-android/index.md
View file
Open in desktop
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).
Loading