debug-log-server 0.1.0__py3-none-any.whl

debug_log_server-0.1.0.dist-info/METADATA

@@ -0,0 +1,402 @@
+Metadata-Version: 2.4
+Name: debug-log-server
+Version: 0.1.0
+Summary: Debug log collection and query service based on FastAPI
+Author-email: dengshi <dengshi@mercator.cn>
+License: MIT
+Project-URL: Homepage, https://github.com/dengshihub/debuglogger
+Project-URL: Documentation, https://github.com/dengshihub/debuglogger#readme
+Project-URL: Repository, https://github.com/dengshihub/debuglogger.git
+Project-URL: Issues, https://github.com/dengshihub/debuglogger/issues
+Keywords: debug,log,logging,fastapi,monitoring,error-tracking
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+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
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: fastapi>=0.104.0
+Requires-Dist: uvicorn[standard]>=0.24.0
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: python-jose[cryptography]>=3.3.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: httpx>=0.24.0; extra == "dev"
+Requires-Dist: black>=23.0.0; extra == "dev"
+Requires-Dist: flake8>=6.0.0; extra == "dev"
+
+# Debug Log Server
+
+Debug log collection and query service based on FastAPI.
+
+## 📦 Installation
+
+### From PyPI
+
+```bash
+pip install debug-log-server
+```
+
+### From Source
+
+```bash
+git clone https://github.com/dengshihub/debuglogger.git
+cd debuglogger/backend
+pip install -e .
+```
+
+## 🚀 Quick Start
+
+### Start Server
+
+```bash
+# Basic usage
+debug-log-server
+
+# With custom log directory
+DEBUG_LOG_DIR=/var/log/debug-logs debug-log-server
+
+# With custom port
+debug-log-server --port 9000
+
+# With custom host and port
+debug-log-server --host 0.0.0.0 --port 8000
+```
+
+### Environment Variables
+
+- `DEBUG_LOG_DIR`: Log storage directory (default: `./debug-logs`)
+- `DEBUG_AUTH`: Enable authentication debug mode (default: `false`)
+
+## 📖 API Documentation
+
+### POST /api/debug-log
+
+Receive debug logs from frontend.
+
+**Request Body:**
+```json
+{
+  "logs": [
+    {
+      "sessionId": "session-123",
+      "timestamp": 1717564800000,
+      "type": "console",
+      "level": "log",
+      "message": "Hello World",
+      "url": "https://example.com"
+    }
+  ],
+  "source": "frontend"
+}
+```
+
+**Response:**
+```json
+{
+  "status": "ok",
+  "received": 1
+}
+```
+
+### GET /api/debug-log/list
+
+List all log files.
+
+**Query Parameters:**
+- `source`: Filter by source (optional)
+
+**Response:**
+```json
+{
+  "logs": [
+    {
+      "name": "frontend.log",
+      "path": "/var/log/debug-logs/frontend/frontend.log",
+      "size": 1024,
+      "modified": "2024-06-05T10:30:00"
+    }
+  ]
+}
+```
+
+### GET /api/debug-log/{source}
+
+Get logs from a specific source.
+
+**Query Parameters:**
+- `limit`: Maximum number of entries to return (default: 100)
+
+**Response:**
+```json
+{
+  "source": "frontend",
+  "entries": [
+    {
+      "sessionId": "session-123",
+      "timestamp": 1717564800000,
+      "type": "console",
+      "level": "log",
+      "message": "Hello World"
+    }
+  ]
+}
+```
+
+## 🐳 Docker
+
+### Build Image
+
+```bash
+docker build -t debug-log-server .
+```
+
+### Run Container
+
+```bash
+docker run -d \
+  -p 8000:8000 \
+  -v /var/log/debug-logs:/app/debug-logs \
+  --name debug-log-server \
+  debug-log-server
+```
+
+### Docker Compose
+
+```yaml
+version: '3.8'
+
+services:
+  debug-log-server:
+    image: debug-log-server:latest
+    ports:
+      - "8000:8000"
+    volumes:
+      - ./debug-logs:/app/debug-logs
+    environment:
+      - DEBUG_LOG_DIR=/app/debug-logs
+    restart: unless-stopped
+```
+
+## 🔧 Configuration
+
+### Basic Configuration
+
+```python
+# config.py
+import os
+
+LOG_DIR = os.getenv("DEBUG_LOG_DIR", "./debug-logs")
+HOST = os.getenv("HOST", "0.0.0.0")
+PORT = int(os.getenv("PORT", "8000"))
+```
+
+### Advanced Configuration
+
+```python
+# config.py
+from pydantic import BaseSettings
+
+class Settings(BaseSettings):
+    log_dir: str = "./debug-logs"
+    host: str = "0.0.0.0"
+    port: int = 8000
+    debug_auth: bool = False
+    
+    class Config:
+        env_prefix = "DEBUG_"
+
+settings = Settings()
+```
+
+## 🔒 Security
+
+### Authentication
+
+The server supports JWT authentication for protected routes:
+
+```python
+from fastapi import Depends
+from debug_log_server import debug_auth
+
+@app.get("/api/protected")
+async def protected_route(token: str = Depends(debug_auth)):
+    return {"message": "This is a protected route"}
+```
+
+### CORS
+
+CORS is enabled by default for all origins. For production, configure it properly:
+
+```python
+from fastapi.middleware.cors import CORSMiddleware
+
+app.add_middleware(
+    CORSMiddleware,
+    allow_origins=["https://your-domain.com"],  # Specify allowed origins
+    allow_credentials=True,
+    allow_methods=["GET", "POST"],
+    allow_headers=["*"],
+)
+```
+
+## 📊 Monitoring
+
+### Health Check
+
+```bash
+curl http://localhost:8000/
+```
+
+### Log Statistics
+
+```bash
+curl http://localhost:8000/api/debug-log/list
+```
+
+## 🧪 Testing
+
+### Install Test Dependencies
+
+```bash
+pip install debug-log-server[dev]
+```
+
+### Run Tests
+
+```bash
+pytest tests/
+```
+
+### Test with httpx
+
+```python
+from fastapi.testclient import TestClient
+from main import app
+
+client = TestClient(app)
+
+def test_receive_log():
+    response = client.post("/api/debug-log", json={
+        "logs": [{
+            "sessionId": "test",
+            "timestamp": 1717564800000,
+            "type": "console",
+            "message": "test"
+        }],
+        "source": "test"
+    })
+    assert response.status_code == 200
+```
+
+## 📝 Examples
+
+### Python Client
+
+```python
+import requests
+
+# Send logs
+response = requests.post('http://localhost:8000/api/debug-log', json={
+    "logs": [{
+        "sessionId": "session-123",
+        "timestamp": 1717564800000,
+        "type": "console",
+        "level": "log",
+        "message": "Hello from Python"
+    }],
+    "source": "python-client"
+})
+
+print(response.json())
+```
+
+### JavaScript Client
+
+```javascript
+// Using fetch
+fetch('http://localhost:8000/api/debug-log', {
+  method: 'POST',
+  headers: { 'Content-Type': 'application/json' },
+  body: JSON.stringify({
+    logs: [{
+      sessionId: 'session-123',
+      timestamp: Date.now(),
+      type: 'console',
+      level: 'log',
+      message: 'Hello from JavaScript'
+    }],
+    source: 'javascript-client'
+  })
+})
+.then(response => response.json())
+.then(data => console.log(data));
+```
+
+## 🚀 Deployment
+
+### Systemd Service
+
+```ini
+# /etc/systemd/system/debug-log-server.service
+[Unit]
+Description=Debug Log Server
+After=network.target
+
+[Service]
+Type=simple
+User=www-data
+WorkingDirectory=/opt/debug-log-server
+Environment="DEBUG_LOG_DIR=/var/log/debug-logs"
+ExecStart=/usr/local/bin/debug-log-server
+Restart=always
+
+[Install]
+WantedBy=multi-user.target
+```
+
+```bash
+sudo systemctl enable debug-log-server
+sudo systemctl start debug-log-server
+```
+
+### Nginx Reverse Proxy
+
+```nginx
+server {
+    listen 80;
+    server_name logs.your-domain.com;
+
+    location / {
+        proxy_pass http://127.0.0.1:8000;
+        proxy_set_header Host $host;
+        proxy_set_header X-Real-IP $remote_addr;
+        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+        proxy_set_header X-Forwarded-Proto $scheme;
+    }
+}
+```
+
+## 📚 Related Projects
+
+- **@dengshi/debug-logger**: Frontend log collection library (npm)
+- **playwright-collector**: Playwright-based log collector
+
+## 📄 License
+
+MIT License - see [LICENSE](LICENSE) file for details.
+
+## 🤝 Contributing
+
+Contributions are welcome! Please read our [Contributing Guide](../CONTRIBUTING.md) for details.
+
+## 📞 Support
+
+- 📖 [Documentation](https://github.com/dengshihub/debuglogger#readme)
+- 🐛 [Issue Tracker](https://github.com/dengshihub/debuglogger/issues)
+- 💬 [Discussions](https://github.com/dengshihub/debuglogger/discussions)

debug_log_server-0.1.0.dist-info/RECORD

@@ -0,0 +1,6 @@
+static/index.html,sha256=ThsBvwX4abtz0yoqbQtch3c0AROeMP8gWHGj87TjUAM,13983
+debug_log_server-0.1.0.dist-info/METADATA,sha256=0mwA6JFdYvKSeN2g1d4ddTPu2UzVtJjvCbfOvmG3FiY,8388
+debug_log_server-0.1.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+debug_log_server-0.1.0.dist-info/entry_points.txt,sha256=XdEvilgx2UAIVk-6Tkk3W-K9s0ksVWM-CuVAc_KinKs,47
+debug_log_server-0.1.0.dist-info/top_level.txt,sha256=ZSyr8N5s1w9m9ysX1kCSA7hJCb6YZCYf62FJQ_LmzGI,7
+debug_log_server-0.1.0.dist-info/RECORD,,

debug_log_server-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

debug_log_server-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+debug-log-server = main:main

debug_log_server-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+static

static/index.html

@@ -0,0 +1,371 @@
+<!DOCTYPE html>
+<html lang="zh-CN">
+<head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>调试系统 - 前端演示</title>
+    <style>
+        body {
+            font-family: Arial, sans-serif;
+            max-width: 800px;
+            margin: 50px auto;
+            padding: 20px;
+            background-color: #f5f5f5;
+        }
+        .container {
+            background: white;
+            padding: 30px;
+            border-radius: 8px;
+            box-shadow: 0 2px 10px rgba(0,0,0,0.1);
+        }
+        h1 { color: #333; }
+        .section {
+            margin: 20px 0;
+            padding: 15px;
+            border: 1px solid #ddd;
+            border-radius: 5px;
+        }
+        button {
+            background: #007bff;
+            color: white;
+            border: none;
+            padding: 10px 20px;
+            border-radius: 5px;
+            cursor: pointer;
+            margin: 5px;
+        }
+        button:hover { background: #0056b3; }
+        button.error { background: #dc3545; }
+        button.error:hover { background: #c82333; }
+        button.success { background: #28a745; }
+        button.success:hover { background: #218838; }
+        .log-output {
+            background: #f8f9fa;
+            padding: 15px;
+            border-radius: 5px;
+            margin-top: 10px;
+            max-height: 200px;
+            overflow-y: auto;
+            font-family: monospace;
+            font-size: 12px;
+        }
+        .status {
+            padding: 10px;
+            border-radius: 5px;
+            margin: 10px 0;
+        }
+        .status.success { background: #d4edda; color: #155724; }
+        .status.error { background: #f8d7da; color: #721c24; }
+        .status.info { background: #d1ecf1; color: #0c5460; }
+    </style>
+</head>
+<body>
+    <div class="container">
+        <h1>🔧 调试系统 - 前端演示</h1>
+        
+        <div class="section">
+            <h2>📡 服务状态</h2>
+            <button onclick="checkService()">检查服务状态</button>
+            <div id="serviceStatus" class="status info">等待检查...</div>
+        </div>
+
+        <div class="section">
+            <h2>📝 基础日志测试</h2>
+            <button onclick="sendInfoLog()">发送 Info 日志</button>
+            <button onclick="sendWarnLog()">发送 Warn 日志</button>
+            <button class="error" onclick="sendErrorLog()">发送 Error 日志</button>
+            <button class="success" onclick="sendSuccessLog()">发送 Success 日志</button>
+        </div>
+
+        <div class="section">
+            <h2>🌐 网络请求测试</h2>
+            <button onclick="testApiCall()">测试 API 调用</button>
+            <button onclick="testFailedApi()">测试失败 API</button>
+        </div>
+
+        <div class="section">
+            <h2>🎯 用户行为测试</h2>
+            <button onclick="simulateUserClick()">模拟用户点击</button>
+            <button onclick="simulateFormSubmit()">模拟表单提交</button>
+            <button onclick="simulateNavigation()">模拟页面跳转</button>
+        </div>
+
+        <div class="section">
+            <h2>📊 查看日志</h2>
+            <button onclick="viewLogs()">查看所有日志</button>
+            <button onclick="viewRecentLogs()">查看最近日志</button>
+            <div id="logOutput" class="log-output">日志输出区域...</div>
+        </div>
+
+        <div class="section">
+            <h2>🔍 性能监控</h2>
+            <button onclick="measurePerformance()">测量页面性能</button>
+            <button onclick="measureApiPerformance()">测量 API 性能</button>
+        </div>
+    </div>
+
+    <script>
+        // 配置
+        const DEBUG_ENDPOINT = '/api/debug-log';
+        const sessionId = 'session-' + Date.now() + '-' + Math.random().toString(36).substr(2, 9);
+
+        // 基础日志发送函数
+        async function sendLog(type, level, message, extra = {}) {
+            const logData = {
+                sessionId: sessionId,
+                timestamp: Date.now(),
+                type: type,
+                level: level,
+                message: message,
+                url: window.location.href,
+                ...extra
+            };
+
+            try {
+                const response = await fetch(DEBUG_ENDPOINT, {
+                    method: 'POST',
+                    headers: { 'Content-Type': 'application/json' },
+                    body: JSON.stringify({ logs: [logData], source: 'example' })
+                });
+                const result = await response.json();
+                console.log('日志发送成功:', result);
+                return result;
+            } catch (error) {
+                console.error('日志发送失败:', error);
+                throw error;
+            }
+        }
+
+        // 检查服务状态
+        async function checkService() {
+            const statusDiv = document.getElementById('serviceStatus');
+            try {
+                const response = await fetch('/api/debug-log/list');
+                if (response.ok) {
+                    statusDiv.className = 'status success';
+                    statusDiv.textContent = '✅ 调试服务运行正常';
+                    sendLog('system', 'info', '调试服务检查通过');
+                } else {
+                    throw new Error('服务响应异常');
+                }
+            } catch (error) {
+                statusDiv.className = 'status error';
+                statusDiv.textContent = '❌ 调试服务无法连接: ' + error.message;
+            }
+        }
+
+        // 发送不同级别的日志
+        function sendInfoLog() {
+            sendLog('console', 'info', '这是一条信息日志', { 
+                userId: 'user-123',
+                action: 'info_test'
+            });
+        }
+
+        function sendWarnLog() {
+            sendLog('console', 'warn', '这是一条警告日志', { 
+                warningType: 'deprecated_api',
+                apiVersion: 'v1'
+            });
+        }
+
+        function sendErrorLog() {
+            sendLog('console', 'error', '这是一条错误日志', { 
+                errorCode: 'ERR_001',
+                errorMessage: '模拟的错误信息'
+            });
+        }
+
+        function sendSuccessLog() {
+            sendLog('console', 'info', '操作成功完成', { 
+                action: 'user_action',
+                status: 'success'
+            });
+        }
+
+        // 测试 API 调用
+        async function testApiCall() {
+            const startTime = Date.now();
+            try {
+                const response = await fetch('/api/debug-log/list');
+                const duration = Date.now() - startTime;
+                
+                await sendLog('network-request', 'info', 'API 调用成功', {
+                    url: '/api/debug-log/list',
+                    method: 'GET',
+                    status: response.status,
+                    duration: duration
+                });
+            } catch (error) {
+                const duration = Date.now() - startTime;
+                await sendLog('network-request', 'error', 'API 调用失败', {
+                    url: '/api/debug-log/list',
+                    method: 'GET',
+                    error: error.message,
+                    duration: duration
+                });
+            }
+        }
+
+        async function testFailedApi() {
+            const startTime = Date.now();
+            try {
+                const response = await fetch('/api/nonexistent');
+                const duration = Date.now() - startTime;
+                
+                await sendLog('network-request', 'error', '预期中的 API 失败', {
+                    url: '/api/nonexistent',
+                    method: 'GET',
+                    status: response.status,
+                    duration: duration
+                });
+            } catch (error) {
+                const duration = Date.now() - startTime;
+                await sendLog('network-request', 'error', 'API 调用异常', {
+                    url: '/api/nonexistent',
+                    method: 'GET',
+                    error: error.message,
+                    duration: duration
+                });
+            }
+        }
+
+        // 模拟用户行为
+        function simulateUserClick() {
+            sendLog('user-action', 'info', '用户点击了按钮', {
+                elementId: 'test-button',
+                elementType: 'button',
+                timestamp: Date.now()
+            });
+        }
+
+        function simulateFormSubmit() {
+            sendLog('user-action', 'info', '用户提交了表单', {
+                formId: 'test-form',
+                formData: {
+                    username: 'test_user',
+                    email: 'test@example.com'
+                }
+            });
+        }
+
+        function simulateNavigation() {
+            sendLog('navigation', 'info', '用户导航到新页面', {
+                from: window.location.href,
+                to: '/new-page',
+                method: 'push'
+            });
+        }
+
+        // 查看日志
+        async function viewLogs() {
+            try {
+                const response = await fetch('/api/debug-log/example');
+                const data = await response.json();
+                const outputDiv = document.getElementById('logOutput');
+                
+                if (data.entries && data.entries.length > 0) {
+                    outputDiv.innerHTML = data.entries.map(entry => 
+                        `<div style="margin: 5px 0; padding: 5px; background: #fff; border-left: 3px solid ${getLevelColor(entry.level)};">
+                            <strong>[${entry.level}]</strong> ${entry.message} <br>
+                            <small>${new Date(entry.timestamp).toLocaleString()}</small>
+                        </div>`
+                    ).join('');
+                } else {
+                    outputDiv.innerHTML = '暂无日志数据';
+                }
+            } catch (error) {
+                document.getElementById('logOutput').innerHTML = '获取日志失败: ' + error.message;
+            }
+        }
+
+        async function viewRecentLogs() {
+            try {
+                const response = await fetch('/api/debug-log/example?limit=5');
+                const data = await response.json();
+                const outputDiv = document.getElementById('logOutput');
+                
+                if (data.entries && data.entries.length > 0) {
+                    outputDiv.innerHTML = `<h3>最近 ${data.entries.length} 条日志:</h3>` + 
+                        data.entries.map(entry => 
+                            `<div style="margin: 5px 0; padding: 5px; background: #fff; border-left: 3px solid ${getLevelColor(entry.level)};">
+                                <strong>[${entry.level}]</strong> ${entry.message} <br>
+                                <small>${new Date(entry.timestamp).toLocaleString()}</small>
+                            </div>`
+                        ).join('');
+                } else {
+                    outputDiv.innerHTML = '暂无日志数据';
+                }
+            } catch (error) {
+                document.getElementById('logOutput').innerHTML = '获取日志失败: ' + error.message;
+            }
+        }
+
+        function getLevelColor(level) {
+            const colors = {
+                'error': '#dc3545',
+                'warn': '#ffc107',
+                'info': '#007bff',
+                'success': '#28a745'
+            };
+            return colors[level] || '#6c757d';
+        }
+
+        // 性能监控
+        function measurePerformance() {
+            const perfData = performance.getEntriesByType('navigation')[0];
+            sendLog('performance', 'info', '页面性能数据', {
+                domContentLoaded: perfData.domContentLoadedEventEnd - perfData.domContentLoadedEventStart,
+                loadComplete: perfData.loadEventEnd - perfData.loadEventStart,
+                totalLoadTime: perfData.loadEventEnd - perfData.fetchStart,
+                domInteractive: perfData.domInteractive - perfData.fetchStart
+            });
+        }
+
+        async function measureApiPerformance() {
+            const startTime = performance.now();
+            try {
+                await fetch('/api/debug-log/list');
+                const duration = performance.now() - startTime;
+                
+                sendLog('performance', 'info', 'API 性能测试', {
+                    endpoint: '/api/debug-log/list',
+                    responseTime: duration.toFixed(2) + 'ms',
+                    status: 'success'
+                });
+            } catch (error) {
+                const duration = performance.now() - startTime;
+                sendLog('performance', 'error', 'API 性能测试失败', {
+                    endpoint: '/api/debug-log/list',
+                    responseTime: duration.toFixed(2) + 'ms',
+                    error: error.message
+                });
+            }
+        }
+
+        // 页面加载时自动发送日志
+        window.addEventListener('load', () => {
+            sendLog('page', 'info', '页面加载完成', {
+                userAgent: navigator.userAgent,
+                screen: `${window.screen.width}x${window.screen.height}`,
+                language: navigator.language
+            });
+        });
+
+        // 页面卸载前发送日志
+        window.addEventListener('beforeunload', () => {
+            navigator.sendBeacon(DEBUG_ENDPOINT, JSON.stringify({
+                logs: [{
+                    sessionId: sessionId,
+                    timestamp: Date.now(),
+                    type: 'page',
+                    level: 'info',
+                    message: '页面即将卸载',
+                    url: window.location.href
+                }],
+                source: 'example'
+            }));
+        });
+    </script>
+</body>
+</html>