Ingesting via MooseJS SDKs

To facilitate the ingestion process, Moose can generate automatically a TypeScript or Python SDK for every Data Model defined in your project. The SDK provides instant type safety and schema validation, offering real-time feedback on the data you intend to send to Moose during instrumentation.

Generating the SDK

To generate an SDK, use the following command:

moose-cli generate sdk [OPTIONS]

Options

-l, --language <LANGUAGE>

• Description: Specify the language of the SDK to be generated.
• Default: ts
• Possible Values: ts (TypeScript), python (Python)

-d, --destination <DESTINATION>

• Description: Specify the directory where the SDK files should be written.
• Default: ./sdk

-p, --project-location <PROJECT_LOCATION>

• Description: Specify the location of the Moose project.
• Default: .

-f, --full-package

• Description: Generate a full-fledged package instead of just the source files in the chosen language.

-h, --help

• Description: Display the help information for the generate sdk command.

Example Commands

npx moose-cli generate sdk

Using the SDK to Send Data

Every Data Model defined in your Moose project has its own corresponding method in the generated SDK that allows you to send data to Moose for that particular model. The method name follows the format send<DATA_MODEL_NAME>.

To send data, you need to call the method with the data you want to send as an argument. The data should be an object that matches the schema of the Data Model.

Example Usage

For the UserActivity example, you would call the sendUserActivity() method with an object that matches the UserActivity schema:

import { sendUserActivity } from "/path/to/sdk";
 
...
 
const eventId = SOME_EVENT_ID;
const userId = SOME_USER_ID;
 
sendUserActivity({
  eventId: eventId,
  timestamp: new Date(),
  userId: userId,
  activity: "Login"
});
 
// REST OF YOUR CODE...