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/configuration.md
+3-33Lines changed: 3 additions & 33 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,48 +3,18 @@ title: Generate Events from Signals
3
3
hidden: true
4
4
---
5
5
6
-
This guide is a reference to configuring, generating, and using signals in the Signals SDK with Auto-Instrumentation. On this page, you'll find details on:
6
+
This guide details how to use signals, and their associated data, generated in one of the Signals SDKs with the Auto-Instrumentation dashboard in your Segment workspace. On this page, you'll find details on:
7
7
8
-
- Setting up and managing signal types in the Signals SDK
9
8
- Creating custom rules to capture and translate signals into actionable analytics events
10
9
- Example rules that you can use as a basis for further customization
11
10
12
-
This guide assumes that you've already added the Signals SDK to your application. If you haven't yet, see the [Auto-Instrumentation Setup](/docs/connections/auto-instrumentation/setup/) guide for initial setup.
11
+
This guide assumes that you've already added the Signals SDK to your application. If you haven't yet, see the [Auto-Instrumentation Setup](/docs/connections/auto-instrumentation/) guide for initial setup.
13
12
14
13
> info "Auto-Instrumentation Pilot"
15
14
> 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
15
17
16
> success "Enable Auto-Instrumentation"
18
-
> To enable Auto-Instrumentation in your Segment workspace, reach out to your dedicated account manager.
19
-
20
-
## Signals configuration
21
-
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.
|`maximumBufferSize`| No | Integer | The number of signals to be kept for JavaScript inspection. This buffer is first-in, first-out. Default is `1000`. |
30
-
|`relayCount`| No | Integer | Relays signals to Segment every Xth event. Default is `20`. |
31
-
|`relayInterval`| No | TimeInterval | Relays signals to segment every X seconds. Default is `60`. |
32
-
|`broadcasters`| No |`SignalBroadcaster`| An array of broadcasters. These objects forward signal data to their destinations, like `WebhookBroadcaster` or `DebugBroadcaster` writing to the developer console. Default is `SegmentBroadcaster`. |
33
-
|`useUIKitAutoSignal`| No | Bool | Tracks UIKit component interactions automatically. Default is `false`. |
34
-
|`useSwiftUIAutoSignal`| No | Bool | Tracks SwiftUI component interactions automatically. Default is `false`. |
35
-
|`useNetworkAutoSignal`| No | Bool | Tracks network events automatically. Default is `false`. |
36
-
|`allowedNetworkHosts`| No | Array | An array of allowed network hosts. |
37
-
|`blockedNetworkHosts`| No | Array | An array of blocked network hosts. |
|`maximumBufferSize`| No | Integer | The number of signals to be kept for JavaScript inspection. This buffer is first-in, first-out. Default is `1000`. |
46
-
|`broadcastInterval`| No | Integer | Broadcasts signals to Segment every X event. Default is `60`. |
47
-
|`broadcasters`| No |`List<SignalBroadcaster>`| An array of broadcasters. These objects forward signal data to their destinations, like `WebhookBroadcaster` or `DebugBroadcaster` writing to the developer console. Default is `SegmentBroadcaster`. |
17
+
> To enable Auto-Instrumentation in your Segment workspace, reach out to your dedicated account manager.
Copy file name to clipboardExpand all lines: src/connections/auto-instrumentation/kotlin-setup.md
+16-1Lines changed: 16 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -44,7 +44,10 @@ Next, you'll need to add the Signals SDKs to your Kotlin application.
44
44
}
45
45
```
46
46
47
-
2. Add the following code to your application to initialize the SignalsSDK:
47
+
2. Add the initialization code and configuration options:
48
+
49
+
> success ""
50
+
> see [configuration options](#configuration-options) for a complete list.
48
51
49
52
```kotlin
50
53
// Configure Analytics with your settings
@@ -89,6 +92,18 @@ Next, you'll need to verify signal emission and [create rules](/docs/connections
89
92
90
93
Segment displays `Rule updated successfully` to verify that it saved your rule.
91
94
95
+
## Configuration Options
96
+
97
+
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-Kotlin.
| `maximumBufferSize` | No | Integer | The number of signals to be kept for JavaScript inspection. This buffer is first-in, first-out. Default is `1000`. |
103
+
| `broadcastInterval` | No | Integer | Broadcasts signals to Segment every X event. Default is `60`. |
104
+
| `broadcasters` | No | `List<SignalBroadcaster>` | An array of broadcasters. These objects forward signal data to their destinations, like `WebhookBroadcaster` or `DebugBroadcaster` writing to the developer console. Default is `SegmentBroadcaster`. |
105
+
106
+
92
107
## Next steps
93
108
94
109
This guide walked you through initial Signals SDK/Auto-Instrumentation setup. Next, read the [Auto-Instrumentation Signals Implementation Guide](/docs/connections/auto-instrumentation/configuration/), which dives deeper into Signals and offers examples rules.
Copy file name to clipboardExpand all lines: src/connections/auto-instrumentation/swift-setup.md
+21-1Lines changed: 21 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -33,7 +33,10 @@ Next, you'll need to add the Signals SDKs to your Swift applicatiion.
33
33
https://github.com/segmentio/Signals-swift.git
34
34
```
35
35
36
-
2. Add the initialization code:
36
+
2. Add the initialization code and configuration options:
37
+
38
+
> success ""
39
+
> see [configuration options](#configuration-options) for a complete list.
37
40
38
41
```swift
39
42
// Configure Analytics with your settings
@@ -87,6 +90,23 @@ Next, you'll need to verify signal emission and [create rules](/docs/connections
87
90
88
91
Segment displays `Rule updated successfully` to verify that it saved your rule.
89
92
93
+
## Configuration Options
94
+
95
+
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.
|`maximumBufferSize`| No | Integer | The number of signals to be kept for JavaScript inspection. This buffer is first-in, first-out. Default is `1000`. |
101
+
|`relayCount`| No | Integer | Relays signals to Segment every Xth event. Default is `20`. |
102
+
|`relayInterval`| No | TimeInterval | Relays signals to segment every X seconds. Default is `60`. |
103
+
|`broadcasters`| No |`SignalBroadcaster`| An array of broadcasters. These objects forward signal data to their destinations, like `WebhookBroadcaster` or `DebugBroadcaster` writing to the developer console. Default is `SegmentBroadcaster`. |
104
+
|`useUIKitAutoSignal`| No | Bool | Tracks UIKit component interactions automatically. Default is `false`. |
105
+
|`useSwiftUIAutoSignal`| No | Bool | Tracks SwiftUI component interactions automatically. Default is `false`. |
106
+
|`useNetworkAutoSignal`| No | Bool | Tracks network events automatically. Default is `false`. |
107
+
|`allowedNetworkHosts`| No | Array | An array of allowed network hosts. |
108
+
|`blockedNetworkHosts`| No | Array | An array of blocked network hosts.
109
+
90
110
## Next steps
91
111
92
112
This guide walked you through initial Signals SDK/Auto-Instrumentation setup. Next, read the [Auto-Instrumentation Signals Implementation Guide](/docs/connections/auto-instrumentation/configuration/), which dives deeper into Signals and offers examples rules.
Copy file name to clipboardExpand all lines: src/connections/auto-instrumentation/web-setup.md
+20-1Lines changed: 20 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -40,7 +40,10 @@ Follow these steps to integrate the Signals SDK into your website:
40
40
pnpm install @segment/analytics-signals
41
41
```
42
42
43
-
2. Add the initialization code:
43
+
2. Add the initialization code and configuration options:
44
+
45
+
> success ""
46
+
> see [configuration options](#configuration-options) for a complete list.
44
47
45
48
```ts
46
49
// analytics.js/ts
@@ -104,6 +107,22 @@ signalsPlugin.addSignal({
104
107
})
105
108
```
106
109
110
+
## Configuration Options
111
+
112
+
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-Kotlin.
|`maxBufferSize`| No | number | The number of signals to be kept for JavaScript inspection. This buffer is first-in, first-out. Default is `1000`. |
118
+
| `processSignal` | No | string | Override the default signal processing function from the edge function. If this is set, the edge function will not be used.
119
+
| `enableDebugLogging` | No | boolean | Enable debug logs.
120
+
| `disableSignalRedaction` | No | boolean | Disable default Signal data redaction.
121
+
| `apiHost` | No | string | Override the default signals API host. Default is `signals.segment.io/v1`.
122
+
| `functionHost` | No | string | Override the default edge host. Default is `cdn.edgefn.segment.com`
123
+
|`flushAt`| No | number | How many signals to flush at once when sending to the signals API. Default is `5` . |
124
+
|`flushInterval`| No | number | How many ms to wait before flushing signals to the API. The default is `2000`. |
125
+
107
126
## Next steps
108
127
109
128
This guide walked you through initial Signals SDK/Auto-Instrumentation setup. Next, read the [Auto-Instrumentation Signals Implementation Guide](/docs/connections/auto-instrumentation/configuration/), which dives deeper into Signals and offers examples rules.
0 commit comments