This is a quick start guide. For more information about the Inspector project please read the Inspector SDK Reference and the Inspector Setup Guide.
At the time of writing, the latest version of node-avo-inspector from the original repository has an issue where the promise returned by trackSchemaFromEvent gets resolved before the request to send the event metadata to the tracking endpoint completes. If this function is used in an AWS Lambda, this results in errors since the lambda function finishes before the event metadata request completes. This fork addresses the issue.
The library is distributed with npm, install with npm:
npm i node-avo-inspector
or yarn:
yarn add node-avo-inspector
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",
});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.
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,
});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);Avo (https://www.avo.app), hi@avo.app
AvoInspector is available under the MIT license.