Skip to content

Commit ed9e668

Browse files
committed
add next steps section
1 parent 0d6c5b3 commit ed9e668

File tree

1 file changed

+28
-21
lines changed

1 file changed

+28
-21
lines changed

src/connections/auto-instrumentation/kotlin-setup.md

Lines changed: 28 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -163,9 +163,7 @@ Retrofit is built on top of OkHttp, so the setup is similar.
163163
JavaNetTrackingPlugin.install()
164164
```
165165
166-
---
167-
168-
Depending on your app’s network stack, you may only need one plugin. If your app uses multiple clients, you can install more than one.
166+
Depending on your app’s network stack, you may only need one plugin. If your app uses multiple clients, you can install more than one.
169167
170168
## Step 4: Enable debug mode
171169
@@ -216,31 +214,40 @@ Signals.configuration = Configuration(
216214
...
217215
debugMode = remoteConfig.getBoolean("debug_mode")
218216
)
217+
```
218+
219+
## Step 5: Verify event collection
220+
221+
After you build and run your app, use the [Event Builder](/docs/connections/auto-instrumentation/event-builder/) to confirm that Signals are being collected correctly.
222+
223+
1. In your Segment workspace, go to **Connections > Sources** and select the Android Source you configured.
224+
2. Open the **Event Builder** tab.
225+
3. Interact with your app on a simulator or test device:
226+
- Navigate between screens.
227+
- Tap buttons and UI elements.
228+
- Trigger network requests.
219229

220-
<!--## Step 3: Verify and deploy events
230+
If `debugMode` is enabled, Signals appear in real time as you interact with the app.
221231

222-
After integrating the SDK and running your app, verify that Segment is collecting signals:
232+
4. In the Event Builder, select a signal and click **Configure event** to define a new event.
233+
5. After you add any event mappings, click **Publish event rules** to save them.
223234

224-
1. In your Segment workspace, go to **Connections > Sources** and select the source you created for Auto-Instrumentation.
225-
2. In the source overview, look for the **Event Builder** tab. If the tab doesn’t appear:
226-
- Make sure you've installed the SDK correctly.
227-
- Reach out to your Segment CSM to confirm that your workspace has the necessary feature flags enabled.
228-
3. Launch your app [in debug mode](https://github.com/segmentio/analytics-next/tree/master/packages/signals/signals#sending-and-viewing-signals-on-segmentcom-debug-mode){:target="_blank"}, for example, by running the app from Android Studio on a simulator or test device. This enables signal collection so you can see activity in the Event Builder.
229-
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.
230-
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**.
235+
> 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.
231237
232-
## Configuration Options
238+
## Configuration options
233239

234-
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.
240+
Use the `Signals.configuration` object to control how captured signals are stored, relayed, and displayed.
235241

236-
| `Option` | Required | Value | Description |
237-
| ------------------- | -------- | ------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
238-
| `writeKey` | Yes | String | Source write key |
239-
| `maximumBufferSize` | No | Integer | The number of signals to be kept for JavaScript inspection. This buffer is first-in, first-out. Default is `1000`. |
240-
| `broadcastInterval` | No | Integer | Broadcasts signals to Segment every X event. Default is `60`. |
241-
| `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`. |
242+
The following table lists the available options:
242243

244+
| Option | Required | Type | Default | Description |
245+
| ------------------- | -------- | ------------------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
246+
| `maximumBufferSize` | No | `Int` | `1000` | The number of captured signals to keep in memory before relaying them. Signals get stored in a first-in, first-out buffer. |
247+
| `broadcastInterval` | No | `Int` (seconds) | `60` | The interval, in seconds, at which buffered signals are sent to broadcasters. |
248+
| `broadcasters` | No | `List<SignalBroadcaster>` | N/A | A list of broadcasters that forward signal data to external destinations. `SegmentBroadcaster` is included by default, and you can add others like `WebhookBroadcaster` or a custom implementation. |
249+
| `debugMode` | No | `Boolean` | `false` | When `true`, relays signals to Segment so they appear in the Event Builder. Only enable this in development environments. |
243250

244251
## Next steps
245252

246-
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 example rules.
253+
After you've confirmed that signals show up in the Event Builder, use the [Generate Events from Signals](/docs/connections/auto-instrumentation/configuration/) guide to configure how signals get translated into analytics events.

0 commit comments

Comments
 (0)