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
+9-3Lines changed: 9 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,6 +17,14 @@ This guide assumes that you've already added the Signals SDK to your application
17
17
18
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.
19
19
20
+
The process works like this:
21
+
22
+
1. The SDK sends raw signals from your app or website to Segment.
23
+
2. You build event rules in your workspace that define how those signals should become analytics events.
24
+
3. You publish the event rules.
25
+
26
+
After publishing, Segment analyzes user interactions in your app or website against these rules and automatically generates analytics events when matching interactions occur.
27
+
20
28
### Getting started with rule creation
21
29
22
30
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.
@@ -47,13 +55,11 @@ You can enrich your events by adding properties based on signal metadata. For ex
47
55
48
56
These properties are sent alongside your event, giving your team deeper insights without requiring any manual instrumentation.
49
57
58
+
<!-- PW, 6 August 2025: Commenting this section out for now
50
59
#### Preview your event rule
51
60
52
61
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
62
54
-
55
-
<!-- PW, 6 August 2025: Commenting this section out for now
56
-
57
63
The Rules Editor also lets you test your rules with recent signals to verify that they produce the data you need before you deploy.
0 commit comments