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
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 "Public Beta"
10
+
> info "Auto-Instrumentation in public beta"
11
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
13
## Before you begin
14
14
15
15
To use Signals with Android, you need:
16
16
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
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.
21
21
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"}.
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"}.
23
23
24
24
Segment recommends testing in a development environment before deploying Signals in production. For more information, see [Debug mode](#step-4-enable-debug-mode).
25
25
@@ -63,7 +63,7 @@ Only add the plugins you plan to use. You can add or remove them later without r
63
63
64
64
## Step 2: Initialize the SDK
65
65
66
-
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.
67
67
68
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:
97
97
98
-
- 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.
99
99
-`debugMode` sends signals to Segment for use in the Event Builder. Only enable it in development environments.
100
100
- If your app doesn't use Jetpack Compose or Navigation, you can skip those plugin lines.
101
101
@@ -230,7 +230,7 @@ If `debugMode` is enabled, Signals appear in real time as you interact with the
230
230
5. After you add any event mappings, click **Publish event rules** to save them.
231
231
232
232
> info "What if I don't see the Event Builder tab?"
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 AutoInstrumentation is enabled in **Settings > Advanced**. If you still don't see it, reach out to your CSM.
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.
0 commit comments