log4lab 0.0.2__tar.gz

log4lab-0.0.2/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Thibaut Lamadon
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

log4lab-0.0.2/PKG-INFO

@@ -0,0 +1,222 @@
+Metadata-Version: 2.4
+Name: log4lab
+Version: 0.0.2
+Summary: A lightweight structured log viewer with live streaming and filters.
+Author: Thibaut Lamadon
+License: MIT License
+        
+        Copyright (c) 2025 Thibaut Lamadon
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: Homepage, https://github.com/tlamadon/log4lab
+Project-URL: Repository, https://github.com/tlamadon/log4lab
+Project-URL: Issues, https://github.com/tlamadon/log4lab/issues
+Keywords: logging,log-viewer,structured-logs,jsonl,monitoring,dashboard,live-streaming
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: System :: Logging
+Classifier: Topic :: System :: Monitoring
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: fastapi
+Requires-Dist: uvicorn
+Requires-Dist: jinja2
+Requires-Dist: typer
+Requires-Dist: rich>=13.0.0
+Provides-Extra: test
+Requires-Dist: pytest>=7.0; extra == "test"
+Requires-Dist: pytest-asyncio>=0.21; extra == "test"
+Requires-Dist: pytest-cov>=4.0; extra == "test"
+Requires-Dist: httpx>=0.24; extra == "test"
+Provides-Extra: images
+Requires-Dist: term-image>=0.7.0; extra == "images"
+Dynamic: license-file
+
+# Log4Lab
+
+A lightweight structured log viewer with live streaming, filtering, and rich content rendering.
+
+Log4Lab is a web-based dashboard for viewing and analyzing structured JSON logs in real-time. It provides a clean interface for monitoring application logs with live updates, making it easy to track experiments and debug issues.
+
+## Installation
+
+### Using pipx (Recommended)
+
+Install log4lab as an isolated application:
+
+```bash
+pipx install log4lab
+```
+
+### Using pip
+
+```bash
+pip install log4lab
+```
+
+### From source
+
+```bash
+git clone https://github.com/tlamadon/log4lab.git
+cd log4lab
+pip install -e .
+```
+
+## Quick Start
+
+1. **Start the web interface:**
+   ```bash
+   log4lab serve logs/app.log
+   ```
+   Then open http://localhost:8000
+
+2. **View logs in terminal:**
+   ```bash
+   log4lab tail logs/app.log
+   ```
+
+3. **Export to HTML:**
+   ```bash
+   log4lab export logs/app.log -o report.html
+   ```
+
+## Log Format
+
+Log4Lab expects JSONL format (one JSON object per line):
+
+```json
+{"time": "2025-02-03T10:30:00Z", "level": "INFO", "section": "train", "message": "Training started"}
+{"time": "2025-02-03T10:30:05Z", "level": "WARN", "section": "data", "message": "Missing data point"}
+{"time": "2025-02-03T10:30:10Z", "level": "ERROR", "section": "model", "message": "Model failed to converge"}
+```
+
+### With Rich Content
+
+Log4Lab can display various file types when you include a `cache_path` field:
+
+```json
+{
+  "time": "2025-02-03T10:30:00Z",
+  "level": "INFO",
+  "section": "train",
+  "message": "Training complete",
+  "cache_path": "artifacts/results.png",
+  "run_name": "experiment_1",
+  "accuracy": 0.95
+}
+```
+
+**Supported content types:**
+- **Images**: PNG, JPG, SVG, etc. (displayed inline)
+- **Code files**: Python, JavaScript, JSON, YAML, etc. (syntax highlighted, collapsible)
+- **Markdown**: .md files (rendered as HTML, collapsible)
+- **PDFs**: Embedded viewer
+- **Other files**: Download links
+
+### Core Fields
+
+- `time`: Timestamp in ISO 8601 format
+- `level`: Log level (INFO, WARN, ERROR, DEBUG)
+- `section`: Component or module name
+- `message` or `msg`: Main log message
+- `cache_path`: Path to artifact file
+- `run_name`: Name of the run collection
+- `run_id`: Unique run identifier
+
+Any additional fields are shown in the expandable JSON view.
+
+## Commands
+
+### Serve (Web Interface)
+
+```bash
+log4lab serve [LOGFILE]
+
+# Options:
+--host 0.0.0.0        # Bind to all interfaces (default: 127.0.0.1)
+--port 3000           # Custom port (default: 8000)
+--reload              # Auto-reload for development
+```
+
+### Tail (Terminal)
+
+```bash
+log4lab tail [LOGFILE]
+
+# Options:
+--level ERROR         # Filter by log level
+--open-images         # Open images automatically
+```
+
+### Export
+
+```bash
+log4lab export [LOGFILE] -o output.html
+
+# Options:
+-o, --output FILE     # Output file path
+-t, --title TEXT      # Custom page title
+--no-embed-images     # Don't embed images (smaller file)
+```
+
+## Filtering
+
+The web interface supports:
+- **Level filtering**: Dropdown with all levels found in logs
+- **Text filters**: Section, run name, run ID (partial matching)
+- **Time range**: Last 1m, 5m, 30m, 1h, 6h, 24h
+- **URL filters**: Bookmark and share filtered views
+
+```
+# Filter by error logs from last hour
+http://localhost:8000/?level=error&time=3600
+
+# View specific run
+http://localhost:8000/?run_name=experiment_1
+```
+
+## Use Cases
+
+**Machine Learning**: Track training runs with metrics and plots
+```json
+{"run_name": "resnet_training", "epoch": 10, "loss": 0.23, "cache_path": "plots/loss.png"}
+```
+
+**Debugging**: Monitor distributed systems across components
+```json
+{"section": "api", "level": "ERROR", "message": "Connection timeout", "duration_ms": 5000}
+```
+
+**Research**: Document experiments with artifacts
+```json
+{"run_name": "param_sweep", "message": "Testing lr=0.001", "cache_path": "results.pdf"}
+```
+
+## License
+
+MIT

log4lab-0.0.2/README.md

@@ -0,0 +1,163 @@
+# Log4Lab
+
+A lightweight structured log viewer with live streaming, filtering, and rich content rendering.
+
+Log4Lab is a web-based dashboard for viewing and analyzing structured JSON logs in real-time. It provides a clean interface for monitoring application logs with live updates, making it easy to track experiments and debug issues.
+
+## Installation
+
+### Using pipx (Recommended)
+
+Install log4lab as an isolated application:
+
+```bash
+pipx install log4lab
+```
+
+### Using pip
+
+```bash
+pip install log4lab
+```
+
+### From source
+
+```bash
+git clone https://github.com/tlamadon/log4lab.git
+cd log4lab
+pip install -e .
+```
+
+## Quick Start
+
+1. **Start the web interface:**
+   ```bash
+   log4lab serve logs/app.log
+   ```
+   Then open http://localhost:8000
+
+2. **View logs in terminal:**
+   ```bash
+   log4lab tail logs/app.log
+   ```
+
+3. **Export to HTML:**
+   ```bash
+   log4lab export logs/app.log -o report.html
+   ```
+
+## Log Format
+
+Log4Lab expects JSONL format (one JSON object per line):
+
+```json
+{"time": "2025-02-03T10:30:00Z", "level": "INFO", "section": "train", "message": "Training started"}
+{"time": "2025-02-03T10:30:05Z", "level": "WARN", "section": "data", "message": "Missing data point"}
+{"time": "2025-02-03T10:30:10Z", "level": "ERROR", "section": "model", "message": "Model failed to converge"}
+```
+
+### With Rich Content
+
+Log4Lab can display various file types when you include a `cache_path` field:
+
+```json
+{
+  "time": "2025-02-03T10:30:00Z",
+  "level": "INFO",
+  "section": "train",
+  "message": "Training complete",
+  "cache_path": "artifacts/results.png",
+  "run_name": "experiment_1",
+  "accuracy": 0.95
+}
+```
+
+**Supported content types:**
+- **Images**: PNG, JPG, SVG, etc. (displayed inline)
+- **Code files**: Python, JavaScript, JSON, YAML, etc. (syntax highlighted, collapsible)
+- **Markdown**: .md files (rendered as HTML, collapsible)
+- **PDFs**: Embedded viewer
+- **Other files**: Download links
+
+### Core Fields
+
+- `time`: Timestamp in ISO 8601 format
+- `level`: Log level (INFO, WARN, ERROR, DEBUG)
+- `section`: Component or module name
+- `message` or `msg`: Main log message
+- `cache_path`: Path to artifact file
+- `run_name`: Name of the run collection
+- `run_id`: Unique run identifier
+
+Any additional fields are shown in the expandable JSON view.
+
+## Commands
+
+### Serve (Web Interface)
+
+```bash
+log4lab serve [LOGFILE]
+
+# Options:
+--host 0.0.0.0        # Bind to all interfaces (default: 127.0.0.1)
+--port 3000           # Custom port (default: 8000)
+--reload              # Auto-reload for development
+```
+
+### Tail (Terminal)
+
+```bash
+log4lab tail [LOGFILE]
+
+# Options:
+--level ERROR         # Filter by log level
+--open-images         # Open images automatically
+```
+
+### Export
+
+```bash
+log4lab export [LOGFILE] -o output.html
+
+# Options:
+-o, --output FILE     # Output file path
+-t, --title TEXT      # Custom page title
+--no-embed-images     # Don't embed images (smaller file)
+```
+
+## Filtering
+
+The web interface supports:
+- **Level filtering**: Dropdown with all levels found in logs
+- **Text filters**: Section, run name, run ID (partial matching)
+- **Time range**: Last 1m, 5m, 30m, 1h, 6h, 24h
+- **URL filters**: Bookmark and share filtered views
+
+```
+# Filter by error logs from last hour
+http://localhost:8000/?level=error&time=3600
+
+# View specific run
+http://localhost:8000/?run_name=experiment_1
+```
+
+## Use Cases
+
+**Machine Learning**: Track training runs with metrics and plots
+```json
+{"run_name": "resnet_training", "epoch": 10, "loss": 0.23, "cache_path": "plots/loss.png"}
+```
+
+**Debugging**: Monitor distributed systems across components
+```json
+{"section": "api", "level": "ERROR", "message": "Connection timeout", "duration_ms": 5000}
+```
+
+**Research**: Document experiments with artifacts
+```json
+{"run_name": "param_sweep", "message": "Testing lr=0.001", "cache_path": "results.pdf"}
+```
+
+## License
+
+MIT

log4lab-0.0.2/log4lab/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.1.0"

log4lab-0.0.2/log4lab/cli.py

@@ -0,0 +1,123 @@
+import typer
+import uvicorn
+from pathlib import Path
+from typing import Optional
+from . import server
+from .tail import LogTailer
+from .export import export_logs_to_html
+
+app = typer.Typer(help="Log4Lab — a lightweight structured log dashboard")
+
+
+@app.command()
+def serve(
+    logfile: Path = typer.Argument(
+        "logs/app.log",
+        exists=False,
+        help="Path to the JSONL log file to stream (default: logs/app.log)"
+    ),
+    host: str = typer.Option("127.0.0.1", help="Host to bind to"),
+    port: int = typer.Option(8000, help="Port to listen on"),
+    reload: bool = typer.Option(False, help="Enable auto-reload"),
+):
+    """Start the Log4Lab web server."""
+    server.set_log_path(logfile)
+    try:
+        uvicorn.run(
+            "log4lab.server:app",
+            host=host,
+            port=port,
+            reload=reload,
+            timeout_graceful_shutdown=0  # Exit immediately on CTRL-C
+        )
+    except KeyboardInterrupt:
+        pass  # Exit immediately without waiting
+
+
+@app.command()
+def tail(
+    logfile: Path = typer.Argument(
+        "logs/app.log",
+        help="Path to the JSONL log file to tail"
+    ),
+    level: Optional[str] = typer.Option(None, "--level", "-l", help="Filter by log level (e.g., INFO, ERROR)"),
+    section: Optional[str] = typer.Option(None, "--section", "-s", help="Filter by section name"),
+    run_name: Optional[str] = typer.Option(None, "--run-name", "-r", help="Filter by run name"),
+    run_id: Optional[str] = typer.Option(None, "--run-id", help="Filter by run ID"),
+    group: Optional[str] = typer.Option(None, "--group", "-g", help="Filter by group name"),
+    time_range: Optional[int] = typer.Option(None, "--time-range", "-t", help="Only show logs from last N seconds"),
+    follow: bool = typer.Option(True, "--follow/--no-follow", "-f", help="Follow log file for new entries"),
+    show_images: bool = typer.Option(True, "--images/--no-images", help="Try to show images inline in terminal"),
+    open_images: bool = typer.Option(False, "--open-images", help="Open images in system default viewer (Preview, etc.)"),
+):
+    """Tail logs to the terminal with rich formatting and filters."""
+    tailer = LogTailer(
+        log_path=logfile,
+        level=level,
+        section=section,
+        run_name=run_name,
+        run_id=run_id,
+        group=group,
+        time_range=time_range,
+        follow=follow,
+        show_images=show_images,
+        open_images=open_images,
+    )
+    try:
+        tailer.tail()
+    except KeyboardInterrupt:
+        pass  # Clean exit on Ctrl+C
+
+
+@app.command()
+def export(
+    logfile: Path = typer.Argument(
+        "logs/app.log",
+        help="Path to the JSONL log file to export"
+    ),
+    output: Path = typer.Option(
+        "logs-export.html",
+        "--output", "-o",
+        help="Output HTML file path"
+    ),
+    title: str = typer.Option(
+        "Log4Lab Export",
+        "--title", "-t",
+        help="Title for the HTML page"
+    ),
+    no_embed_images: bool = typer.Option(
+        False,
+        "--no-embed-images",
+        help="Don't embed images as base64 (reduces file size but images won't be included)"
+    ),
+):
+    """Export logs to a self-contained HTML file with embedded images and working filters."""
+    if not logfile.exists():
+        typer.echo(f"Error: Log file '{logfile}' does not exist.", err=True)
+        raise typer.Exit(1)
+
+    typer.echo(f"Exporting logs from '{logfile}' to '{output}'...")
+
+    try:
+        export_logs_to_html(
+            log_path=logfile,
+            output_path=output,
+            title=title,
+            embed_images=not no_embed_images
+        )
+
+        file_size = output.stat().st_size
+        size_mb = file_size / (1024 * 1024)
+
+        typer.echo(f"✓ Export complete! File size: {size_mb:.2f} MB")
+        typer.echo(f"✓ Saved to: {output.absolute()}")
+        typer.echo(f"\nOpen the file in your browser to view the logs with working filters.")
+
+    except Exception as e:
+        typer.echo(f"Error during export: {e}", err=True)
+        raise typer.Exit(1)
+
+
+if __name__ == "__main__":
+    app()
+