import type RudderStack from '@rudderstack/rudder-sdk-node'; import { PostHogClient } from '@/posthog'; import { Container, Service } from 'typedi'; import type { ITelemetryTrackProperties } from 'n8n-workflow'; import config from '@/config'; import type { IExecutionTrackProperties } from '@/Interfaces'; import { Logger } from '@/Logger'; import { License } from '@/License'; import { LicenseService } from '@/license/License.service'; import { N8N_VERSION } from '@/constants'; import { SourceControlPreferencesService } from '../environments/sourceControl/sourceControlPreferences.service.ee'; import { InstanceSettings } from 'n8n-core'; type ExecutionTrackDataKey = 'manual_error' | 'manual_success' | 'prod_error' | 'prod_success'; interface IExecutionTrackData { count: number; first: Date; } interface IExecutionsBuffer { [workflowId: string]: { manual_error?: IExecutionTrackData; manual_success?: IExecutionTrackData; prod_error?: IExecutionTrackData; prod_success?: IExecutionTrackData; user_id: string | undefined; }; } @Service() export class Telemetry { private rudderStack?: RudderStack; private pulseIntervalReference: NodeJS.Timeout; private executionCountsBuffer: IExecutionsBuffer = {}; constructor( private readonly logger: Logger, private postHog: PostHogClient, private license: License, private readonly instanceSettings: InstanceSettings, ) {} async init() { const enabled = config.getEnv('diagnostics.enabled'); if (enabled) { const conf = config.getEnv('diagnostics.config.backend'); const [key, url] = conf.split(';'); if (!key || !url) { this.logger.warn('Diagnostics backend config is invalid'); return; } const logLevel = config.getEnv('logs.level'); // eslint-disable-next-line @typescript-eslint/naming-convention const { default: RudderStack } = await import('@rudderstack/rudder-sdk-node'); this.rudderStack = new RudderStack(key, url, { logLevel }); this.startPulse(); } } private startPulse() { this.pulseIntervalReference = setInterval( async () => { void this.pulse(); }, 6 * 60 * 60 * 1000, ); // every 6 hours } private async pulse(): Promise { if (!this.rudderStack) { return; } const allPromises = Object.keys(this.executionCountsBuffer) .filter((workflowId) => { const data = this.executionCountsBuffer[workflowId]; const sum = (data.manual_error?.count ?? 0) + (data.manual_success?.count ?? 0) + (data.prod_error?.count ?? 0) + (data.prod_success?.count ?? 0); return sum > 0; }) .map(async (workflowId) => { const promise = this.track('Workflow execution count', { event_version: '2', workflow_id: workflowId, ...this.executionCountsBuffer[workflowId], }); return promise; }); this.executionCountsBuffer = {}; const sourceControlPreferences = Container.get( SourceControlPreferencesService, ).getPreferences(); // License info const pulsePacket = { plan_name_current: this.license.getPlanName(), quota: this.license.getTriggerLimit(), usage: await LicenseService.getActiveTriggerCount(), source_control_set_up: Container.get(SourceControlPreferencesService).isSourceControlSetup(), branchName: sourceControlPreferences.branchName, read_only_instance: sourceControlPreferences.branchReadOnly, }; allPromises.push(this.track('pulse', pulsePacket)); return Promise.all(allPromises); } async trackWorkflowExecution(properties: IExecutionTrackProperties): Promise { if (this.rudderStack) { const execTime = new Date(); const workflowId = properties.workflow_id; this.executionCountsBuffer[workflowId] = this.executionCountsBuffer[workflowId] ?? { user_id: properties.user_id, }; const key: ExecutionTrackDataKey = `${properties.is_manual ? 'manual' : 'prod'}_${ properties.success ? 'success' : 'error' }`; if (!this.executionCountsBuffer[workflowId][key]) { this.executionCountsBuffer[workflowId][key] = { count: 1, first: execTime, }; } else { this.executionCountsBuffer[workflowId][key]!.count++; } if ( !properties.success && properties.is_manual && properties.error_node_type?.startsWith('n8n-nodes-base') ) { void this.track('Workflow execution errored', properties); } } } async trackN8nStop(): Promise { clearInterval(this.pulseIntervalReference); void this.track('User instance stopped'); return new Promise(async (resolve) => { await this.postHog.stop(); if (this.rudderStack) { this.rudderStack.flush(resolve); } else { resolve(); } }); } async identify(traits?: { [key: string]: string | number | boolean | object | undefined | null; }): Promise { const { instanceId } = this.instanceSettings; return new Promise((resolve) => { if (this.rudderStack) { this.rudderStack.identify( { userId: instanceId, traits: { ...traits, instanceId }, }, resolve, ); } else { resolve(); } }); } async track( eventName: string, properties: ITelemetryTrackProperties = {}, { withPostHog } = { withPostHog: false }, // whether to additionally track with PostHog ): Promise { const { instanceId } = this.instanceSettings; return new Promise((resolve) => { if (this.rudderStack) { const { user_id } = properties; const updatedProperties: ITelemetryTrackProperties = { ...properties, instance_id: instanceId, version_cli: N8N_VERSION, }; const payload = { userId: `${instanceId}${user_id ? `#${user_id}` : ''}`, event: eventName, properties: updatedProperties, }; if (withPostHog) { this.postHog?.track(payload); } return this.rudderStack.track(payload, resolve); } return resolve(); }); } // test helpers getCountsBuffer(): IExecutionsBuffer { return this.executionCountsBuffer; } }