Avo Inspector SDK for Node.js

This is a quick start guide. For more information about the Inspector project please read the Inspector SDK Reference and the Inspector Setup Guide.

Installation

The library is distributed with npm, install with npm:

    npm i node-avo-inspector

or yarn:

    yarn add node-avo-inspector

Initialization

Obtain the API key from the Inspector tab (Inspector > Manage Sources) in your Avo workspace

import * as Inspector from "node-avo-inspector";

let inspector = new Inspector.AvoInspector({
  apiKey: "your api key",
  env: Inspector.AvoInspectorEnv.Dev,
  version: "1.0.0",
  appName: "My app",
});

Integrating with Avo Codegen

The setup is lightweight and is covered in this guide.

Every event sent with your Codegen after this integration will automatically be sent to Inspector.

Sending event schemas for events reported outside of Codegen

Whenever you send tracking event call the following methods:

Read more in the Avo documentation

This method gets actual tracking event parameters, extracts schema automatically and sends 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.

inspector.trackSchemaFromEvent("Event name", {
  "String Prop": "Prop Value",
  "Float Prop": 1.0,
  "Boolean Prop": true,
});

Enabling logs

Logs are enabled by default in the dev mode and disabled in prod mode. You can enable and disable logs by calling the enableLogging method:

inspector.enableLogging(true | false);

Author

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

License

AvoInspector is available under the MIT license.