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.

Handle error telemetry

haxzie5f5eec2d8a25
diff --git a/packages/core/src/errors/ComposioError.ts b/packages/core/src/errors/ComposioError.ts
index 17becee28..0de54066f 100644
--- a/packages/core/src/errors/ComposioError.ts
+++ b/packages/core/src/errors/ComposioError.ts
@@ -1,3 +1,5 @@
+import { telemetry } from '../telemetry/Telemetry';
+
/**
* @fileoverview Error class for Composio.
*
@@ -14,6 +16,7 @@ export type ComposioErrorOptions = {
cause?: unknown;
meta?: Record<string, unknown>;
possibleFixes?: string[];
+ stack?: string;
};
export class ComposioError extends Error {
public name = 'ComposioError';
@@ -22,6 +25,7 @@ export class ComposioError extends Error {
public readonly cause?: unknown;
public readonly meta?: Record<string, unknown>;
public readonly possibleFixes?: string[];
+ public readonly stack?: string;
constructor(message: string, options: ComposioErrorOptions = {}) {
super(message);
diff --git a/packages/core/src/telemetry/Telemetry.ts b/packages/core/src/telemetry/Telemetry.ts
index d24198a71..1929a7204 100644
--- a/packages/core/src/telemetry/Telemetry.ts
+++ b/packages/core/src/telemetry/Telemetry.ts
@@ -1,10 +1,19 @@
-import { TELEMETRY_EVENTS, TelemetryMetadata, TelemetryPayload } from '../types/telemetry.types';
+import { ComposioError as ComposioClientError } from '@composio/client';
+import {
+ TELEMETRY_EVENTS,
+ TelemetryErrorPayload,
+ TelemetryErrorPayloadParams,
+ TelemetryMetadata,
+ TelemetryPayload,
+ TelemetryPayloadParams,
+} from '../types/telemetry.types';
import { TELEMETRY_URL } from '../utils/constants';
import { getEnvVariable } from '../utils/env';
import { BatchProcessor } from './BatchProcessor';
import { BaseTelemetryTransport } from './TelemetryTransport';
import { BrowserTelemetryTransport } from './transports/BrowserTransport';
import { ProcessTelemetryTransport } from './transports/ProcessTransport';
+import { ComposioError } from '../errors/ComposioError';
/**
* The Telemetry class is used to log the telemetry for any given instance which extends InstrumentedInstance.
*
@@ -85,14 +94,13 @@ export class TelemetryService {
) => Promise<unknown>;
(instance as unknown as Record<string, Function>)[name] = async (...args: unknown[]) => {
- const telemetryPayload: TelemetryPayload = {
+ const telemetryPayload: TelemetryPayloadParams = {
eventName: TELEMETRY_EVENTS.SDK_METHOD_INVOKED,
data: {
fileName: instrumentedClassName,
method: name,
params: args,
},
- sdk_meta: this.telemetryMetadata,
};
this.batchProcessor.pushItem(telemetryPayload);
@@ -100,23 +108,46 @@ export class TelemetryService {
try {
return await originalMethod.apply(instance, args);
} catch (error) {
- const telemetryPayload: TelemetryPayload = {
- eventName: TELEMETRY_EVENTS.SDK_METHOD_ERROR,
- data: {
- fileName: instrumentedClassName,
- method: name,
- params: args,
- error: error,
- },
- sdk_meta: this.telemetryMetadata,
- };
- this.batchProcessor.pushItem(telemetryPayload);
+ // client error, this is likely handled by the API itseld
+ if (error instanceof ComposioClientError) {
+ const telemetryPayload: TelemetryErrorPayloadParams = {
+ error_id: error.name,
+ error_message: error.message,
+ original_error: error.cause,
+ current_stack: error.stack?.split('\n') || [],
+ description: `${this.telemetryMetadata.source}:${instrumentedClassName}.${name}`,
+ };
+ this.batchProcessor.pushItem(telemetryPayload);
+ } else if (error instanceof ComposioError) {
+ // Composio SDK Errors
+ const telemetryPayload: TelemetryErrorPayloadParams = {
+ error_id: error.name,
+ error_message: error.message,
+ original_error: error.cause,
+ current_stack: error.stack?.split('\n') || [],
+ error_code: error.code,
+ possible_fix: error.possibleFixes?.join('\n'),
+ description: `${this.telemetryMetadata.source}:${instrumentedClassName}.${name}`,
+ };
+ this.batchProcessor.pushItem(telemetryPayload);
+ } else if (error instanceof Error) {
+ // Unhandled errors
+ const telemetryPayload: TelemetryErrorPayloadParams = {
+ error_id: error.name,
+ error_message: error instanceof Error ? error.name : 'Unknown error',
+ original_error: error,
+ current_stack: error.stack?.split('\n') || [],
+ description: `${this.telemetryMetadata.source}:${instrumentedClassName}.${name}`,
+ };
+ this.batchProcessor.pushItem(telemetryPayload);
+ }
+ // rethrow the error to be handled by the caller
throw error;
}
};
- }
- return instance;
+ return instance;
+ }
}
/**
@@ -139,7 +170,7 @@ export class TelemetryService {
* @param payload - the telemetry payload to send
* @returns
*/
- async sendTelemetry(payload: TelemetryPayload[]) {
+ async sendTelemetry(payload: TelemetryPayloadParams[]) {
if (!this.shouldSendTelemetry()) {
return;
}
@@ -147,7 +178,10 @@ export class TelemetryService {
const url = `${TELEMETRY_URL}/api/sdk_metrics/telemetry`;
const reqPayload = {
- data: payload,
+ data: payload.map(p => ({
+ ...p,
+ sdk_meta: this.telemetryMetadata,
+ })),
url,
method: 'POST',
headers: { 'Content-Type': 'application/json' },
@@ -156,7 +190,7 @@ export class TelemetryService {
this.transport.send(reqPayload);
}
- async sendErrorTelemetry(error: Error) {
+ async sendErrorTelemetry(payload: TelemetryErrorPayload) {
if (!this.shouldSendTelemetry()) {
return;
}
@@ -164,7 +198,10 @@ export class TelemetryService {
const url = `${TELEMETRY_URL}/api/sdk_metrics/error`;
const reqPayload = {
- data: { error },
+ data: {
+ ...payload,
+ sdk_meta: this.telemetryMetadata,
+ },
url,
method: 'POST',
headers: { 'Content-Type': 'application/json' },
diff --git a/packages/core/src/types/telemetry.types.ts b/packages/core/src/types/telemetry.types.ts
index 9831ce7d9..478e055c8 100644
--- a/packages/core/src/types/telemetry.types.ts
+++ b/packages/core/src/types/telemetry.types.ts
@@ -14,7 +14,7 @@ export type TelemetryMetadata = {
apiKey: string;
baseUrl: string;
version: string;
- framework: string;
+ frameworkRuntime: string;
isAgentic: boolean;
source: string;
transport?: string;
@@ -23,9 +23,24 @@ export type TelemetryMetadata = {
isBrowser?: boolean;
};
-export type TelemetryPayload = {
+export type TelemetryPayloadParams = {
eventName: TelemetryEvent;
data: Record<string, unknown>;
+};
+export type TelemetryPayload = TelemetryPayloadParams & {
+ sdk_meta: TelemetryMetadata;
+};
+
+export type TelemetryErrorPayloadParams = {
+ error_id: string;
+ error_message: string;
+ original_error: unknown;
+ error_code?: string | undefined;
+ possible_fix?: string | undefined;
+ description?: string;
+ current_stack?: string[];
+};
+export type TelemetryErrorPayload = TelemetryErrorPayloadParams & {
sdk_meta: TelemetryMetadata;
};