Rename logging env vars. Set default dest to stdout

Author: bkryu

benchmarks/bench_logging_overhead.py

@@ -12,14 +12,14 @@
 
 Usage:
     # Set the logging level before running
-    export FLASHINFER_APILOG_LEVEL=2
+    export FLASHINFER_LOGLEVEL_DBG=2
     python bench_logging_overhead.py
 
     # Or run with different levels
-    FLASHINFER_APILOG_LEVEL=0 python bench_logging_overhead.py
-    FLASHINFER_APILOG_LEVEL=1 python bench_logging_overhead.py
-    FLASHINFER_APILOG_LEVEL=2 python bench_logging_overhead.py
-    FLASHINFER_APILOG_LEVEL=3 python bench_logging_overhead.py
+    FLASHINFER_LOGLEVEL_DBG=0 python bench_logging_overhead.py
+    FLASHINFER_LOGLEVEL_DBG=1 python bench_logging_overhead.py
+    FLASHINFER_LOGLEVEL_DBG=2 python bench_logging_overhead.py
+    FLASHINFER_LOGLEVEL_DBG=3 python bench_logging_overhead.py
 
     # Or use the helper script to run all levels
     bash benchmark_all_levels.sh
@@ -33,8 +33,8 @@
 from typing import List, Tuple
 
 # Get logging level BEFORE importing flashinfer
-LOGGING_LEVEL = int(os.environ.get("FLASHINFER_APILOG_LEVEL", "0"))
-LOG_DEST = os.environ.get("FLASHINFER_APILOG_DEST", "/tmp/flashinfer_benchmark_log.txt")
+LOGGING_LEVEL = int(os.environ.get("FLASHINFER_LOGLEVEL_DBG", "0"))
+LOG_DEST = os.environ.get("FLASHINFER_LOGDEST_DBG", "/tmp/flashinfer_benchmark_log.txt")
 
 # Import the decorator
 try:
@@ -226,8 +226,8 @@ def main():
 
     # Display logging configuration
     print("\nLogging Configuration:")
-    print(f"  FLASHINFER_APILOG_LEVEL = {LOGGING_LEVEL}")
-    print(f"  FLASHINFER_APILOG_DEST = {LOG_DEST}")
+    print(f"  FLASHINFER_LOGLEVEL_DBG = {LOGGING_LEVEL}")
+    print(f"  FLASHINFER_LOGDEST_DBG = {LOG_DEST}")
 
     # Get level name
     level_names = {
@@ -331,7 +331,7 @@ def main():
     print("\nTo benchmark other levels, run:")
     for level in [0, 1, 2, 3]:
         if level != LOGGING_LEVEL:
-            print(f"  FLASHINFER_APILOG_LEVEL={level} python {sys.argv[0]}")
+            print(f"  FLASHINFER_LOGLEVEL_DBG={level} python {sys.argv[0]}")
 
     print("\n" + "=" * 80)
     print("Benchmark complete!")

flashinfer/api_logging.py

@@ -26,8 +26,8 @@
 
 
 # Read environment variables once at module load time
-_API_LOG_LEVEL = int(os.environ.get("FLASHINFER_APILOG_LEVEL", "0"))
-_API_LOG_DEST = os.environ.get("FLASHINFER_APILOG_DEST", "./flashinfer_log.txt")
+_API_LOG_LEVEL = int(os.environ.get("FLASHINFER_LOGLEVEL_DBG", "0"))
+_API_LOG_DEST = os.environ.get("FLASHINFER_LOGDEST_DBG", "stdout")
 
 # Create logger using Python's logging library
 _logger = logging.getLogger("flashinfer.api")
@@ -41,7 +41,7 @@ def _setup_logger():
         _logger.setLevel(logging.CRITICAL + 1)  # Higher than any level
         return
 
-    # All enabled levels use loggging.DEBUG; verbosity is controlled by FLASHINFER_APILOG_LEVEL instead
+    # All enabled levels use loggging.DEBUG; verbosity is controlled by FLASHINFER_LOGLEVEL_DBG instead
     _logger.setLevel(logging.DEBUG)
 
     # Remove any existing handlers
@@ -446,17 +446,17 @@ def flashinfer_api_log(func: Callable = None) -> Callable:
     Decorator to log FlashInfer API calls using Python's logging library.
 
     This decorator integrates with Python's standard logging infrastructure while
-    maintaining zero overhead when disabled (FLASHINFER_APILOG_LEVEL=0).
+    maintaining zero overhead when disabled (FLASHINFER_LOGLEVEL_DBG=0).
 
     Environment Variables
     ---------------------
-    FLASHINFER_APILOG_LEVEL : int (default: 0)
+    FLASHINFER_LOGLEVEL_DBG : int (default: 0)
         - 0: No logging (zero overhead - decorator returns original function)
         - 1: Log function name only (logged BEFORE execution - crash-safe)
         - 2: Log function name + inputs/outputs with metadata (inputs logged BEFORE execution - crash-safe)
         - 3: Log function name + inputs/outputs with metadata + tensor statistics (inputs logged BEFORE execution - crash-safe)
 
-    FLASHINFER_APILOG_DEST : str (default: "./flashinfer_log.txt")
+    FLASHINFER_LOGDEST_DBG : str (default: "stdout")
         - "stdout": Log to standard output
         - "stderr": Log to standard error
         - <path>: Log to specified file path
@@ -471,7 +471,7 @@ def flashinfer_api_log(func: Callable = None) -> Callable:
 
     Notes
     -----
-    - When FLASHINFER_APILOG_LEVEL=0, the decorator has truly zero overhead
+    - When FLASHINFER_LOGLEVEL_DBG=0, the decorator has truly zero overhead
       as it returns the original function unchanged.
     - Function names and inputs are logged BEFORE execution:
       - Level 1: Function name only

tests/utils/test_logging.py

@@ -47,30 +47,30 @@ class TestAPILogging:
     def setup_and_teardown(self):
         """Reset environment and reimport logging module for each test."""
         # Store original environment
-        original_level = os.environ.get("FLASHINFER_APILOG_LEVEL")
-        original_dest = os.environ.get("FLASHINFER_APILOG_DEST")
+        original_level = os.environ.get("FLASHINFER_LOGLEVEL_DBG")
+        original_dest = os.environ.get("FLASHINFER_LOGDEST_DBG")
 
         yield
 
         # Restore original environment
         if original_level is not None:
-            os.environ["FLASHINFER_APILOG_LEVEL"] = original_level
-        elif "FLASHINFER_APILOG_LEVEL" in os.environ:
-            del os.environ["FLASHINFER_APILOG_LEVEL"]
+            os.environ["FLASHINFER_LOGLEVEL_DBG"] = original_level
+        elif "FLASHINFER_LOGLEVEL_DBG" in os.environ:
+            del os.environ["FLASHINFER_LOGLEVEL_DBG"]
 
         if original_dest is not None:
-            os.environ["FLASHINFER_APILOG_DEST"] = original_dest
-        elif "FLASHINFER_APILOG_DEST" in os.environ:
-            del os.environ["FLASHINFER_APILOG_DEST"]
+            os.environ["FLASHINFER_LOGDEST_DBG"] = original_dest
+        elif "FLASHINFER_LOGDEST_DBG" in os.environ:
+            del os.environ["FLASHINFER_LOGDEST_DBG"]
 
         # Force reimport to pick up new environment variables
         if "flashinfer.api_logging" in sys.modules:
             del sys.modules["flashinfer.api_logging"]
 
     def setup_logging(self, level: int, dest: str = "stdout"):
         """Helper to set up logging environment and reimport."""
-        os.environ["FLASHINFER_APILOG_LEVEL"] = str(level)
-        os.environ["FLASHINFER_APILOG_DEST"] = dest
+        os.environ["FLASHINFER_LOGLEVEL_DBG"] = str(level)
+        os.environ["FLASHINFER_LOGDEST_DBG"] = dest
 
         # Force reimport
         if "flashinfer.api_logging" in sys.modules: