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/_includes/content/functions/runtime.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,12 +1,12 @@
1
-
On March 26, 2024, Segment upgraded the Functions runtime environment to Node.js v18, which is the current long-term support (LTS) release.
1
+
Segment Functions run on the Node.js LTS runtime (currently v20). This keeps the runtime current with industry standards and security updates.
2
2
3
-
This upgrade keeps your runtime current with industry standards. Based on the [AWS Lambda](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html){:target="_blank"} and [Node.js](https://nodejs.org/en/about/previous-releases){:target="_blank"} support schedule, Node.js v16 is no longer in *Maintenance LTS*. Production applications should only use releases of Node.js that are in *Active LTS* or *Maintenance LTS*.
3
+
Based on the [AWS Lambda](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html){:target="_blank"} and [Node.js](https://nodejs.org/en/about/previous-releases){:target="_blank"} support schedule, production applications should only use Node.js releases that are in Active LTS or Maintenance LTS.
4
4
5
-
For existing functions, this change automatically occurs as you update and deploy an existing function. Segment recommends that you check your function post-deployment to ensure everything's working. Your function may face issues due to the change in syntax between different Node.js versions and dependency compatibility.
5
+
When Segment upgrades the Functions runtime to a new LTS version, existing functions automatically use the new runtime after their next deployment. Segment recommends checking your function after deployment to ensure everything works as expected, since dependency or syntax changes between Node.js versions might affect your function’s behavior.
6
6
7
-
Functions don't currently support importing dependencies, but you can [contact Segment Support](https://segment.com/help/contact/){:target="_blank"} to request that one be added.
7
+
Functions don't support importing dependencies, but you can [contact Segment Support](https://segment.com/help/contact/){:target="_blank"} to request that one be added.
8
8
9
-
The following dependencies are installed in the function environment by default.
9
+
The following dependencies are installed in the function environment by default:
10
10
11
11
-[`atob v2.1.2`](https://www.npmjs.com/package/atob){:target="_blank"} exposed as `atob`
12
12
-[`aws-sdk v2.488.0`](https://www.npmjs.com/package/aws-sdk){:target="_blank"} exposed as `AWS`
Copy file name to clipboardExpand all lines: src/connections/auto-instrumentation/configuration.md
+25-19Lines changed: 25 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,49 +3,55 @@ title: Generate Events from Signals
3
3
hidden: true
4
4
---
5
5
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:
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, find details on:
7
7
8
-
- Creating custom rules to capture and translate signals into actionable analytics events
9
-
- Example rules that you can use as a basis for further customization
8
+
- Creating custom rules to capture and translate signals into actionable analytics events.
9
+
- Example rules that you can use as a basis for further customization.
10
10
11
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.
12
12
13
-
> info "Auto-Instrumentation Private Beta"
14
-
> 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.
15
-
16
-
> success "Enable Auto-Instrumentation"
17
-
> To enable Auto-Instrumentation in your Segment workspace, reach out to your dedicated account manager.
18
-
13
+
> info "Auto-Instrumentation in public beta"
14
+
> Auto-Instrumentation is in public beta, and Segment is actively working on this feature. Some functionality may change before it becomes generally available.
19
15
20
16
## Converting signals to events
21
17
22
18
After you set up the Signals SDK to capture the signals you want to target, you can create rules in your Segment workspace to translate the captured signals into traditional Segment analytics events. These rules are deployed in your application the next time a user launches your app.
23
19
24
20
### Getting started with rule creation
25
21
26
-
1. In your Segment workspace, go to **Sources** and select a source.
27
-
2. Open the **Event Builder**, then click **Create Rules**.
22
+
1. Ensure you have the `Workspace Owner` or `Source Admin` role in Segment. If your source is connected to a tracking plan, you will also need, at a minimum, the `Tracking Plan Read-only` role. To view the content in the Event Builder tab, you will need, at a minimum, the `Source Read-only` role.
23
+
2. In your Segment workspace, go to **Sources** and select a source.
24
+
3. Open the **Event Builder**, then click **Create Rules**.
28
25
29
26
> info "Where's the Event Builder tab?"
30
-
> The Event Builder tab only appears after you've installed the Auto-Instrumentation snippet in your site or app. If you don’t see the tab, double check your implementation or reach out to your Segment CSM.
27
+
> The Event Builder tab only appears after you've enabled AutoInstrumentation under the Analytics.js tab in the source's settings. If you don’t see the tab, reach out to your Segment CSM.
31
28
32
29
### Using the Rules Editor
33
30
34
31
The Rules Editor is where you define rules that transform raw signal data into analytics events. Using the dropdown-based editor, you can:
35
32
36
-
- Combine multiple signals into a single event (for example, a click followed by a navigation)
37
-
- Set conditions to control when events should be triggered
38
-
- Assign custom event names
33
+
- Combine multiple signals into a single event (for example, a click followed by a navigation).
34
+
- Set conditions to control when events should be triggered.
35
+
- Assign custom event names.
36
+
37
+
#### Tracking plan integration
38
+
39
+
If your source is connected to a tracking plan, you can quickly confirm that a rule’s event and properties are planned. When creating or editing a rule, choose an event by typing its name or selecting from the tracking plan’s events in a dropdown. Similarly, add properties by typing their names or selecting from the event’s properties in a dropdown. The Planned column, shown next to each property mapping and in the Event Rules table, indicates whether the property or event is planned.
39
40
40
41
#### Adding event properties
41
42
42
43
You can enrich your events by adding properties based on signal metadata. For example:
43
44
44
-
- Capture `product.price` in your **Add to Cart** event
45
-
- Add a boolean field like `couponApplied` to your **Order Completed** event
45
+
- Capture `product.price` in your **Add to Cart** event.
46
+
- Add a boolean field like `couponApplied` to your **Order Completed** event.
46
47
47
48
These properties are sent alongside your event, giving your team deeper insights without requiring any manual instrumentation.
48
49
50
+
#### Preview your event rule
51
+
52
+
To verify that a rule is working as expected, you don't need to enter a cycle of creating and updating the rule, generating signals, then checking the source debugger for the generated event. As you create, edit, or view a rule, you can preview it in real time against the current signal buffer to see which signals match and what the resulting event will look like. Event properties are mapped to the values found in the matched signals, and complete matches are grouped by anonymous ID.
53
+
54
+
49
55
<!-- PW, 6 August 2025: Commenting this section out for now
50
56
51
57
The Rules Editor also lets you test your rules with recent signals to verify that they produce the data you need before you deploy.
@@ -89,7 +95,7 @@ interface RawSignal<T> {
89
95
90
96
### Signal Types
91
97
92
-
The Signal Type enum defines the different types of signals the SDK can collect:
98
+
The Signal Type `enum` defines the different types of signals the SDK can collect:
93
99
94
100
```java
95
101
enum SignalType {
@@ -317,4 +323,4 @@ function ProcessSignals(signal) {
317
323
trackAddToCart(signal); // Process the "Add To Cart" tracking based on incoming signals
Copy file name to clipboardExpand all lines: src/connections/auto-instrumentation/index.md
+3-6Lines changed: 3 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,11 +26,8 @@ redirect_from:
26
26
27
27
Auto-Instrumentation simplifies tracking in your websites and apps by removing the need for a traditional Segment instrumentation.
28
28
29
-
> info "Auto-Instrumentation Private Beta"
30
-
> 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.
31
-
32
-
> success "Enable Auto-Instrumentation in your workspace"
33
-
> To enable Auto-Instrumentation in your Segment workspace, reach out to your dedicated account manager or friends@segment.com.
29
+
> info "Auto-Instrumentation in public beta"
30
+
> Auto-Instrumentation is in public beta, and Segment is actively working on this feature. Some functionality may change before it becomes generally available.
34
31
35
32
## Background
36
33
@@ -52,7 +49,7 @@ After you install the required SDKs and enable Auto-Instrumentation, Segment det
52
49
53
50
You can group signals into complete analytics events, assign names, and map custom properties. 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 application performance.
This guide shows how to install and configure the library, as well as how to enable optional plugins for screen views, network activity, and more.
9
9
10
-
> info "Auto-Instrumentation Private Beta"
11
-
> 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.
10
+
> info "Auto-Instrumentation in public beta"
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
-
> success "Auto-Instrumentation access"
14
-
> To turn Auto-Instrumentation on in your Segment workspace, reach out to your dedicated account manager.
15
-
16
-
## Before you begin
13
+
## Before you start
17
14
18
15
To use Signals with Android, you need:
19
16
20
-
- An active Segment workspace with Auto-Instrumentation enabled
21
-
- A Kotlin-based Android project
22
-
- Android Gradle Plugin version 7.0 or later
23
-
- A minimum compile SDK version of 21
17
+
- An active Segment workspace with Auto-Instrumentation enabled.
18
+
- A Kotlin-based Android project.
19
+
- Android Gradle Plugin version 7.0 or later.
20
+
- A minimum compile SDK version of 21.
24
21
25
-
Signals supports [Jetpack Compose](https://developer.android.com/compose){:target="_blank"} and traditional Android UI frameworks. It also includes optional plugins for network tracking using [OkHttp3](https://square.github.io/okhttp/){:target="_blank"}, [Retrofit](https://square.github.io/retrofit/){:target="_blank"}, or `HttpURLConnection`](https://developer.android.com/reference/java/net/HttpURLConnection){:target="_blank"}.
22
+
Signals supports [Jetpack Compose](https://developer.android.com/compose){:target="_blank"} and traditional Android UI frameworks. It also includes optional plugins for network tracking using [OkHttp3](https://square.github.io/okhttp/){:target="_blank"}, [Retrofit](https://square.github.io/retrofit/){:target="_blank"}, or [HttpURLConnection](https://developer.android.com/reference/java/net/HttpURLConnection){:target="_blank"}.
26
23
27
24
Segment recommends testing in a development environment before deploying Signals in production. For more information, see [Debug mode](#step-4-enable-debug-mode).
28
25
@@ -66,7 +63,7 @@ Only add the plugins you plan to use. You can add or remove them later without r
66
63
67
64
## Step 2: Initialize the SDK
68
65
69
-
After you add dependencies, you'll need to initialize the Analytics client and configure the Signals plugin.
66
+
After you add dependencies, you need to initialize the Analytics client and configure the Signals plugin.
70
67
71
68
Start by creating the `Analytics` instance using your source's write key. Then add the Signals plugin and configure its settings separately.
When you run this code, keep the following in mind:
100
97
101
-
- You'll need to replace `<WRITE_KEY>` with the key from your Android Source in Segment.
98
+
- You need to replace `<WRITE_KEY>` with the key from your Android Source in Segment.
102
99
-`debugMode` sends signals to Segment for use in the Event Builder. Only enable it in development environments.
103
100
- If your app doesn't use Jetpack Compose or Navigation, you can skip those plugin lines.
104
101
@@ -233,7 +230,7 @@ If `debugMode` is enabled, Signals appear in real time as you interact with the
233
230
5. After you add any event mappings, click **Publish event rules** to save them.
234
231
235
232
> info "What if I don't see the Event Builder tab?"
236
-
> If you don't see the Event Builder tab, confirm that the SDK is installed correctly and make sure `debugMode` is enabled. If you still don't see it, reach out to your CSM to verify that your workspace has Auto-Instrumentation enabled.
233
+
> If you don't see the Event Builder tab, confirm that the SDK is installed correctly and make sure `debugMode` is enabled. Verify that Auto-Instrumentation is enabled in **Settings > Advanced**. If you still don't see it, reach out to your CSM.
Copy file name to clipboardExpand all lines: src/connections/auto-instrumentation/swift-setup.md
+9-12Lines changed: 9 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,17 +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 "Auto-Instrumentation Private Beta"
11
-
> 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.
12
-
13
-
> success "Auto-Instrumentation access"
14
-
> To turn Auto-Instrumentation on in your Segment workspace, reach out to your dedicated account manager.
10
+
> info "Auto-Instrumentation in public beta"
11
+
> Auto-Instrumentation is in public beta, and Segment is actively working on this feature. Some functionality may change before it becomes generally available.
15
12
16
13
## Step 1: Get your source write key
17
14
18
-
You need the `writeKey` from an existing Segment source:
15
+
You need the `writeKey` from an existing Segment source. To find it:
19
16
20
17
1. In your Segment workspace, go to **Connections > Sources**.
21
18
2. Select your source.
@@ -24,7 +21,7 @@ You need the `writeKey` from an existing Segment source:
24
21
25
22
## Step 2: Add dependencies and initialization code
26
23
27
-
Next, you'll need to add the Signals SDKs to your Swift applicatiion.
24
+
Next, add the Signals SDKs to your Swift applicatiion.
28
25
29
26
1. Use Swift Package Manager to add the Signals SDK from the following repository:
30
27
@@ -35,7 +32,7 @@ Next, you'll need to add the Signals SDKs to your Swift applicatiion.
35
32
2. Add the initialization code and configuration options:
36
33
37
34
> success ""
38
-
>see [configuration options](#configuration-options) for a complete list.
35
+
>See [configuration options](#configuration-options) for a complete list.
39
36
40
37
```swift
41
38
// Configure Analytics with your settings
@@ -58,11 +55,11 @@ Next, you'll need to add the Signals SDKs to your Swift applicatiion.
58
55
Analytics.main.add(plugin: Signals.shared)
59
56
```
60
57
61
-
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).
62
59
63
60
#### SwiftUI projects
64
61
65
-
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:
66
63
67
64
```swift
68
65
import Foundation
@@ -96,7 +93,7 @@ After integrating the SDK and running your app, verify that Segment is collectin
96
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.
97
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**.
98
95
99
-
## Configuration Options
96
+
## Configuration options
100
97
101
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