Skip to content

Composio powers 1000+ toolkits, tool search, context management, authentication, and a sandboxed workbench to help you build AI agents that turn intent into action.

refactor telemetry

haxzie6c5a029e2606
diff --git a/packages/core/src/composio.ts b/packages/core/src/composio.ts
index f90ef9acb..4655c0996 100644
--- a/packages/core/src/composio.ts
+++ b/packages/core/src/composio.ts
@@ -5,9 +5,8 @@ import { Triggers } from './models/Triggers';
import { AuthConfigs } from './models/AuthConfigs';
import { ConnectedAccounts } from './models/ConnectedAccounts';
import { BaseComposioProvider } from './provider/BaseProvider';
-import { Telemetry } from './telemetry/Telemetry';
+import { telemetry } from './telemetry/Telemetry';
import { BaseTelemetryTransport } from './telemetry/TelemetryTransport';
-import type { TelemetryMetadata } from './types/telemetry.types';
import { getSDKConfig } from './utils/sdk';
import logger from './utils/logger';
import { IS_DEVELOPMENT_OR_CI } from './utils/constants';
@@ -15,6 +14,7 @@ import { checkForLatestVersionFromNPM } from './utils/version';
import { OpenAIProvider } from './provider/OpenAIProvider';
import { version } from '../package.json';
import { getRandomUUID } from './utils/uuid';
+import { getEnvVariable } from './utils/env';
export type ComposioConfig<
TProvider extends BaseComposioProvider<unknown, unknown> = OpenAIProvider,
@@ -44,8 +44,6 @@ export class Composio<TProvider extends BaseComposioProvider<unknown, unknown> =
*/
private config: ComposioConfig<TProvider>;
- private telemetry: Telemetry | undefined;
-
/**
* Core models for Composio.
*/
@@ -73,6 +71,7 @@ export class Composio<TProvider extends BaseComposioProvider<unknown, unknown> =
config?.apiKey
);
+ console.log(`Process.env.`, getEnvVariable('COMPOSIO_LOG_LEVEL'));
if (IS_DEVELOPMENT_OR_CI) {
logger.info(`Initializing Composio w API Key: [REDACTED] and baseURL: ${baseURLParsed}`);
}
@@ -112,43 +111,28 @@ export class Composio<TProvider extends BaseComposioProvider<unknown, unknown> =
* Initialize the client telemetry.
*/
if (this.config.allowTracking ?? true) {
- this.initializeTelemetry(
+ telemetry.setup(
{
apiKey: apiKeyParsed ?? '',
baseUrl: baseURLParsed ?? '',
- frameworkRuntime: 'node',
+ framework: this.provider?.name || 'unknown',
+ isAgentic: this.provider?._isAgentic || false,
source: 'node', // @TODO: get the source
- composioVersion: version,
+ version: version,
isBrowser: typeof window !== 'undefined',
sessionId: getRandomUUID(), // @TODO: get the session id
},
config.telemetryTransport
);
}
+ telemetry.instrument(this);
+ // instrument the provider since we are not using the provider class directly
+ telemetry.instrument(this.provider);
// Check for the latest version of the Composio SDK from NPM.
checkForLatestVersionFromNPM(version);
}
- /**
- * Initialize the instrumentations and telemetry for the Composio SDK.
- * @param {TelemetryMetadata} config - The configuration for the telemetry.
- * @param {BaseTelemetryTransport} transport - The transport for the telemetry.
- */
- private initializeTelemetry(config: TelemetryMetadata, transport?: BaseTelemetryTransport) {
- this.telemetry = new Telemetry(config, transport);
- /**
- * Instrument the instance and all the models with telemetry.
- */
- this.telemetry.instrumentTelemetry(this);
- this.telemetry.instrumentTelemetry(this.tools);
- this.telemetry.instrumentTelemetry(this.toolkits);
- this.telemetry.instrumentTelemetry(this.triggers);
- this.telemetry.instrumentTelemetry(this.authConfigs);
- this.telemetry.instrumentTelemetry(this.connectedAccounts);
- this.telemetry.instrumentTelemetry(this.provider);
- }
-
/**
* Get the Composio SDK client.
* @returns {ComposioClient} The Composio API client.
diff --git a/packages/core/src/models/AuthConfigs.ts b/packages/core/src/models/AuthConfigs.ts
index 4e18f9af8..e66c80092 100644
--- a/packages/core/src/models/AuthConfigs.ts
+++ b/packages/core/src/models/AuthConfigs.ts
@@ -27,7 +27,7 @@ import {
CreateAuthConfigResponseSchema,
} from '../types/authConfigs.types';
import { ValidationError } from '../errors/ValidationError';
-
+import { telemetry } from '../telemetry/Telemetry';
/**
* AuthConfigs class
*
@@ -39,6 +39,7 @@ export class AuthConfigs {
constructor(client: ComposioClient) {
this.client = client;
+ telemetry.instrument(this);
}
/**
diff --git a/packages/core/src/models/ConnectedAccounts.ts b/packages/core/src/models/ConnectedAccounts.ts
index e95c8867f..a0d951047 100644
--- a/packages/core/src/models/ConnectedAccounts.ts
+++ b/packages/core/src/models/ConnectedAccounts.ts
@@ -26,7 +26,7 @@ import {
} from '../types/connectedAccounts.types';
import { ConnectionRequest } from './ConnectionRequest';
import { ValidationError } from '../errors/ValidationError';
-
+import { telemetry } from '../telemetry/Telemetry';
/**
* ConnectedAccounts class
*
@@ -38,6 +38,7 @@ export class ConnectedAccounts {
constructor(client: ComposioClient) {
this.client = client;
+ telemetry.instrument(this);
}
transformConnectedAccountRetrieveResponse(
diff --git a/packages/core/src/models/ConnectionRequest.ts b/packages/core/src/models/ConnectionRequest.ts
index 93e1c185b..e6995e2a8 100644
--- a/packages/core/src/models/ConnectionRequest.ts
+++ b/packages/core/src/models/ConnectionRequest.ts
@@ -20,6 +20,7 @@ import {
ConnectionRequestTimeoutError,
} from '../errors/ConnectionRequestError';
import { ComposioConnectedAccountNotFoundError } from '../errors/ConnectedAccountsError';
+import { telemetry } from '../telemetry/Telemetry';
export class ConnectionRequest {
private client: ComposioClient;
public id: string;
@@ -36,6 +37,7 @@ export class ConnectionRequest {
this.id = connectedAccountId;
this.status = status || ConnectedAccountStatuses.INITIATED;
this.redirectUrl = redirectUrl;
+ telemetry.instrument(this);
}
/**
diff --git a/packages/core/src/models/CustomTools.ts b/packages/core/src/models/CustomTools.ts
index 40adf1ef0..7399c77e1 100644
--- a/packages/core/src/models/CustomTools.ts
+++ b/packages/core/src/models/CustomTools.ts
@@ -24,6 +24,7 @@ import {
} from '../errors/ToolErrors';
import { ComposioConnectedAccountNotFoundError } from '../errors/ConnectedAccountsError';
import { ComposioError } from '../errors/ComposioError';
+import { telemetry } from '../telemetry/Telemetry';
export class CustomTools {
private readonly client: ComposioClient;
@@ -35,6 +36,7 @@ export class CustomTools {
}
this.client = client;
this.customToolsRegistry = new Map();
+ telemetry.instrument(this);
}
/**
diff --git a/packages/core/src/models/Session.ts b/packages/core/src/models/Session.ts
index 2cbb2d2e2..bba19a3b7 100644
--- a/packages/core/src/models/Session.ts
+++ b/packages/core/src/models/Session.ts
@@ -1,11 +1,13 @@
import { SessionGetInfoResponse } from '@composio/client/resources/auth/session';
import ComposioClient from '@composio/client';
+import { telemetry } from '../telemetry/Telemetry';
export class Session {
private client: ComposioClient;
constructor(client: ComposioClient) {
this.client = client;
+ telemetry.instrument(this);
}
/**
diff --git a/packages/core/src/models/Toolkits.ts b/packages/core/src/models/Toolkits.ts
index 0c91a0641..d04756f8d 100644
--- a/packages/core/src/models/Toolkits.ts
+++ b/packages/core/src/models/Toolkits.ts
@@ -18,7 +18,7 @@ import { AuthConfigs } from './AuthConfigs';
import { ComposioAuthConfigNotFoundError } from '../errors/AuthConfigErrors';
import { ConnectedAccounts } from './ConnectedAccounts';
import { ConnectionRequest } from './ConnectionRequest';
-
+import { telemetry } from '../telemetry/Telemetry';
/**
* Toolkits class
*
@@ -31,6 +31,7 @@ export class Toolkits {
constructor(client: ComposioClient) {
this.client = client;
this.authorize = this.authorize.bind(this);
+ telemetry.instrument(this);
}
/**
* Retrieves a list of toolkits based on the provided query parameters.
diff --git a/packages/core/src/models/Tools.ts b/packages/core/src/models/Tools.ts
index 8cdfba861..0b91efafa 100644
--- a/packages/core/src/models/Tools.ts
+++ b/packages/core/src/models/Tools.ts
@@ -37,7 +37,7 @@ import {
ComposioProviderNotDefinedError,
} from '../errors/ToolErrors';
import { ValidationError } from '../errors/ValidationError';
-
+import { telemetry } from '../telemetry/Telemetry';
/**
* This class is used to manage tools in the Composio SDK.
* It provides methods to list, get, and execute tools.
@@ -70,6 +70,8 @@ export class Tools<
// Bind methods that use customTools to ensure correct 'this' context
this.getRawComposioToolBySlug = this.getRawComposioToolBySlug.bind(this);
this.getRawComposioTools = this.getRawComposioTools.bind(this);
+
+ telemetry.instrument(this);
}
/**
diff --git a/packages/core/src/models/Triggers.ts b/packages/core/src/models/Triggers.ts
index ebc7aadb9..a86aa07b2 100644
--- a/packages/core/src/models/Triggers.ts
+++ b/packages/core/src/models/Triggers.ts
@@ -15,7 +15,7 @@ import { TriggerStatusEnum, TriggerSubscribeParams } from '../types/triggers.typ
import { PusherUtils, TriggerData } from '../utils/pusher';
import logger from '../utils/logger';
import { Session } from './Session';
-
+import { telemetry } from '../telemetry/Telemetry';
/**
* Trigger (Instance) class
* /api/v3/trigger_instances
@@ -26,6 +26,7 @@ export class Triggers {
constructor(client: ComposioClient) {
this.client = client;
+ telemetry.instrument(this);
}
/**
diff --git a/packages/core/src/telemetry/Telemetry.ts b/packages/core/src/telemetry/Telemetry.ts
index 780bae62d..a9ecfd55e 100644
--- a/packages/core/src/telemetry/Telemetry.ts
+++ b/packages/core/src/telemetry/Telemetry.ts
@@ -16,21 +16,21 @@ import { ProcessTelemetryTransport } from './transports/ProcessTransport';
* const telemetry = new Telemetry({...});
* const composio = new Composio({...})
*
- * telemetry.instrumentTelemetry(composio);
- * telemetry.instrumentTelemetry(composio.tools);
- * telemetry.instrumentTelemetry(composio.toolkits);
- * telemetry.instrumentTelemetry(composio.triggers);
+ * telemetry.instrument(composio);
+ * telemetry.instrument(composio.tools);
+ * telemetry.instrument(composio.toolkits);
+ * telemetry.instrument(composio.triggers);
*
*/
-export class Telemetry {
- private telemetryMetadata: TelemetryMetadata;
- private transport: BaseTelemetryTransport;
+export class TelemetryService {
+ private telemetryMetadata!: TelemetryMetadata;
+ private transport!: BaseTelemetryTransport;
private batchProcessor = new BatchProcessor(100, 10, async data => {
await this.sendTelemetry(data as TelemetryPayload[]);
});
- constructor(metadata: TelemetryMetadata, transport?: BaseTelemetryTransport) {
+ setup(metadata: TelemetryMetadata, transport?: BaseTelemetryTransport) {
this.telemetryMetadata = metadata;
const isBrowser = typeof window !== 'undefined';
@@ -61,7 +61,7 @@ export class Telemetry {
* @param fileName - the file name of the instance
* @returns
*/
- instrumentTelemetry<T extends object>(instance: T, fileName?: string) {
+ instrument<T extends object>(instance: T, fileName?: string) {
const proto = Object.getPrototypeOf(instance);
const methodNames = Object.getOwnPropertyNames(proto).filter(key => {
const descriptor = Object.getOwnPropertyDescriptor(proto, key);
@@ -139,3 +139,5 @@ export class Telemetry {
this.transport.send(reqPayload);
}
}
+
+export const telemetry = new TelemetryService();
diff --git a/packages/core/src/telemetry/transports/BrowserTransport.ts b/packages/core/src/telemetry/transports/BrowserTransport.ts
index d872c9fc4..d528054c6 100644
--- a/packages/core/src/telemetry/transports/BrowserTransport.ts
+++ b/packages/core/src/telemetry/transports/BrowserTransport.ts
@@ -1,8 +1,11 @@
import { TelemetryTransportParams } from '../../types/telemetry.types';
import logger from '../../utils/logger';
import { BaseTelemetryTransport } from '../TelemetryTransport';
-
+import { telemetry } from '../Telemetry';
export class BrowserTelemetryTransport implements BaseTelemetryTransport {
+ constructor() {
+ telemetry.instrument(this);
+ }
send(payload: TelemetryTransportParams): Promise<void> {
if (typeof window === 'undefined') {
return Promise.reject(
diff --git a/packages/core/src/telemetry/transports/ProcessTransport.ts b/packages/core/src/telemetry/transports/ProcessTransport.ts
index 0756bd17b..037257d7c 100644
--- a/packages/core/src/telemetry/transports/ProcessTransport.ts
+++ b/packages/core/src/telemetry/transports/ProcessTransport.ts
@@ -1,8 +1,12 @@
import { TelemetryTransportParams } from '../../types/telemetry.types';
import logger from '../../utils/logger';
import { BaseTelemetryTransport } from '../TelemetryTransport';
-
+import { telemetry } from '../Telemetry';
export class ProcessTelemetryTransport implements BaseTelemetryTransport {
+ constructor() {
+ telemetry.instrument(this);
+ }
+
send(payload: TelemetryTransportParams): Promise<void> {
if (typeof window !== 'undefined') {
return Promise.reject(
diff --git a/packages/core/src/types/telemetry.types.ts b/packages/core/src/types/telemetry.types.ts
index 3681d5e8d..8334d2173 100644
--- a/packages/core/src/types/telemetry.types.ts
+++ b/packages/core/src/types/telemetry.types.ts
@@ -13,8 +13,9 @@ export type TelemetryEvent = (typeof TELEMETRY_EVENTS)[keyof typeof TELEMETRY_EV
export type TelemetryMetadata = {
apiKey: string;
baseUrl: string;
- composioVersion: string;
- frameworkRuntime: string;
+ version: string;
+ framework: string;
+ isAgentic: boolean;
source: string;
sessionId: string;
isBrowser?: boolean;
diff --git a/packages/core/src/utils/logger.ts b/packages/core/src/utils/logger.ts
index 7ee6779ad..0e2d106f6 100644
--- a/packages/core/src/utils/logger.ts
+++ b/packages/core/src/utils/logger.ts
@@ -17,7 +17,7 @@ export type LogLevel = keyof typeof LOG_LEVELS;
* @returns {LogLevel} The current log level
*/
export const getLogLevel = (): LogLevel => {
- const envLevel = getEnvVariable('COMPOSIO_LOGGING_LEVEL', 'info')?.toLowerCase();
+ const envLevel = getEnvVariable('COMPOSIO_LOG_LEVEL', 'info')?.toLowerCase();
return envLevel && envLevel in LOG_LEVELS ? (envLevel as LogLevel) : 'info';
};