You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/connections/auto-instrumentation/swift-setup.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,14 +5,14 @@ hidden: true
5
5
6
6
This guide outlines the steps required to set up the Signals SDK in your Apple OS applications using Swift.
7
7
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.
8
+
Learn how to connect an existing source, integrate dependencies, turn on Auto-Instrumentation, and verify that your setup captures and processes data as intended.
9
9
10
-
> info "Public Beta"
10
+
> info "Auto-Instrumentation in public beta"
11
11
> Auto-Instrumentation is in public beta, and Segment is actively working on this feature. Some functionality may change before it becomes generally available.
12
12
13
13
## Step 1: Get your source write key
14
14
15
-
You need the `writeKey` from an existing Segment source:
15
+
You need the `writeKey` from an existing Segment source. To find it:
16
16
17
17
1. In your Segment workspace, go to **Connections > Sources**.
18
18
2. Select your source.
@@ -21,7 +21,7 @@ You need the `writeKey` from an existing Segment source:
21
21
22
22
## Step 2: Add dependencies and initialization code
23
23
24
-
Next, you'll need to add the Signals SDKs to your Swift applicatiion.
24
+
Next, add the Signals SDKs to your Swift applicatiion.
25
25
26
26
1. Use Swift Package Manager to add the Signals SDK from the following repository:
27
27
@@ -55,11 +55,11 @@ Next, you'll need to add the Signals SDKs to your Swift applicatiion.
55
55
Analytics.main.add(plugin: Signals.shared)
56
56
```
57
57
58
-
Verify that you replaced `<WRITE_KEY>` with the actual write key you copied in Step 1.
58
+
Verify that you replaced `<WRITE_KEY>` with the actual write key you copied in[Step 1](#step-1-get-your-source-write-key).
59
59
60
60
#### SwiftUI projects
61
61
62
-
If your app is written in SwiftUI, you'll need to add a `TypeAlias.swift` file to your project that captures interaction and navigation Signals, like in this example:
62
+
If your app is written in SwiftUI, you need to add a `TypeAlias.swift` file to your project that captures interaction and navigation Signals, like in this example:
63
63
64
64
```swift
65
65
import Foundation
@@ -93,7 +93,7 @@ After integrating the SDK and running your app, verify that Segment is collectin
93
93
4. Use the app as a user would: navigate between screens, tap buttons, trigger network requests. Signals appear in real time as you interact with the app.
94
94
5. In the Event Builder, find a signal and click **Configure event** to define a new event. After configuring the event, click **Publish event rules**.
95
95
96
-
## Configuration Options
96
+
## Configuration options
97
97
98
98
Using the Signals Configuration object, you can control the destination, frequency, and types of signals that Segment automatically tracks within your application. The following table details the configuration options for Signals-Swift.
0 commit comments