[Done] Provide a Health Metrics that use plugin architecture

[radityagumay]

Synopsis

Provide a 'plugin' for Health Metrics which helps the client to switch op and noop the libraries, so that it would avoid any overheads to the client app size.

Background

In the internal Gojek, we have health metrics that internally would capture and push the metrics to our infrastructure. The reason that we create health metrics is to understand the performance of clickstream compared to 3rd party libraries. In order to bring the Health metrics to an open-source version, we thinking of introducing the health metrics as an independent library so that it can be plugged into the Clickstream easily.

Proposal

introduce three new modules such as:

• clickstream-health-metrics-api
• clickstream-health-metrics
• clickstream-health-metrics-noop

clickstream-health-metrics-api

this module only contains an interface to be used in :clickstream, clickstream-health-metrics, and clickstream-health-metrics-noop.

Example

interface CSHealthMetrics {
    fun trackEvent(event: CSHealthEvent)
}

clickstream-health-metrics

this module will contain logics to instrument health metrics, such as:

• operation to databases
• send to server
• scheduled worker

clickstream-health-metrics-noop

this module will contain skeleton of implementations, which internally not doing anything, and also there's no dependencies that would be installed in the .gradle

Dependency Graph

[radityagumay]

See the PR here #9

[radityagumay]

Merged. including in release https://github.com/gojek/clickstream-android/releases/tag/0.2.36