@kano/debug-logger

@stemfm/debug-logger

A unified debug logging system for StemFM applications, providing comprehensive logging, performance monitoring, and debugging capabilities.

Features

• Unified logging system with categorization
• Performance monitoring and metrics
• Memory usage tracking
• Network request/response monitoring
• React hooks for component integration
• GraphQL operation tracking
• Audio chunk monitoring
• Source mapping and stack trace analysis

Installation

yarn add @stemfm/debug-logger

Basic Usage

import debugLogger from '@stemfm/debug-logger';

// Enable logging
debugLogger.enable();

// Log messages
debugLogger.log('NETWORK', 'API Request', { url: '/api/endpoint' });

// Enable specific categories
debugLogger.enableCategory('AUDIO');
debugLogger.enableCategory('PERFORMANCE');

React Integration

import { useDebugLogger } from '@stemfm/debug-logger';

function MyComponent() {
    const logger = useDebugLogger({
        componentName: 'MyComponent',
        trackProps: true,
        trackLifecycle: true
    });

    logger.log('Component initialized');
    
    return <div>My Component</div>;
}

Performance Monitoring

import { useDebugMetrics } from '@stemfm/debug-logger';

function PerformanceMonitor() {
    const metrics = useDebugMetrics();
    
    // Access performance metrics
    console.log('Network stats:', metrics?.network);
    console.log('Memory usage:', metrics?.memory);
    
    return null;
}

Categories

• NETWORK: Network requests and responses
• AUDIO: Audio processing and playback
• COMPONENT: React component lifecycle
• MEMORY: Memory usage and leaks
• ERROR: Error tracking
• SYSTEM: System-level events
• AUDIO_ENGINE: Audio engine operations
• THE_MAGI: The MAGI system events
• SEARCH: Search operations
• STATION: Station-related events
• DEBUG: General debugging
• BANDWIDTH: Bandwidth usage
• PERFORMANCE: Performance metrics

Configuration

debugLogger.updateConfig({
    enabled: true,
    maxStoredLogs: 1000,
    persistLogs: true,
    consoleOutput: true,
    performanceMonitoring: {
        enabled: true,
        sampleRate: 60000,
        retentionPeriod: 3600000
    }
});

Development

# Install dependencies
yarn install

# Build package
yarn build

# Run tests
yarn test

# Run linter
yarn lint

License

Private - StemFM