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
This guide is a reference to configuring and using signals in the Signals SDK with Auto-Instrumentation. On this page, you'll find details on:
6
+
This guide is a reference to configuring and using signals in the Signals SDK with Auto-Instrumentation. On this page, you'll find details on:
7
7
8
8
- Setting up and managing signal types in the Signals SDK
9
9
- Creating custom rules to capture and translate signals into actionable analytics events
@@ -14,7 +14,10 @@ This guide assumes that you've already added the Signals SDK to your application
14
14
> info "Auto-Instrumentation Pilot"
15
15
> Auto-Instrumentation is currently in pilot and is governed by Segment's [First Access and Beta Preview Terms](https://www.twilio.com/en-us/legal/tos){:target="_blank"}. Segment doesn't recommend Auto-Instrumentation for use in a production environment, as Segment is actively iterating on and improving the user experience.
16
16
17
-
## Signals Configuration
17
+
> success "Enable Auto-Instrumentation"
18
+
> To enable Auto-Instrumentation in your Segment workspace, reach out to your dedicated account manager.
19
+
20
+
## Signals configuration
18
21
19
22
Using the Signals Configuration object, you can control the destination, frequency, and types of signals that Segment automatically tracks within your application. The following tables detail the configuration options for both Signals-Swift and Signals-Kotlin.
20
23
@@ -75,9 +78,9 @@ function processSignal(signal) {
75
78
76
79
## Signal definitions
77
80
78
-
Signals come in various types, each associated with specific data that you can use to create analytics events. This section contains code samples that detail each signal type. Because Segment has standardized these definitions across both the Signals-Swift and SignalsKotlin libraries, they're useful when you create rules in your Segment workspace.
81
+
Signals come in various types, each associated with specific data that you can use to create analytics events. This section contains code samples that detail each signal type. Because Segment has standardized these definitions across both the Signals-Swift and Signals-Kotlin libraries, they're useful when you create rules in your Segment workspace.
79
82
80
-
### Base Signal
83
+
### Base signal
81
84
82
85
The Base Signal serves as the foundation for all other signal types. It's defined by the `RawSignal<T>` interface, where `T` represents the data type associated with the signal.
83
86
@@ -108,9 +111,9 @@ enum SignalType {
108
111
}
109
112
```
110
113
111
-
### Interaction Signals
114
+
### Interaction signals
112
115
113
-
The SDK collects Interaction Signals when you enable one of the "UI autoSignal" options, like `useSwiftUIAutoSignal: true`. These signals primarily track user interactions with UI components:
116
+
The SDK collects Interaction signals when you enable one of the `UIAutoSignal` options, like `useSwiftUIAutoSignal: true`. These signals primarily track user interactions with UI components:
114
117
115
118
```java
116
119
classInteractionData {
@@ -124,9 +127,9 @@ class InteractionSignal extends RawSignal<InteractionData> {
124
127
}
125
128
```
126
129
127
-
### Navigation Signals
130
+
### Navigation signals
128
131
129
-
The SDK collects Navigation Signals when you enable one of the "UI autoSignal" options, like `useSwiftUIAutoSignal: true`. These signals are generated when a user interacts with navigation components in your application's UI, giving you insight into how users move through and interact with your application:
132
+
The SDK collects Navigation signals when you enable one of the `UIAutoSignal` options, like `useSwiftUIAutoSignal: true`. These signals are generated when a user interacts with navigation components in your application's UI, giving you insight into how users move through and interact with your application:
130
133
131
134
```java
132
135
enumNavigationAction {
@@ -140,7 +143,7 @@ enum NavigationAction {
140
143
}
141
144
142
145
classNavigationData {
143
-
var action:NavigationAction// The type of navigation action performed
146
+
var action:NavigationAction// The type of navigation action performed.
144
147
var screen:String// The screen or component name involved in the navigation.
145
148
}
146
149
@@ -149,9 +152,9 @@ class NavigationSignal extends RawSignal<NavigationData> {
149
152
}
150
153
```
151
154
152
-
### Network Signals
155
+
### Network signals
153
156
154
-
The SDK collects Network Signals when you enable the `useNetworkAutoSignal` option in your Signals Configuration, like `useNetworkAutoSignal: true`. These signals are generated when your application makes network requests:
157
+
The SDK collects Network signals when you enable the `useNetworkAutoSignal` option in your Signals Configuration, like `useNetworkAutoSignal: true`. These signals are generated when your application makes network requests:
155
158
156
159
```java
157
160
enumNetworkAction {
@@ -171,7 +174,7 @@ class NetworkSignal extends RawSignal<NetworkData> {
171
174
}
172
175
```
173
176
174
-
### LocalData Signals
177
+
### Local Data signals
175
178
176
179
The SDK collects Local Data Signals when data gets loaded from local soures, like SQLite databases or local caches. These signals help track how your application manages local data:
177
180
@@ -195,7 +198,7 @@ class LocalDataSignal extends RawSignal<LocalData> {
195
198
}
196
199
```
197
200
198
-
### Instrumentation Signals
201
+
### Instrumentation signals
199
202
200
203
The SDK collects Instrumentation Signals when [traditional Segment analytics events](/docs/connections/spec/) are invoked:
201
204
@@ -219,7 +222,7 @@ class InstrumentationSignal extends RawSignal<InstrumentationData> {
219
222
}
220
223
```
221
224
222
-
### User-Defined Signals
225
+
### User-defined signals
223
226
224
227
You can also define your own signals. Use the following example as an implementation guideline:
Copy file name to clipboardExpand all lines: src/connections/auto-instrumentation/index.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -25,14 +25,14 @@ Some Auto-Instrumentation advantages include:
25
25
26
26
-**JavaScript-based instrumentation logic**: Configure and refine your instrumentation logic entirely within JavaScript, simplifying the development process and reducing dependencies on other environments.
27
27
-**Rapid iteration**: Update your instrumentation logic without the need to constantly release new versions of your mobile app, enabling faster iterations and improvements.
28
-
-**Bypass update delays**: Avoid the typical delays associated with app update cycles and app store approvals. Auto-instrumentation lets you update your tracking setups or fix errors immediately, ensuring your data collection remains accurate and timely.
28
+
-**Bypass update delays**: Avoid the typical delays associated with app update cycles and app store approvals. Auto-Instrumentation lets you update your tracking setups or fix errors immediately, ensuring your data collection remains accurate and timely.
29
29
30
30
## How it works
31
31
32
-
After you [integrate the Analytics SDK and Signals SDK into your application](/docs/connections/auto-instrumentation/setup/), Segment begins to passively monitor user activity like button clicks, page navigation, and network data. Segment captures these events as "Signals" and sends them to your Auto-Instrumentation source in real time.
32
+
After you [integrate the Analytics SDK and Signals SDK into your application](/docs/connections/auto-instrumentation/setup/), Segment begins to passively monitor user activity like button clicks, page navigation, and network data. Segment captures these events as "signals" and sends them to your Auto-Instrumentation source in real time.
33
33
34
34
In Segment, the Auto-Instrumentation source lets you view raw signals. You can then [use this data to create detailed analytics events](/docs/connections/auto-instrumentation/configuration/) based on those signals, enriching your insights into user behavior and applicatino performance.
35
35
36
36
## Privacy
37
37
38
-
Auto-Instrumentation ensures that any personally identifiable information (PII) is removed from breadcrumbs before they get sent to Segment. No user data is visible to Segment.
38
+
Auto-Instrumentation removes personally identifiable information (PII) from breadcrumbs before they get sent to Segment. No user data is visible to Segment.
0 commit comments