A Modern, Fast, and Lightweight Android Ingestion Library

A Modern, Fast, and Lightweight Android Ingestion Library

Clickstream is an event agnostic, real-time data ingestion platform. Clickstream allows apps to maintain a long-running connection to send data in real-time.

The word “Clickstream” is a trail of digital breadcrumbs left by users as they click their way through a website or mobile app. It is loaded with valuable customer information for businesses and its analysis and usage has emerged as a powerful data source.

To know more about Clickstream, you can read our Medium post

Clickstream provide end to end solution for ingestion platform purposes. For setup the infrastructure please check raccoon

Architecture

Mobile Library Architecture

Key features

• Simple and lightweight
• Remotely Configurable
• Support for real-time data
• Multiple QoS support (QoS0 and QoS1)
• Typesafe and reusable schemas
• Efficient payloads
• In-built data aggregation

Getting Started with Clickstream

1. Add the maven repository URL to the root build.gradle of your project.

buildscript {
    repositories {
        mavenCentral()
    }
}

2. Add the following dependencies to your module build.gradle

dependencies {
    val version = "x.y.z"
    implementation 'com.gojek.android:clickstream:[latest_version]'
}

3. Add the following rule in proguard.pro or dexguard-project.txt

-keep class * extends com.google.protobuf.GeneratedMessageLite { *; }

Once you’ve added the dependencies and synchronized your Gradle project, the next step is to initialize Clickstream.

Initialization

Initialization of the Clickstream can be done on the background thread or main-thread, Invocation should be done on the Application class. So that the initialization happens only once.

To create a Clickstream instance you can do the following setup:

class App : Application() {

    override fun onCreate() {
        initClickStream()
    }

    private fun initClickStream() {
        ClickStream.initialize(
            configuration = CSConfiguration.Builder(
                context = context,
                info = CSInfo(
                    appInfo = appInfo,
                    locationInfo = locationInfo,
                    deviceInfo = csDeviceInfo,
                    customerInfo = customerInfo,
                    sessionInfo = sessionInfo
                ),
                config = getBuildConfig(config)
            ).apply {
                setLogLevel(DEBUG)
                setCSSocketConnectionListener(connectionListener())
            }.build())
    }

    /**
    * @see [CSConnectionEvent] for more detail explanation
    */
    private fun onConnectionListener(): CSSocketConnectionListener {
        return object : CSSocketConnectionListener {
            override fun onEventChanged(event: CSConnectionEvent) {
                is OnConnectionConnecting -> {}
                is OnConnectionConnected -> {}
                is OnMessageReceived -> {}
                is OnConnectionClosing -> {}
                is OnConnectionClosed -> {}
                is OnConnectionFailed -> {}
 			}
    	}
    }
}

Configuration

CSEventSchedulerConfig

Holds the configurations for Clickstream. These constraints allow for fine-grained control over the library behaviour like duration between retries, flush events when app goes in background, etc.

CSNetworkConfig

Holds the configuration for network related. e.g configure timeouts for network channel.

CSEventClassification

Holds the class name to be classify into InstantEvent (QoS) or RealtimeEvent (QoS1).

Cleanup

Destroy instance of Clickstream, for example can be called when user logs out of the app.

   ClickStream.release()

Push an Event

Using Explicit Builder

As Clickstream use a proto definition on the client-side, you can build a MessageLite and send it directly through ClickstreamSDK.

For instance, you’ve defined a proto definition called Rating.java which has the following properties

rating: Float
reason: String

Thus we can build the rating object just by using a Builder Pattern.

val event = Rating.newBuilder()
    .setRating(4.5)
    .setReason("nice!")
    .build()

// wrap event in CSEvent
val csEvent = CSEvent(
    guid = UUID.randomUUID().toString(),
    timestamp = Timestamp.getDefaultInstance(),
    message = event
)

// track the event
ClickStream.getInstance().trackEvent(csEvent)

Congratulations! You’re done!.

Running Sample App

In order to running the sample app, please follow this instruction

1. git clone [email protected]:gojekfarm/clickstream-android.git
2. cd clickstream-android
3. ./gradlew :app:installDebug or via play button in the Android Studio

Figure 1	Figure 2

License

Copyright 2022 GOJEK

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

GitHub

View Github