From 1c313644deb440b127e0e0359d79addcc22616be Mon Sep 17 00:00:00 2001 From: pwseg Date: Thu, 2 Oct 2025 12:56:53 -0500 Subject: [PATCH 1/8] move steps around --- .../auto-instrumentation/web-setup.md | 31 ++++++++----------- 1 file changed, 13 insertions(+), 18 deletions(-) diff --git a/src/connections/auto-instrumentation/web-setup.md b/src/connections/auto-instrumentation/web-setup.md index e82e57e256..5457a3dc2b 100644 --- a/src/connections/auto-instrumentation/web-setup.md +++ b/src/connections/auto-instrumentation/web-setup.md @@ -5,31 +5,22 @@ hidden: true This guide outlines the steps required to set up the Signals SDK in your JavaScript website. -You'll learn how to add Auto-Instrumentation sources, integrate dependencies, and ensure that your setup captures and processes data as intended. +You'll learn how to use an existing Segment source, integrate dependencies, turn on Auto-Instrumentation, and verify that your setup captures and processes data as intended. > info "Auto-Instrumentation Private Beta" > Auto-Instrumentation is currently in Private Beta and is governed by Segment's [First Access and Beta Preview Terms](https://www.twilio.com/en-us/legal/tos){:target="_blank"}. Segment is actively iterating on and improving the Auto-Instrumentation user experience. > success "Enable Auto-Instrumentation" -> To enable Auto-Instrumentation in your Segment workspace, reach out to your dedicated account manager. +> To turn on Auto-Instrumentation in your Segment workspace, reach out to your dedicated account manager. -## Step 1: Add or enable a source and get its write key +## Step 1: Get your source write key -You can either create a new source or turn on Auto-Instrumentation for an existing source. Both methods let you retrieve the `writeKey` that you’ll need later. +You’ll need the `writeKey` from an existing Segment source: -### Create a new source - -1. In your Segment workspace, navigate to **Connections > Auto-Instrumentation**. -2. Select **Add source**, give the source a name, and click **Save**. -3. Return to **Connections > Sources** and select the new source you just set up. -4. In the **Initialize the Client** section, copy the `writeKey` shown in the code block. - -### Enable Auto-Instrumentation on an existing source - -If you want to use an existing source, copy its `writeKey` from **Initialize the client**. After you install the SDK (Step 2), return to the source settings to turn on Auto-Instrumentation: - -- **Web:** **Connections > Sources > [source] > Settings > Analytics.js > Auto-Instrumentation** and toggle it on. -- **Mobile:** **Connections > Sources > [source] > Settings > Advanced > Auto-Instrumentation** and toggle it on. +1. In your Segment workspace, go to to **Connections > Sources**. +2. Select your source. +3. From the source's overview tab, go to **Settings > API Keys**. +4. Copy the `writeKey` shown in the code block. ## Step 2: Add dependencies and initialization code @@ -198,7 +189,11 @@ Verify that you only have **one snippet** in your site, then move to [Step 3: Ve 3. Build and run your app. -## Step 3: Verify and deploy events +## Step 3: Enable Auto-Instrumentation in your source + + + +## Step 4: Verify and deploy events After integrating the SDK and running your app, verify that Segment is collecting signals: From 66793b794369b86f2816c85931f8962c1ce6ba9a Mon Sep 17 00:00:00 2001 From: pwseg Date: Thu, 2 Oct 2025 13:01:37 -0500 Subject: [PATCH 2/8] update web instructions --- src/connections/auto-instrumentation/web-setup.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/src/connections/auto-instrumentation/web-setup.md b/src/connections/auto-instrumentation/web-setup.md index 5457a3dc2b..3048d5af92 100644 --- a/src/connections/auto-instrumentation/web-setup.md +++ b/src/connections/auto-instrumentation/web-setup.md @@ -17,7 +17,7 @@ You'll learn how to use an existing Segment source, integrate dependencies, turn You’ll need the `writeKey` from an existing Segment source: -1. In your Segment workspace, go to to **Connections > Sources**. +1. In your Segment workspace, go to **Connections > Sources**. 2. Select your source. 3. From the source's overview tab, go to **Settings > API Keys**. 4. Copy the `writeKey` shown in the code block. @@ -189,15 +189,20 @@ Verify that you only have **one snippet** in your site, then move to [Step 3: Ve 3. Build and run your app. -## Step 3: Enable Auto-Instrumentation in your source +## Step 3: Turn on Auto-Instrumentation in your source +Next, return to the source settings to turn on Auto-Instrumentation: +1. Go to **Connections > Sources**. +2. Select your source you used in Step 1. +3. From the source's overview tab, go to **Settings > Analytics.js**. +4. Toggle Auto-Instrumention on. ## Step 4: Verify and deploy events After integrating the SDK and running your app, verify that Segment is collecting signals: -1. In your Segment workspace, return to **Connections > Sources**, then select the source you created for Auto-Instrumentation. +1. In your Segment workspace, return to **Connections > Sources**, then select the source you used for Auto-Instrumentation. 2. In the source overview, look for the **Event Builder** tab. If the tab doesn’t appear: - Make sure you've installed the SDK correctly. - Reach out to your Segment CSM to confirm that your workspace has the necessary feature flags enabled. From d57e76325a148a82e03e95fc4677a0b7d78888dc Mon Sep 17 00:00:00 2001 From: pwseg Date: Thu, 2 Oct 2025 13:03:47 -0500 Subject: [PATCH 3/8] update Swift instructions --- .../auto-instrumentation/swift-setup.md | 23 ++++++------------- .../auto-instrumentation/web-setup.md | 2 +- 2 files changed, 8 insertions(+), 17 deletions(-) diff --git a/src/connections/auto-instrumentation/swift-setup.md b/src/connections/auto-instrumentation/swift-setup.md index 844f4b28e9..8980457cac 100644 --- a/src/connections/auto-instrumentation/swift-setup.md +++ b/src/connections/auto-instrumentation/swift-setup.md @@ -5,7 +5,7 @@ hidden: true This guide outlines the steps required to set up the Signals SDK in your Apple OS applications using Swift. -You'll learn how to add Auto-Instrumentation sources, integrate dependencies, and ensure that your setup captures and processes data as intended. +You'll learn how to connect an existing source, integrate dependencies, turn on Auto-Instrumentation, and verify that your setup captures and processes data as intended. > info "Auto-Instrumentation Private Beta" > Auto-Instrumentation is currently in Private Beta and is governed by Segment's [First Access and Beta Preview Terms](https://www.twilio.com/en-us/legal/tos){:target="_blank"}. Segment is actively iterating on and improving the Auto-Instrumentation user experience. @@ -13,23 +13,14 @@ You'll learn how to add Auto-Instrumentation sources, integrate dependencies, an > success "Enable Auto-Instrumentation" > To enable Auto-Instrumentation in your Segment workspace, reach out to your dedicated account manager. -## Step 1: Add or enable a source and get its write key +## Step 1: Get your source write key -You can either create a new source or turn on Auto-Instrumentation for an existing source. Both methods let you retrieve the `writeKey` that you’ll need later. +You’ll need the `writeKey` from an existing Segment source: -### Create a new source - -1. In your Segment workspace, navigate to **Connections > Auto-Instrumentation**. -2. Select **Add source**, give the source a name, and click **Save**. -3. Return to **Connections > Sources** and select the new source you just set up. -4. In the **Initialize the Client** section, copy the `writeKey` shown in the code block. - -### Enable Auto-Instrumentation on an existing source - -If you want to use an existing source, copy its `writeKey` from **Initialize the Client**. After you install the SDK (Step 2), return to the source settings to turn on Auto-Instrumentation: - -- **Web:** **Connections > Sources > [source] > Settings > Analytics.js > Auto-Instrumentation** and toggle it on. -- **Mobile:** **Connections > Sources > [source] > Settings > Advanced > Auto-Instrumentation** and toggle it on. +1. In your Segment workspace, go to **Connections > Sources**. +2. Select your source. +3. From the source's overview tab, go to **Settings > API Keys**. +4. Copy the `writeKey` shown in the code block. ## Step 2: Add dependencies and initialization code diff --git a/src/connections/auto-instrumentation/web-setup.md b/src/connections/auto-instrumentation/web-setup.md index 3048d5af92..2db27fdda6 100644 --- a/src/connections/auto-instrumentation/web-setup.md +++ b/src/connections/auto-instrumentation/web-setup.md @@ -5,7 +5,7 @@ hidden: true This guide outlines the steps required to set up the Signals SDK in your JavaScript website. -You'll learn how to use an existing Segment source, integrate dependencies, turn on Auto-Instrumentation, and verify that your setup captures and processes data as intended. +You'll learn how to connect an existing source, integrate dependencies, turn on Auto-Instrumentation, and verify that your setup captures and processes data as intended. > info "Auto-Instrumentation Private Beta" > Auto-Instrumentation is currently in Private Beta and is governed by Segment's [First Access and Beta Preview Terms](https://www.twilio.com/en-us/legal/tos){:target="_blank"}. Segment is actively iterating on and improving the Auto-Instrumentation user experience. From f9f5659c53666bec2383f48982839e8a09d97016 Mon Sep 17 00:00:00 2001 From: pwseg Date: Thu, 2 Oct 2025 13:07:29 -0500 Subject: [PATCH 4/8] final Swift cleanup --- .../auto-instrumentation/swift-setup.md | 16 +++++++++++++--- .../auto-instrumentation/web-setup.md | 4 ++-- 2 files changed, 15 insertions(+), 5 deletions(-) diff --git a/src/connections/auto-instrumentation/swift-setup.md b/src/connections/auto-instrumentation/swift-setup.md index 8980457cac..da91fcd02b 100644 --- a/src/connections/auto-instrumentation/swift-setup.md +++ b/src/connections/auto-instrumentation/swift-setup.md @@ -11,7 +11,7 @@ You'll learn how to connect an existing source, integrate dependencies, turn on > Auto-Instrumentation is currently in Private Beta and is governed by Segment's [First Access and Beta Preview Terms](https://www.twilio.com/en-us/legal/tos){:target="_blank"}. Segment is actively iterating on and improving the Auto-Instrumentation user experience. > success "Enable Auto-Instrumentation" -> To enable Auto-Instrumentation in your Segment workspace, reach out to your dedicated account manager. +> To turn Auto-Instrumentation on in your Segment workspace, reach out to your dedicated account manager. ## Step 1: Get your source write key @@ -74,11 +74,21 @@ typealias NavigationLink = SignalNavigationLink typealias TextField = SignalTextField typealias SecureField = SignalSecureField ``` -## Step 3: Verify and deploy events + +## Step 3: Turn on Auto-Instrumentation in your source + +Next, return to the source settings to turn on Auto-Instrumentation: + +1. Go to **Connections > Sources**. +2. Select your source you used in Step 1. +3. From the source's overview tab, go to **Settings > Advanced**. +4. Toggle Auto-Instrumention on. + +## Step 4: Verify and deploy events After integrating the SDK and running your app, verify that Segment is collecting signals: -1. In your Segment workspace, go to **Connections > Sources** and select the source you created for Auto-Instrumentation. +1. In your Segment workspace, go to **Connections > Sources** and select the source you used for Auto-Instrumentation. 2. In the source overview, look for the **Event Builder** tab. If the tab doesn’t appear: - Make sure you've installed the SDK correctly. - Reach out to your Segment CSM to confirm that your workspace has the necessary feature flags enabled. diff --git a/src/connections/auto-instrumentation/web-setup.md b/src/connections/auto-instrumentation/web-setup.md index 2db27fdda6..4f7ab1f406 100644 --- a/src/connections/auto-instrumentation/web-setup.md +++ b/src/connections/auto-instrumentation/web-setup.md @@ -11,7 +11,7 @@ You'll learn how to connect an existing source, integrate dependencies, turn on > Auto-Instrumentation is currently in Private Beta and is governed by Segment's [First Access and Beta Preview Terms](https://www.twilio.com/en-us/legal/tos){:target="_blank"}. Segment is actively iterating on and improving the Auto-Instrumentation user experience. > success "Enable Auto-Instrumentation" -> To turn on Auto-Instrumentation in your Segment workspace, reach out to your dedicated account manager. +> To turn Auto-Instrumentation on in your Segment workspace, reach out to your dedicated account manager. ## Step 1: Get your source write key @@ -202,7 +202,7 @@ Next, return to the source settings to turn on Auto-Instrumentation: After integrating the SDK and running your app, verify that Segment is collecting signals: -1. In your Segment workspace, return to **Connections > Sources**, then select the source you used for Auto-Instrumentation. +1. In your Segment workspace, go to **Connections > Sources** and select the source you used for Auto-Instrumentation. 2. In the source overview, look for the **Event Builder** tab. If the tab doesn’t appear: - Make sure you've installed the SDK correctly. - Reach out to your Segment CSM to confirm that your workspace has the necessary feature flags enabled. From 5a721fb4de77de31fe4d998faa8dd0e1f9671598 Mon Sep 17 00:00:00 2001 From: pwseg Date: Thu, 2 Oct 2025 13:11:11 -0500 Subject: [PATCH 5/8] wording update --- src/connections/auto-instrumentation/swift-setup.md | 2 +- src/connections/auto-instrumentation/web-setup.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/src/connections/auto-instrumentation/swift-setup.md b/src/connections/auto-instrumentation/swift-setup.md index da91fcd02b..ec74798f43 100644 --- a/src/connections/auto-instrumentation/swift-setup.md +++ b/src/connections/auto-instrumentation/swift-setup.md @@ -80,7 +80,7 @@ typealias SecureField = SignalSecureField Next, return to the source settings to turn on Auto-Instrumentation: 1. Go to **Connections > Sources**. -2. Select your source you used in Step 1. +2. Select the source you used in Step 1. 3. From the source's overview tab, go to **Settings > Advanced**. 4. Toggle Auto-Instrumention on. diff --git a/src/connections/auto-instrumentation/web-setup.md b/src/connections/auto-instrumentation/web-setup.md index 4f7ab1f406..38b33ea154 100644 --- a/src/connections/auto-instrumentation/web-setup.md +++ b/src/connections/auto-instrumentation/web-setup.md @@ -194,7 +194,7 @@ Verify that you only have **one snippet** in your site, then move to [Step 3: Ve Next, return to the source settings to turn on Auto-Instrumentation: 1. Go to **Connections > Sources**. -2. Select your source you used in Step 1. +2. Select the source you used in Step 1. 3. From the source's overview tab, go to **Settings > Analytics.js**. 4. Toggle Auto-Instrumention on. From 4a248d10680512caec2e5d5ab8137d02cab8894c Mon Sep 17 00:00:00 2001 From: pwseg <86626706+pwseg@users.noreply.github.com> Date: Thu, 2 Oct 2025 13:14:02 -0500 Subject: [PATCH 6/8] Update src/connections/auto-instrumentation/swift-setup.md Co-authored-by: stayseesong <83784848+stayseesong@users.noreply.github.com> --- src/connections/auto-instrumentation/swift-setup.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/connections/auto-instrumentation/swift-setup.md b/src/connections/auto-instrumentation/swift-setup.md index ec74798f43..d3b67f7077 100644 --- a/src/connections/auto-instrumentation/swift-setup.md +++ b/src/connections/auto-instrumentation/swift-setup.md @@ -15,7 +15,7 @@ You'll learn how to connect an existing source, integrate dependencies, turn on ## Step 1: Get your source write key -You’ll need the `writeKey` from an existing Segment source: +You need the `writeKey` from an existing Segment source: 1. In your Segment workspace, go to **Connections > Sources**. 2. Select your source. From 4bf64f70437481c97cab2c62adfadc08c3725e28 Mon Sep 17 00:00:00 2001 From: pwseg <86626706+pwseg@users.noreply.github.com> Date: Thu, 2 Oct 2025 13:14:11 -0500 Subject: [PATCH 7/8] Update src/connections/auto-instrumentation/web-setup.md Co-authored-by: stayseesong <83784848+stayseesong@users.noreply.github.com> --- src/connections/auto-instrumentation/web-setup.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/connections/auto-instrumentation/web-setup.md b/src/connections/auto-instrumentation/web-setup.md index 38b33ea154..45d32769cc 100644 --- a/src/connections/auto-instrumentation/web-setup.md +++ b/src/connections/auto-instrumentation/web-setup.md @@ -15,7 +15,7 @@ You'll learn how to connect an existing source, integrate dependencies, turn on ## Step 1: Get your source write key -You’ll need the `writeKey` from an existing Segment source: +You need the `writeKey` from an existing Segment source: 1. In your Segment workspace, go to **Connections > Sources**. 2. Select your source. From 653fcd4095e25860f87c884dd1eaf073de50b877 Mon Sep 17 00:00:00 2001 From: pwseg Date: Thu, 2 Oct 2025 13:16:30 -0500 Subject: [PATCH 8/8] change access alert --- src/connections/auto-instrumentation/kotlin-setup.md | 4 ++-- src/connections/auto-instrumentation/swift-setup.md | 2 +- src/connections/auto-instrumentation/web-setup.md | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/src/connections/auto-instrumentation/kotlin-setup.md b/src/connections/auto-instrumentation/kotlin-setup.md index b20770bc98..8e0b7f1a4c 100644 --- a/src/connections/auto-instrumentation/kotlin-setup.md +++ b/src/connections/auto-instrumentation/kotlin-setup.md @@ -10,8 +10,8 @@ This guide shows how to install and configure the library, as well as how to ena > info "Auto-Instrumentation Private Beta" > Auto-Instrumentation is currently in Private Beta and is governed by Segment's [First Access and Beta Preview Terms](https://www.twilio.com/en-us/legal/tos){:target="_blank"}. Segment is actively iterating on and improving the Auto-Instrumentation user experience. -> success "Enable Auto-Instrumentation" -> To enable Auto-Instrumentation in your Segment workspace, reach out to your dedicated account manager. +> success "Auto-Instrumentation access" +> To turn Auto-Instrumentation on in your Segment workspace, reach out to your dedicated account manager. ## Before you begin diff --git a/src/connections/auto-instrumentation/swift-setup.md b/src/connections/auto-instrumentation/swift-setup.md index d3b67f7077..a9be151a6b 100644 --- a/src/connections/auto-instrumentation/swift-setup.md +++ b/src/connections/auto-instrumentation/swift-setup.md @@ -10,7 +10,7 @@ You'll learn how to connect an existing source, integrate dependencies, turn on > info "Auto-Instrumentation Private Beta" > Auto-Instrumentation is currently in Private Beta and is governed by Segment's [First Access and Beta Preview Terms](https://www.twilio.com/en-us/legal/tos){:target="_blank"}. Segment is actively iterating on and improving the Auto-Instrumentation user experience. -> success "Enable Auto-Instrumentation" +> success "Auto-Instrumentation access" > To turn Auto-Instrumentation on in your Segment workspace, reach out to your dedicated account manager. ## Step 1: Get your source write key diff --git a/src/connections/auto-instrumentation/web-setup.md b/src/connections/auto-instrumentation/web-setup.md index 45d32769cc..0eb531cd9d 100644 --- a/src/connections/auto-instrumentation/web-setup.md +++ b/src/connections/auto-instrumentation/web-setup.md @@ -10,7 +10,7 @@ You'll learn how to connect an existing source, integrate dependencies, turn on > info "Auto-Instrumentation Private Beta" > Auto-Instrumentation is currently in Private Beta and is governed by Segment's [First Access and Beta Preview Terms](https://www.twilio.com/en-us/legal/tos){:target="_blank"}. Segment is actively iterating on and improving the Auto-Instrumentation user experience. -> success "Enable Auto-Instrumentation" +> success "Auto-Instrumentation access" > To turn Auto-Instrumentation on in your Segment workspace, reach out to your dedicated account manager. ## Step 1: Get your source write key