|
| 1 | +""" |
| 2 | +Example demonstrating dynamic log level control with structlog. |
| 3 | +
|
| 4 | +This example shows how to use the LoggerProcessor to dynamically control log levels |
| 5 | +based on Reforge configuration. The log level can be changed in real-time through |
| 6 | +the Reforge dashboard without restarting the application. |
| 7 | +""" |
| 8 | + |
| 9 | +import time |
| 10 | +import os |
| 11 | +import structlog |
| 12 | +from sdk_reforge import ReforgeSDK, Options, LoggerProcessor |
| 13 | + |
| 14 | + |
| 15 | +class CustomLoggerNameProcessor(LoggerProcessor): |
| 16 | + """ |
| 17 | + Custom processor that extracts the logger name from the module field. |
| 18 | +
|
| 19 | + This demonstrates how to customize the logger name lookup for more |
| 20 | + sophisticated log level rules based on module names. |
| 21 | + """ |
| 22 | + |
| 23 | + def logger_name(self, logger, event_dict: dict) -> str: |
| 24 | + # Use the module name as the logger name for Reforge evaluation |
| 25 | + return event_dict.get("module") or "unknown" |
| 26 | + |
| 27 | + |
| 28 | +def main(): |
| 29 | + """ |
| 30 | + Configure structlog with Reforge dynamic log level control. |
| 31 | + """ |
| 32 | + # Configure structlog with our processor |
| 33 | + # Note: The LoggerProcessor must come after add_log_level |
| 34 | + structlog.configure( |
| 35 | + processors=[ |
| 36 | + structlog.processors.TimeStamper(fmt="iso"), |
| 37 | + structlog.stdlib.add_log_level, # Must come before LoggerProcessor |
| 38 | + structlog.processors.CallsiteParameterAdder( |
| 39 | + { |
| 40 | + structlog.processors.CallsiteParameter.THREAD_NAME, |
| 41 | + structlog.processors.CallsiteParameter.FILENAME, |
| 42 | + structlog.processors.CallsiteParameter.FUNC_NAME, |
| 43 | + structlog.processors.CallsiteParameter.LINENO, |
| 44 | + structlog.processors.CallsiteParameter.PROCESS, |
| 45 | + structlog.processors.CallsiteParameter.MODULE, |
| 46 | + } |
| 47 | + ), |
| 48 | + CustomLoggerNameProcessor().processor, # Add Reforge log level control |
| 49 | + structlog.dev.ConsoleRenderer(pad_event=25), |
| 50 | + ] |
| 51 | + ) |
| 52 | + |
| 53 | + logger = structlog.getLogger() |
| 54 | + |
| 55 | + # Configure SDK to run in local-only mode for this example |
| 56 | + # In production, you would set your REFORGE_SDK_KEY instead |
| 57 | + os.environ["REFORGE_DATASOURCES"] = "LOCAL_ONLY" |
| 58 | + |
| 59 | + def on_ready(): |
| 60 | + """Called when SDK is ready""" |
| 61 | + logger.info("✓ SDK ready - log levels now controlled by Reforge") |
| 62 | + |
| 63 | + # Create SDK |
| 64 | + options = Options( |
| 65 | + x_datafile="test.datafile.json", # In production, omit this for remote config |
| 66 | + on_ready_callback=on_ready, |
| 67 | + logger_key="log-levels.default", # Config key that controls log levels |
| 68 | + ) |
| 69 | + |
| 70 | + sdk = ReforgeSDK(options) |
| 71 | + |
| 72 | + logger.info("Starting structlog example") |
| 73 | + logger.info( |
| 74 | + "Try changing the 'log-levels.default' config in Reforge dashboard " |
| 75 | + "to see log output change dynamically!" |
| 76 | + ) |
| 77 | + |
| 78 | + # Log messages at different levels in a loop |
| 79 | + try: |
| 80 | + for i in range(60): # Run for 60 seconds |
| 81 | + # Get a config value to show SDK is working |
| 82 | + config_value = sdk.get("example-config", default="default-value") |
| 83 | + |
| 84 | + logger.debug( |
| 85 | + f"[{i}] Debug message", |
| 86 | + config_value=config_value, |
| 87 | + level_hint="Only visible when level is DEBUG", |
| 88 | + ) |
| 89 | + logger.info( |
| 90 | + f"[{i}] Info message", |
| 91 | + config_value=config_value, |
| 92 | + level_hint="Visible when level is INFO or below", |
| 93 | + ) |
| 94 | + logger.warning( |
| 95 | + f"[{i}] Warning message", |
| 96 | + config_value=config_value, |
| 97 | + level_hint="Visible when level is WARN or below", |
| 98 | + ) |
| 99 | + logger.error( |
| 100 | + f"[{i}] Error message", |
| 101 | + config_value=config_value, |
| 102 | + level_hint="Visible when level is ERROR or below", |
| 103 | + ) |
| 104 | + time.sleep(1) |
| 105 | + except KeyboardInterrupt: |
| 106 | + logger.info("Shutting down...") |
| 107 | + |
| 108 | + sdk.close() |
| 109 | + |
| 110 | + |
| 111 | +if __name__ == "__main__": |
| 112 | + main() |
0 commit comments