Skip to content

Commit 8e04411

Browse files
committed
Add callouts to other pages
1 parent 2542127 commit 8e04411

File tree

2 files changed

+20
-17
lines changed

2 files changed

+20
-17
lines changed

src/connections/auto-instrumentation/configuration.md

Lines changed: 17 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Signals Implementation Guide
33
hidden: true
44
---
55

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:
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:
77

88
- Setting up and managing signal types in the Signals SDK
99
- 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
1414
> info "Auto-Instrumentation Pilot"
1515
> 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.
1616
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
1821

1922
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.
2023

@@ -75,9 +78,9 @@ function processSignal(signal) {
7578

7679
## Signal definitions
7780

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 Signals Kotlin 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.
7982

80-
### Base Signal
83+
### Base signal
8184

8285
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.
8386

@@ -108,9 +111,9 @@ enum SignalType {
108111
}
109112
```
110113

111-
### Interaction Signals
114+
### Interaction signals
112115

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:
114117

115118
```java
116119
class InteractionData {
@@ -124,9 +127,9 @@ class InteractionSignal extends RawSignal<InteractionData> {
124127
}
125128
```
126129

127-
### Navigation Signals
130+
### Navigation signals
128131

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:
130133

131134
```java
132135
enum NavigationAction {
@@ -140,7 +143,7 @@ enum NavigationAction {
140143
}
141144

142145
class NavigationData {
143-
var action: NavigationAction // The type of navigation action performed
146+
var action: NavigationAction // The type of navigation action performed.
144147
var screen: String // The screen or component name involved in the navigation.
145148
}
146149

@@ -149,9 +152,9 @@ class NavigationSignal extends RawSignal<NavigationData> {
149152
}
150153
```
151154

152-
### Network Signals
155+
### Network signals
153156

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:
155158

156159
```java
157160
enum NetworkAction {
@@ -171,7 +174,7 @@ class NetworkSignal extends RawSignal<NetworkData> {
171174
}
172175
```
173176

174-
### LocalData Signals
177+
### Local Data signals
175178

176179
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:
177180

@@ -195,7 +198,7 @@ class LocalDataSignal extends RawSignal<LocalData> {
195198
}
196199
```
197200

198-
### Instrumentation Signals
201+
### Instrumentation signals
199202

200203
The SDK collects Instrumentation Signals when [traditional Segment analytics events](/docs/connections/spec/) are invoked:
201204

@@ -219,7 +222,7 @@ class InstrumentationSignal extends RawSignal<InstrumentationData> {
219222
}
220223
```
221224

222-
### User-Defined Signals
225+
### User-defined signals
223226

224227
You can also define your own signals. Use the following example as an implementation guideline:
225228

src/connections/auto-instrumentation/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,14 +25,14 @@ Some Auto-Instrumentation advantages include:
2525

2626
- **JavaScript-based instrumentation logic**: Configure and refine your instrumentation logic entirely within JavaScript, simplifying the development process and reducing dependencies on other environments.
2727
- **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.
2929

3030
## How it works
3131

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.
3333

3434
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.
3535

3636
## Privacy
3737

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

Comments
 (0)