log_ctrl

log_ctrl retrieves logs written by DeviceServer through x_logger using a separate gRPC LogServer, independently of DeviceServer.

Guides

• Quick Start
  • 1. Check the log directory
  • 2. Start LogServer
  • 3. Create a client
  • 4. List available log_name values
  • 5. List available dates
  • 6. Read the current log
  • 7. Read a rotated log
  • 8. Inspect actual files for troubleshooting
  • 9. Close the client
• Architecture
  • Overall architecture
  • LogCtrl
  • log_names()
  • dates()
  • raw_files()
  • _LogStream
  • Client side
  • Path resolution
  • Lifecycle
• Usage
  • Server
  • DeviceProxy
  • log_names()
  • dates(log_name)
  • exists(log_name, date=None)
  • tail(log_name, lines=100, date=None)
  • raw_files()
  • read(log_name, date=None)
  • read_raw(relative_path)
  • Closing the client
  • Asynchronous client
• Rotation
  • Current log
  • Rotated logs
  • Listing dates
  • log_names()
  • Responsibility for rotation
  • Files outside the naming convention
  • Path restrictions

API Reference

• API Reference
  • log_ctrl

Design policy

DeviceServer remains responsible for transparent device operations, not log distribution. LogCtrl accesses the specified log directory in read-only mode.

DeviceServer A ─ x_logger ─┐
DeviceServer B ─ x_logger ─┼─ log directory ← LogServer ← gRPC ← LogProxy
DeviceServer C ─ x_logger ─┘