mirror of
https://github.com/czlonkowski/n8n-mcp.git
synced 2026-03-21 09:53:08 +00:00
feat: add anonymous telemetry system with Supabase integration
- Implement telemetry manager for tracking tool usage and workflows - Add workflow sanitizer to remove sensitive data before storage - Create config manager with opt-in/opt-out mechanism - Integrate telemetry tracking into MCP server and workflow handlers - Add CLI commands for telemetry control (enable/disable/status) - Show first-run notice with clear privacy information - Add comprehensive unit tests for sanitization and config - Track tool usage metrics, workflow patterns, and errors - Ensure complete anonymity with deterministic user IDs - Never collect URLs, API keys, or sensitive information
This commit is contained in:
czlonkowski
207
src/telemetry/config-manager.ts
Normal file
207
src/telemetry/config-manager.ts
Normal file
@@ -0,0 +1,207 @@
|
||||
/**
|
||||
* Telemetry Configuration Manager
|
||||
* Handles telemetry settings, opt-in/opt-out, and first-run detection
|
||||
*/
|
||||
|
||||
import { existsSync, readFileSync, writeFileSync, mkdirSync } from 'fs';
|
||||
import { join } from 'path';
|
||||
import { homedir } from 'os';
|
||||
import { createHash } from 'crypto';
|
||||
import { hostname, platform, arch } from 'os';
|
||||
|
||||
export interface TelemetryConfig {
|
||||
enabled: boolean;
|
||||
userId: string;
|
||||
firstRun?: string;
|
||||
lastModified?: string;
|
||||
version?: string;
|
||||
}
|
||||
|
||||
export class TelemetryConfigManager {
|
||||
private static instance: TelemetryConfigManager;
|
||||
private readonly configDir: string;
|
||||
private readonly configPath: string;
|
||||
private config: TelemetryConfig | null = null;
|
||||
|
||||
private constructor() {
|
||||
this.configDir = join(homedir(), '.n8n-mcp');
|
||||
this.configPath = join(this.configDir, 'telemetry.json');
|
||||
}
|
||||
|
||||
static getInstance(): TelemetryConfigManager {
|
||||
if (!TelemetryConfigManager.instance) {
|
||||
TelemetryConfigManager.instance = new TelemetryConfigManager();
|
||||
}
|
||||
return TelemetryConfigManager.instance;
|
||||
}
|
||||
|
||||
/**
|
||||
* Generate a deterministic anonymous user ID based on machine characteristics
|
||||
*/
|
||||
private generateUserId(): string {
|
||||
const machineId = `${hostname()}-${platform()}-${arch()}-${homedir()}`;
|
||||
return createHash('sha256').update(machineId).digest('hex').substring(0, 16);
|
||||
}
|
||||
|
||||
/**
|
||||
* Load configuration from disk or create default
|
||||
*/
|
||||
loadConfig(): TelemetryConfig {
|
||||
if (this.config) {
|
||||
return this.config;
|
||||
}
|
||||
|
||||
if (!existsSync(this.configPath)) {
|
||||
// First run - create default config
|
||||
this.config = {
|
||||
enabled: true,
|
||||
userId: this.generateUserId(),
|
||||
firstRun: new Date().toISOString(),
|
||||
version: require('../../package.json').version
|
||||
};
|
||||
|
||||
this.saveConfig();
|
||||
this.showFirstRunNotice();
|
||||
|
||||
return this.config;
|
||||
}
|
||||
|
||||
try {
|
||||
const rawConfig = readFileSync(this.configPath, 'utf-8');
|
||||
this.config = JSON.parse(rawConfig);
|
||||
|
||||
// Ensure userId exists (for upgrades from older versions)
|
||||
if (!this.config!.userId) {
|
||||
this.config!.userId = this.generateUserId();
|
||||
this.saveConfig();
|
||||
}
|
||||
|
||||
return this.config!;
|
||||
} catch (error) {
|
||||
console.error('Failed to load telemetry config, using defaults:', error);
|
||||
this.config = {
|
||||
enabled: false,
|
||||
userId: this.generateUserId()
|
||||
};
|
||||
return this.config;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Save configuration to disk
|
||||
*/
|
||||
private saveConfig(): void {
|
||||
if (!this.config) return;
|
||||
|
||||
try {
|
||||
if (!existsSync(this.configDir)) {
|
||||
mkdirSync(this.configDir, { recursive: true });
|
||||
}
|
||||
|
||||
this.config.lastModified = new Date().toISOString();
|
||||
writeFileSync(this.configPath, JSON.stringify(this.config, null, 2));
|
||||
} catch (error) {
|
||||
console.error('Failed to save telemetry config:', error);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if telemetry is enabled
|
||||
*/
|
||||
isEnabled(): boolean {
|
||||
const config = this.loadConfig();
|
||||
return config.enabled;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the anonymous user ID
|
||||
*/
|
||||
getUserId(): string {
|
||||
const config = this.loadConfig();
|
||||
return config.userId;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if this is the first run
|
||||
*/
|
||||
isFirstRun(): boolean {
|
||||
return !existsSync(this.configPath);
|
||||
}
|
||||
|
||||
/**
|
||||
* Enable telemetry
|
||||
*/
|
||||
enable(): void {
|
||||
const config = this.loadConfig();
|
||||
config.enabled = true;
|
||||
this.config = config;
|
||||
this.saveConfig();
|
||||
console.log('✓ Anonymous telemetry enabled');
|
||||
}
|
||||
|
||||
/**
|
||||
* Disable telemetry
|
||||
*/
|
||||
disable(): void {
|
||||
const config = this.loadConfig();
|
||||
config.enabled = false;
|
||||
this.config = config;
|
||||
this.saveConfig();
|
||||
console.log('✓ Anonymous telemetry disabled');
|
||||
}
|
||||
|
||||
/**
|
||||
* Get current status
|
||||
*/
|
||||
getStatus(): string {
|
||||
const config = this.loadConfig();
|
||||
return `
|
||||
Telemetry Status: ${config.enabled ? 'ENABLED' : 'DISABLED'}
|
||||
Anonymous ID: ${config.userId}
|
||||
First Run: ${config.firstRun || 'Unknown'}
|
||||
Config Path: ${this.configPath}
|
||||
|
||||
To opt-out: npx n8n-mcp telemetry disable
|
||||
To opt-in: npx n8n-mcp telemetry enable
|
||||
`;
|
||||
}
|
||||
|
||||
/**
|
||||
* Show first-run notice to user
|
||||
*/
|
||||
private showFirstRunNotice(): void {
|
||||
console.log(`
|
||||
╔════════════════════════════════════════════════════════════╗
|
||||
║ Anonymous Usage Statistics ║
|
||||
╠════════════════════════════════════════════════════════════╣
|
||||
║ ║
|
||||
║ n8n-mcp collects anonymous usage data to improve the ║
|
||||
║ tool and understand how it's being used. ║
|
||||
║ ║
|
||||
║ We track: ║
|
||||
║ • Which MCP tools are used (no parameters) ║
|
||||
║ • Workflow structures (sanitized, no sensitive data) ║
|
||||
║ • Error patterns (hashed, no details) ║
|
||||
║ • Performance metrics (timing, success rates) ║
|
||||
║ ║
|
||||
║ We NEVER collect: ║
|
||||
║ • URLs, API keys, or credentials ║
|
||||
║ • Workflow content or actual data ║
|
||||
║ • Personal or identifiable information ║
|
||||
║ • n8n instance details or locations ║
|
||||
║ ║
|
||||
║ Your anonymous ID: ${this.config?.userId || 'generating...'} ║
|
||||
║ ║
|
||||
║ This helps me understand usage patterns and improve ║
|
||||
║ n8n-mcp for everyone. Thank you for your support! ║
|
||||
║ ║
|
||||
║ To opt-out at any time: ║
|
||||
║ npx n8n-mcp telemetry disable ║
|
||||
║ ║
|
||||
║ Learn more: ║
|
||||
║ https://github.com/czlonkowski/n8n-mcp/privacy ║
|
||||
║ ║
|
||||
╚════════════════════════════════════════════════════════════╝
|
||||
`);
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user