Classes Reference

Complete reference for all Sherlock AI classes.

SherlockAI

Advanced logging management class.

Constructor:

SherlockAI(config: Optional[LoggingConfig] = None)

Methods:

Set up logging configuration.

logger_manager = SherlockAI()
logger_manager.setup("json")

Change configuration without restart.

logger_manager.reconfigure(new_config)

Clean up handlers and resources.

logger_manager.cleanup()

Get current logging statistics.

stats = logger_manager.get_stats()

Code analysis utilities.

Constructor:

CodeAnalyzer(api_key: Optional[str] = None, constants_file: str = "constants.py")

Methods:

Detect hardcoded values in source code.

values = analyzer.detect_hardcoded_values(source)

Suggest constant name for a value.

name = analyzer.suggest_constant_name("https://api.com", "url", "fetch_data")

MongoDB storage management.

Constructor:

MongoManager(mongo_uri: Optional[str] = None)

Methods:

Save data to MongoDB.

mongo.save(error_data)

Properties:

Check if MongoDB is configured.

if mongo.enabled:
    mongo.save(data)

HTTP client for data ingestion.

Constructor:

ApiClient()  # Uses environment variables

Methods:

Send error insights to backend.

api_client.post_error_insights(error_data)

Send performance insights to backend.

api_client.post_performance_insights(perf_data)

Resource monitoring utilities.

Static Methods:

Capture current resource snapshot.

snapshot = ResourceMonitor.capture_resources()

Capture memory snapshot.

memory = ResourceMonitor.capture_memory()

Format bytes in human-readable format.

formatted = ResourceMonitor.format_bytes(1024*1024*512)  # "512.00MB"