API Reference

Complete API documentation for Sherlock AI.

Initialization

SherlockAI

Main class for initialising logging.

from sherlock_ai import SherlockAI, LoggingConfig

# Default configuration (JSON format)
SherlockAI().setup()

# Custom configuration
config = LoggingConfig(log_format_type="log", console_level="DEBUG")
logger_manager = SherlockAI(config)
logger_manager.setup()

# Reconfigure at runtime
logger_manager.reconfigure(LoggingConfig(console_level="WARNING"))

get_logger()

Get a logger instance.

from sherlock_ai import get_logger, LoggerNames

logger = get_logger(__name__)
logger = get_logger(LoggerNames.PERFORMANCE)

Decorators

View Decorators Reference →

• @log_performance - Track execution times
• @monitor_memory - Monitor memory usage
• @monitor_resources - Monitor system resources
• @sherlock_error_handler - AI-powered error analysis
• @hardcoded_value_detector - Detect hardcoded values
• @sherlock_performance_insights - Performance analysis

Classes

View Classes Reference →

• SherlockAI - Main logging manager class
• CodeAnalyzer - Code analysis utilities
• MongoManager - MongoDB storage
• ApiClient - HTTP client for data ingestion
• ResourceMonitor - Resource monitoring utilities

Configuration

View Configuration Reference →

• LoggingConfig - Main configuration class
• LogFileConfig - Log file configuration
• LoggerConfig - Logger configuration

Utilities

View Utilities Reference →

• set_request_id() - Set request ID
• get_request_id() - Get current request ID
• list_available_loggers() - List available loggers
• get_logging_stats() - Get logging statistics
• get_current_config() - Get current configuration