From 422188071bbbcd157f04953adaec0a42dd77aa2f Mon Sep 17 00:00:00 2001 From: Michael Grosse Huelsewiesche Date: Wed, 30 Oct 2024 18:10:39 -0400 Subject: [PATCH 1/8] Adding Telemetry info for Analytics-Swift SDK --- .../sources/catalog/libraries/mobile/apple/index.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/src/connections/sources/catalog/libraries/mobile/apple/index.md b/src/connections/sources/catalog/libraries/mobile/apple/index.md index b57ba18960..ef3e70e994 100644 --- a/src/connections/sources/catalog/libraries/mobile/apple/index.md +++ b/src/connections/sources/catalog/libraries/mobile/apple/index.md @@ -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 +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. + +The Telemetry system can be disabled at any time by setting `Telemetry.shared.enable = false`. + +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`. + ## 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). From ba08ec255440618301e71bb1e96744aa415925a2 Mon Sep 17 00:00:00 2001 From: Michael Grosse Huelsewiesche Date: Fri, 1 Nov 2024 18:43:44 -0400 Subject: [PATCH 2/8] Add mention that event data is not collected --- src/connections/sources/catalog/libraries/mobile/apple/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/connections/sources/catalog/libraries/mobile/apple/index.md b/src/connections/sources/catalog/libraries/mobile/apple/index.md index ef3e70e994..b8034dc617 100644 --- a/src/connections/sources/catalog/libraries/mobile/apple/index.md +++ b/src/connections/sources/catalog/libraries/mobile/apple/index.md @@ -166,7 +166,7 @@ If you proxy your events through the `apiHost` config option, you must forward t > 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 -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. +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 or event data is collected and the information is downsampled to reduce traffic. The Telemetry system can be disabled at any time by setting `Telemetry.shared.enable = false`. From c6da846b9d5bb1400d8338ca7806503e6c2e62f8 Mon Sep 17 00:00:00 2001 From: Michael Grosse Huelsewiesche Date: Tue, 12 Nov 2024 17:05:02 -0500 Subject: [PATCH 3/8] Add Telemetry info for Kotlin --- .../catalog/libraries/mobile/kotlin-android/index.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/src/connections/sources/catalog/libraries/mobile/kotlin-android/index.md b/src/connections/sources/catalog/libraries/mobile/kotlin-android/index.md index fea5f89276..af3cbd2c5e 100644 --- a/src/connections/sources/catalog/libraries/mobile/kotlin-android/index.md +++ b/src/connections/sources/catalog/libraries/mobile/kotlin-android/index.md @@ -203,3 +203,11 @@ Analytics-Kotlin is built with extensibility in mind. Use the tools list below t ## 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). + + +## Telemetry +Telemetry data related to the configuration and usage of the Analytics-Kotlin 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 or event data is collected and the information is downsampled to reduce traffic. + +The Telemetry system can be disabled at any time by setting `Telemetry.enable = false`. + +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.sendWriteKeyOnError = false`. From 7ec508066b125dc7bceda633d1930415467e7f3c Mon Sep 17 00:00:00 2001 From: Michael Grosse Huelsewiesche Date: Tue, 12 Nov 2024 17:07:12 -0500 Subject: [PATCH 4/8] Moving section --- .../catalog/libraries/mobile/kotlin-android/index.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/src/connections/sources/catalog/libraries/mobile/kotlin-android/index.md b/src/connections/sources/catalog/libraries/mobile/kotlin-android/index.md index af3cbd2c5e..053088621d 100644 --- a/src/connections/sources/catalog/libraries/mobile/kotlin-android/index.md +++ b/src/connections/sources/catalog/libraries/mobile/kotlin-android/index.md @@ -201,13 +201,12 @@ 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. -## 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). - - ## Telemetry Telemetry data related to the configuration and usage of the Analytics-Kotlin 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 or event data is collected and the information is downsampled to reduce traffic. The Telemetry system can be disabled at any time by setting `Telemetry.enable = false`. 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.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). From 2ec08cba097be4e1e78fb175e714906ff6379897 Mon Sep 17 00:00:00 2001 From: pwseg <86626706+pwseg@users.noreply.github.com> Date: Thu, 14 Nov 2024 10:28:23 -0600 Subject: [PATCH 5/8] rewording - Analytics-Swift --- .../sources/catalog/libraries/mobile/apple/index.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/connections/sources/catalog/libraries/mobile/apple/index.md b/src/connections/sources/catalog/libraries/mobile/apple/index.md index b8034dc617..abdc0d4b63 100644 --- a/src/connections/sources/catalog/libraries/mobile/apple/index.md +++ b/src/connections/sources/catalog/libraries/mobile/apple/index.md @@ -166,11 +166,11 @@ If you proxy your events through the `apiHost` config option, you must forward t > 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 -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 or event data is collected and the information is downsampled to reduce traffic. +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. No personally identifiable information (PII) or event data is collected, and Segment downsamples the data to minimize traffic. -The Telemetry system can be disabled at any time by setting `Telemetry.shared.enable = false`. +You can disable telemetry at any time by setting `Telemetry.shared.enable = false`. -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`. +When internal errors or errors from plugins occur, the write key may be included with error data to help you 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). From ac34f84fe61aaae08907692b16da37f3f7e3f8b0 Mon Sep 17 00:00:00 2001 From: Michael Grosse Huelsewiesche Date: Thu, 14 Nov 2024 12:55:54 -0500 Subject: [PATCH 6/8] Apply suggestions from code review Co-authored-by: stayseesong <83784848+stayseesong@users.noreply.github.com> --- .../sources/catalog/libraries/mobile/apple/index.md | 2 +- .../catalog/libraries/mobile/kotlin-android/index.md | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/src/connections/sources/catalog/libraries/mobile/apple/index.md b/src/connections/sources/catalog/libraries/mobile/apple/index.md index abdc0d4b63..fbb29431bd 100644 --- a/src/connections/sources/catalog/libraries/mobile/apple/index.md +++ b/src/connections/sources/catalog/libraries/mobile/apple/index.md @@ -166,7 +166,7 @@ If you proxy your events through the `apiHost` config option, you must forward t > 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. No personally identifiable information (PII) or event data is collected, and Segment downsamples the data to minimize traffic. +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`. diff --git a/src/connections/sources/catalog/libraries/mobile/kotlin-android/index.md b/src/connections/sources/catalog/libraries/mobile/kotlin-android/index.md index 053088621d..06d68e88e4 100644 --- a/src/connections/sources/catalog/libraries/mobile/kotlin-android/index.md +++ b/src/connections/sources/catalog/libraries/mobile/kotlin-android/index.md @@ -202,11 +202,11 @@ Analytics-Kotlin is built with extensibility in mind. Use the tools list below t > 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 -Telemetry data related to the configuration and usage of the Analytics-Kotlin 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 or event data is collected and the information is downsampled to reduce traffic. +Telemetry data related to the configuration and usage of the Analytics-Kotlin SDK is collected and sent to Segment by default. This includes some basic configuration information, plugins and event types used, and basic error information. Segment downsamples the data to minimize traffic and doesn't collect any personally identifiable information (PII) or event data. -The Telemetry system can be disabled at any time by setting `Telemetry.enable = false`. +You can disable telemetry at any time by setting `Telemetry.shared.enable = false`. -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.sendWriteKeyOnError = false`. +When internal errors or errors from plugins occur, the writekey may be included with the error data to help customers track down problems. 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). From 30b94f092bb644d386863a84a5f3d8991156ded3 Mon Sep 17 00:00:00 2001 From: Michael Grosse Huelsewiesche Date: Thu, 14 Nov 2024 12:58:21 -0500 Subject: [PATCH 7/8] Clarify writekey usage The writekey data is to help segment identify issues internally, rather than the customer --- src/connections/sources/catalog/libraries/mobile/apple/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/connections/sources/catalog/libraries/mobile/apple/index.md b/src/connections/sources/catalog/libraries/mobile/apple/index.md index fbb29431bd..6a65cb84b5 100644 --- a/src/connections/sources/catalog/libraries/mobile/apple/index.md +++ b/src/connections/sources/catalog/libraries/mobile/apple/index.md @@ -170,7 +170,7 @@ The Analytics-Swift SDK collects telemetry data on configuration and usage by de 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 you identify the issue(s). You can disable this by setting `Telemetry.shared.sendWriteKeyOnError = 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). From c356537ff52424e9edbeeb882054e47226395daa Mon Sep 17 00:00:00 2001 From: Michael Grosse Huelsewiesche Date: Thu, 14 Nov 2024 13:00:49 -0500 Subject: [PATCH 8/8] Bringing over Swift edits to Kotlin --- .../catalog/libraries/mobile/kotlin-android/index.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/src/connections/sources/catalog/libraries/mobile/kotlin-android/index.md b/src/connections/sources/catalog/libraries/mobile/kotlin-android/index.md index 06d68e88e4..26250f0621 100644 --- a/src/connections/sources/catalog/libraries/mobile/kotlin-android/index.md +++ b/src/connections/sources/catalog/libraries/mobile/kotlin-android/index.md @@ -202,11 +202,12 @@ Analytics-Kotlin is built with extensibility in mind. Use the tools list below t > 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 -Telemetry data related to the configuration and usage of the Analytics-Kotlin SDK is collected and sent to Segment by default. This includes some basic configuration information, plugins and event types used, and basic error information. Segment downsamples the data to minimize traffic and doesn't collect any personally identifiable information (PII) or event data. +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.shared.enable = false`. +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`. -When internal errors or errors from plugins occur, the writekey may be included with the error data to help customers track down problems. 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).