Skip to content

Commit 135f6df

Browse files
authored
Merge pull request #8002 from segmentio/more-auto-instrumentation-fixes
Update Auto-Instrumentation setup flow to use existing sources
2 parents 3291e68 + 653fcd4 commit 135f6df

File tree

3 files changed

+43
-42
lines changed

3 files changed

+43
-42
lines changed

src/connections/auto-instrumentation/kotlin-setup.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ This guide shows how to install and configure the library, as well as how to ena
1010
> info "Auto-Instrumentation Private Beta"
1111
> 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.
1212
13-
> success "Enable Auto-Instrumentation"
14-
> To enable Auto-Instrumentation in your Segment workspace, reach out to your dedicated account manager.
13+
> success "Auto-Instrumentation access"
14+
> To turn Auto-Instrumentation on in your Segment workspace, reach out to your dedicated account manager.
1515
1616
## Before you begin
1717

src/connections/auto-instrumentation/swift-setup.md

Lines changed: 21 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -5,31 +5,22 @@ hidden: true
55

66
This guide outlines the steps required to set up the Signals SDK in your Apple OS applications using Swift.
77

8-
You'll learn how to add Auto-Instrumentation sources, integrate dependencies, and ensure that your setup captures and processes data as intended.
8+
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.
99

1010
> info "Auto-Instrumentation Private Beta"
1111
> 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.
1212
13-
> success "Enable Auto-Instrumentation"
14-
> To enable Auto-Instrumentation in your Segment workspace, reach out to your dedicated account manager.
13+
> success "Auto-Instrumentation access"
14+
> To turn Auto-Instrumentation on in your Segment workspace, reach out to your dedicated account manager.
1515
16-
## Step 1: Add or enable a source and get its write key
16+
## Step 1: Get your source write key
1717

18-
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.
18+
You need the `writeKey` from an existing Segment source:
1919

20-
### Create a new source
21-
22-
1. In your Segment workspace, navigate to **Connections > Auto-Instrumentation**.
23-
2. Select **Add source**, give the source a name, and click **Save**.
24-
3. Return to **Connections > Sources** and select the new source you just set up.
25-
4. In the **Initialize the Client** section, copy the `writeKey` shown in the code block.
26-
27-
### Enable Auto-Instrumentation on an existing source
28-
29-
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:
30-
31-
- **Web:** **Connections > Sources > [source] > Settings > Analytics.js > Auto-Instrumentation** and toggle it on.
32-
- **Mobile:** **Connections > Sources > [source] > Settings > Advanced > Auto-Instrumentation** and toggle it on.
20+
1. In your Segment workspace, go to **Connections > Sources**.
21+
2. Select your source.
22+
3. From the source's overview tab, go to **Settings > API Keys**.
23+
4. Copy the `writeKey` shown in the code block.
3324

3425
## Step 2: Add dependencies and initialization code
3526

@@ -83,11 +74,21 @@ typealias NavigationLink = SignalNavigationLink
8374
typealias TextField = SignalTextField
8475
typealias SecureField = SignalSecureField
8576
```
86-
## Step 3: Verify and deploy events
77+
78+
## Step 3: Turn on Auto-Instrumentation in your source
79+
80+
Next, return to the source settings to turn on Auto-Instrumentation:
81+
82+
1. Go to **Connections > Sources**.
83+
2. Select the source you used in Step 1.
84+
3. From the source's overview tab, go to **Settings > Advanced**.
85+
4. Toggle Auto-Instrumention on.
86+
87+
## Step 4: Verify and deploy events
8788

8889
After integrating the SDK and running your app, verify that Segment is collecting signals:
8990

90-
1. In your Segment workspace, go to **Connections > Sources** and select the source you created for Auto-Instrumentation.
91+
1. In your Segment workspace, go to **Connections > Sources** and select the source you used for Auto-Instrumentation.
9192
2. In the source overview, look for the **Event Builder** tab. If the tab doesn’t appear:
9293
- Make sure you've installed the SDK correctly.
9394
- Reach out to your Segment CSM to confirm that your workspace has the necessary feature flags enabled.

src/connections/auto-instrumentation/web-setup.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -5,31 +5,22 @@ hidden: true
55

66
This guide outlines the steps required to set up the Signals SDK in your JavaScript website.
77

8-
You'll learn how to add Auto-Instrumentation sources, integrate dependencies, and ensure that your setup captures and processes data as intended.
8+
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.
99

1010
> info "Auto-Instrumentation Private Beta"
1111
> 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.
1212
13-
> success "Enable Auto-Instrumentation"
14-
> To enable Auto-Instrumentation in your Segment workspace, reach out to your dedicated account manager.
13+
> success "Auto-Instrumentation access"
14+
> To turn Auto-Instrumentation on in your Segment workspace, reach out to your dedicated account manager.
1515
16-
## Step 1: Add or enable a source and get its write key
16+
## Step 1: Get your source write key
1717

18-
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.
18+
You need the `writeKey` from an existing Segment source:
1919

20-
### Create a new source
21-
22-
1. In your Segment workspace, navigate to **Connections > Auto-Instrumentation**.
23-
2. Select **Add source**, give the source a name, and click **Save**.
24-
3. Return to **Connections > Sources** and select the new source you just set up.
25-
4. In the **Initialize the Client** section, copy the `writeKey` shown in the code block.
26-
27-
### Enable Auto-Instrumentation on an existing source
28-
29-
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:
30-
31-
- **Web:** **Connections > Sources > [source] > Settings > Analytics.js > Auto-Instrumentation** and toggle it on.
32-
- **Mobile:** **Connections > Sources > [source] > Settings > Advanced > Auto-Instrumentation** and toggle it on.
20+
1. In your Segment workspace, go to **Connections > Sources**.
21+
2. Select your source.
22+
3. From the source's overview tab, go to **Settings > API Keys**.
23+
4. Copy the `writeKey` shown in the code block.
3324

3425
## Step 2: Add dependencies and initialization code
3526

@@ -198,11 +189,20 @@ Verify that you only have **one snippet** in your site, then move to [Step 3: Ve
198189

199190
3. Build and run your app.
200191

201-
## Step 3: Verify and deploy events
192+
## Step 3: Turn on Auto-Instrumentation in your source
193+
194+
Next, return to the source settings to turn on Auto-Instrumentation:
195+
196+
1. Go to **Connections > Sources**.
197+
2. Select the source you used in Step 1.
198+
3. From the source's overview tab, go to **Settings > Analytics.js**.
199+
4. Toggle Auto-Instrumention on.
200+
201+
## Step 4: Verify and deploy events
202202

203203
After integrating the SDK and running your app, verify that Segment is collecting signals:
204204

205-
1. In your Segment workspace, return to **Connections > Sources**, then select the source you created for Auto-Instrumentation.
205+
1. In your Segment workspace, go to **Connections > Sources** and select the source you used for Auto-Instrumentation.
206206
2. In the source overview, look for the **Event Builder** tab. If the tab doesn’t appear:
207207
- Make sure you've installed the SDK correctly.
208208
- Reach out to your Segment CSM to confirm that your workspace has the necessary feature flags enabled.

0 commit comments

Comments
 (0)