Skip to content

Latest commit

 

History

History
216 lines (156 loc) · 5.58 KB

Readme.md

File metadata and controls

216 lines (156 loc) · 5.58 KB
Raw

AvoInspector

Avo documentation

This is a quick start guide. For more information about the Inspector project please read Avo documentation.

Installation

We host the library on JitPack.io, so

add the following to the root build.gradle:

    allprojects {
        repositories {
          ...
          maven { url 'https://jitpack.io' }
        }
    }

and in your module build.gradle:

    dependencies {
        debugImplementation 'com.github.avohq.android-avo-inspector:dev:TAG' // Includes the visual inspector, a tool useful to monitor your analytics calls when developing
        releaseImplementation 'com.github.avohq.android-avo-inspector:prod:TAG' // Does not include the visual inspector 
    }

Use the latest github release tag to get the latest version of the library.

Initialization

Obtain the API key at Avo.app

Java

import app.avo.inspector.AvoInspector;
import app.avo.inspector.AvoInspectorEnv;

AvoInspector avoInspector = new AvoInspector("MY_API_KEY", getApplication(), AvoInspectorEnv.Dev, activity);

Kotlin

import app.avo.inspector.AvoInspector
import app.avo.inspector.AvoInspectorEnv

val avoInspector = AvoInspector("MY_API_KEY", application, AvoInspectorEnv.Dev, activity)

Activity is optional, if you provide it in development or staging mode the library will show the visual inspector.

Enabling logs

Logs are enabled by default in the dev mode and disabled in prod mode based on the init flag.

Java

AvoInspector.enableLogging(true);

Kotlin

AvoInspector.enableLogging(true)

Integrating with Avo Codegen

The setup is lightweight and is covered in this guide.

Every event sent with Avo Function after this integration will automatically be sent to Inspector.

Sending event schemas for events reported outside of Codegen

Whenever you send tracking event call one of the following methods:

Read more in the Avo documentation

1.

This methods get actual tracking event parameters, extract schema automatically and send it to the Inspector backend. It is the easiest way to use the library, just call this method at the same place you call your analytics tools' track methods with the same parameters.

Java

avoInspector.trackSchemaFromEvent("Event name", new HashMap<String, Object>() {{
                        put("String Prop", "Prop Value");
                        put("Float Name", 1.0);
                        put("Bool Name", true);
                    }});

Second parameter can also be a JSONObject.

Kotlin

avoInspector.trackSchemaFromEvent("Event name",
        mapOf("String Prop" to "Prop Value",
               "Float Name" to 1.0,
                "Bool Name" to true))

Second parameter can also be a JSONObject.

2.

If you prefer to extract data schema manually you would use this method.

Java

avoInspector.trackSchema("Event name", new HashMap<String, AvoEventSchemaType>() {{
            put("String Prop", new AvoEventSchemaType.AvoString());
            put("Float Name", new AvoEventSchemaType.AvoFloat());
            put("Bool Name", new AvoEventSchemaType.AvoBoolean());
        }});

Kotlin

avoInspector.trackSchema("Event name",
        mapOf("String Prop" to AvoString(),
               "Float Name" to AvoFloat(),
                "Bool Name" to AvoBoolean()))

Extracting event schema manually

Java

Map<String, AvoEventSchemaType> schema = avoInspector.extractSchema(new HashMap<String, Object>() {{
            put("String Prop", "Prop Value");
            put("Float Name", 1.0);
            put("Bool Name", true);
        }});

Kotlin

val schema = avoInspector.extractSchema(mapOf("String Prop" to "Prop Value",
                "Float Name" to 1.0,
                "Bool Name" to true))

Using the Visual Inspector

Visual Inspector is enabled in development and staging environments by default.

Show

Java

avoInspector.showVisualInspector(activity, DebuggerMode.bubble); // or DebuggerMode.bar

Kotlin

avoInspector.showVisualInspector(activity, DebuggerMode.bubble) // or DebuggerMode.bar

Hide

Java

avoInspector.hideVisualInspector(activity);

Kotlin

avoInspector.hideVisualInspector(activity)

Advanced usage

You can get an instance of DebuggerManager when using the :dev dependency with the following method. This method will return null in the :prod dependency.

Java

DebuggerManager visualInspector = (DebuggerManager) avoInspector.getVisualInspector();

Kotlin

val visualInspector = avoInspector.visualInspector as DebuggerManager?

See more about the DebuggerManager in GitHub repo

Batching control

In order to ensure our SDK doesn't have a large impact on performance or battery life it supports event schemas batching.

Default batch size is 30 and default batch flush timeout is 30 seconds. In debug mode batching is disabled.

Java

AvoInspector.setBatchSize(15);
AvoInspector.setBatchFlushSeconds(10);

Kotlin

AvoInspector.setBatchSize(15)
AvoInspector.setBatchFlushSeconds(10)

Author

Avo (https://www.avo.app), [email protected]

License

AvoInspector is available under the MIT license.