Skip to content

Commit 62557d9

Browse files
authored
Merge pull request #8005 from segmentio/add-auto-inst-features
Add permissions, preview section, and tracking plan integration information for auto-instrumentation
2 parents a611f0f + eb3743a commit 62557d9

File tree

1 file changed

+13
-3
lines changed

1 file changed

+13
-3
lines changed

src/connections/auto-instrumentation/configuration.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,12 @@ After you set up the Signals SDK to capture the signals you want to target, you
2323

2424
### Getting started with rule creation
2525

26-
1. In your Segment workspace, go to **Sources** and select a source.
27-
2. Open the **Event Builder**, then click **Create Rules**.
26+
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.
27+
2. In your Segment workspace, go to **Sources** and select a source.
28+
3. Open the **Event Builder**, then click **Create Rules**.
2829

2930
> 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.
31+
> The Event Builder tab only appears after you've enabled Auto Instrumentation under the Analytics.js tab in the source's settings. If you don’t see the tab, reach out to your Segment CSM.
3132
3233
### Using the Rules Editor
3334

@@ -37,6 +38,10 @@ The Rules Editor is where you define rules that transform raw signal data into a
3738
- Set conditions to control when events should be triggered
3839
- Assign custom event names
3940

41+
#### Tracking plan integration
42+
43+
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.
44+
4045
#### Adding event properties
4146

4247
You can enrich your events by adding properties based on signal metadata. For example:
@@ -46,6 +51,11 @@ You can enrich your events by adding properties based on signal metadata. For ex
4651

4752
These properties are sent alongside your event, giving your team deeper insights without requiring any manual instrumentation.
4853

54+
#### Preview your event rule
55+
56+
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.
57+
58+
4959
<!-- PW, 6 August 2025: Commenting this section out for now
5060
5161
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

Comments
 (0)