-
Notifications
You must be signed in to change notification settings - Fork 393
Auto-Instrumentation Private Beta [DOC-1063] #7580
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 17 commits
Commits
Show all changes
19 commits
Select commit
Hold shift + click to select a range
e5647fa
update home page to remove JavaScript option
pwseg 13914db
some more rewording on home page
pwseg e6e370f
add new event builder page
pwseg 70b0b8f
add section explaining signals and how they relate to events
pwseg e5a63f1
explain how to create an event
pwseg 74a1d3b
More info on event builder
pwseg 7a0d5ee
add event builder tab screenshot
pwseg d771e7b
add another screenshot of event rules
pwseg 3ab109c
add URL screenshot
pwseg 0480813
update web setup [netlify-build]
pwseg 08d5768
update screenshot paths [netlify-build]
pwseg ced4626
fix typo [netlify-build]
pwseg c9c5b49
update generate activity instructions based on SME review
pwseg 41c40e9
some more updates
pwseg c55134c
update Swift instructions
pwseg e01f335
update Kotlin and Swift deployment instructions
pwseg 619a441
final few updates [netlify-build]
pwseg ea0d751
Update src/connections/auto-instrumentation/event-builder.md
pwseg c72e067
Update src/connections/auto-instrumentation/index.md
pwseg File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,89 @@ | ||
--- | ||
title: Auto-Instrumentation Event Builder | ||
hidden: true | ||
--- | ||
|
||
The Event Builder provides a no-code way to define analytics events based on signals collected by Auto-Instrumentation. | ||
|
||
You can use it to create Track, Identify, Page, and other event types directly from your Segment workspace. | ||
|
||
> info "Auto-Instrumentation Private Beta" | ||
> 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. | ||
## Access the Event Builder | ||
|
||
The Event Builder appears as a tab within each source, next to the Debugger. If you don't see the Event Builder tab, first confirm that you've installed the required Auto-Instrumentation SDK. | ||
|
||
If you've installed the SDK but still don't see the Event Builder tab, reach out to your Segment account manager to verify your workspace is included in the Auto-Instrumentation Private Beta. | ||
|
||
 | ||
|
||
> info "Event Builder during Private Beta" | ||
> During Private Beta beta, both the Event Builder and the legacy Auto-Instrumentation tab appear in the navigation. Segment will remove the legacy tab once all customers have migrated to the Event Builder experience. | ||
## Generate activity | ||
|
||
To populate the Event Builder with signals, you first need to open your website or app with a special query parameter that enables signal detection. | ||
|
||
1. Visit your site or app in a browser, and add `?segment_signals_debug=true` to the end of the URL. | ||
For example: `https://www.your-website.com?segment_signals_debug=true`. | ||
2. Interact with your app as a user would: click buttons, navigate between pages or screens, submit forms, and so on. | ||
3. Return to the Event Builder tab in Segment to view the signals being collected in real time. | ||
|
||
|
||
 | ||
|
||
> info "Enable signal detection" | ||
> Segment only detects signals when you access your site using the `?segment_signals_debug=true` query parameter. If you visit your site without it, signals won't show up in the Event Builder. | ||
Segment collects and displays activity as signals. These signals are grouped into types, like: | ||
|
||
- Interaction: clicks, taps, and UI interactions. | ||
- Navigation: screen changes and page transitions | ||
- Network: requests and responses | ||
- `LocalData`, Instrumentation, and `UserDefined`: additional signal types from the SDK. | ||
|
||
### How signals relate to events | ||
|
||
Segment separates signal collection from event creation. Signals represent raw user interactions, like a button click or screen view. Events, on the other hand, are analytics calls you define based on those signals. This two-step process lets you observe user behavior first, and then decide how and when to turn that behavior into structured analytics events, without needing to modify your code. | ||
|
||
Signal detection is active for 24 hours after you generate activity. Detected signals are available in the Event Builder for 72 hours. | ||
|
||
## Create an event | ||
|
||
You can create events by selecting individual signals or combining multiple signals in sequence. | ||
|
||
Follow these steps to create an event: | ||
|
||
1. Find the signal you want to use and click **Configure event**. | ||
2. Add one or more conditions. The order matters; Segment evaluates them in the order you add them. | ||
- For example, to track a successful login, first select a **button click** signal, then the **network response** signal. | ||
3. Select properties from the signal(s) to include in your event. | ||
4. Map those properties to your targeted Segment event fields. | ||
5. Name your event. This name will appear in the Debugger and downstream tools. | ||
6. Click **Publish event rules** to activate the event in your workspace. | ||
- You must publish each rule before Segment starts collecting data for the event. | ||
|
||
For example, suppose a user taps an "Add to Cart" button. You can define an `Add to Cart` event by combining the button click signal with a network response signal that includes product details. You can then map properties like product name, ID, and price directly from the network response to your event. | ||
|
||
Once published, your event rules appear in the **Event Rules** tab of the Event Builder. From this tab, you can view all of your published rules and delete rules you no longer need. | ||
|
||
 | ||
|
||
## Choose an event type | ||
|
||
When you define an event in the Event Builder, you assign it a type that determines how Segment and your connected destinations process it. These event types (Track, Identify, Page, and Screen) follow the same structure and behavior defined in the [Segment Spec](/docs/connections/spec/). | ||
|
||
| Event type | Description | | ||
| ---------- | ----------------------------------------------------------------------------------------------------------- | | ||
| Track | Custom event tracking. Use this for user actions like `Product Viewed`, `Add to Cart`, or `Signup Started`. | | ||
| Identify | User identification. Use this to associate traits (like `email`, `userId`, or `plan`) with a known user. | | ||
| Page | Web page view tracking. Use this to record visits to pages on your website. | | ||
| Screen | Mobile screen view tracking. Use this to record views of screens in your mobile app. | | ||
|
||
For example, to track a login flow, you might define an Identify event that maps traits like `userId` and `email` from a network response signal. To track cart activity, you could define a Track event like `Checkout Started` with properties like cart value, item count, and currency. | ||
|
||
Segment uses the event name and any mapped properties to format each event according to the Segment Spec. Events you create in the Event Builder behave the same way as events sent through Segment SDKs or APIs. | ||
|
||
> info "Event type behavior in destinations" | ||
> While Segment handles these event types consistently, downstream tools may treat them differently. For example, Identify events often update user profiles, while Page or Screen events may be handled as pageviews instead of custom events. |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.