Documentation
Frequently Asked Questions
What is LogMachine?
LogMachine is a collaborative logging platform designed for distributed development teams. It provides beautiful, colored console output and real-time log centralization, allowing team members to see each other's logs instantly for better debugging and collaboration.
How does LogMachine differ from traditional logging?
Unlike traditional logging systems that store logs locally or in separate systems, LogMachine centralizes logs in real-time. Team members can see each other's logs as they happen, making collaborative debugging much more effective.
- Real-time collaboration: See team logs instantly
- Beautiful output: Color-coded, structured logs
- Multi-language support: SDKs for Python, JavaScript, Go, Rust, and PHP
- Room-based organization: Keep different projects separate
Do I need to set up my own server?
No! You can start using LogMachine immediately with our hosted server at https://logmachine.org. This gives you more flexibility and better performance than your own self hosted server, without the hassle of setup and maintenance.
Is LogMachine secure?
Yes, LogMachine includes several security features:
- Room-based access: Logs are organized by rooms/projects
- Authentication support: HTTP headers for API authentication
- SSL/TLS encryption: All network communication is encrypted
- User identification: Users are identified by their Google / GitHub accounts
What programming languages are supported?
LogMachine currently supports five programming languages:
Python
pip install logmachine
JavaScript
npm install @bufferpunk/logmachine
Go
go get github.com/logmachine/go
Rust
cargo add logmachine
PHP
composer require bufferpunk/logmachine
Log Machine is designed to be extensible, so we plan to add more languages in the future based on community demand. Check our GitHub repositories for updates and contribute if you'd like to see your language supported!
How do I filter logs in the web interface?
The LogMachine web interface provides powerful filtering capabilities:
- Module filtering: Filter by application module or file path
- Timestamp filtering: Show logs from specific time ranges
- Message filtering: Search for specific text in log messages
- Level grouping: View logs grouped by severity level
Filters work in real-time and can be combined for precise log analysis.
How do I view logs?
See the dedicated Viewing Logs page for CLI output, the web UI, and ANSI-aware file viewer recommendations.
Can I export logs for analysis?
Yes! LogMachine provides several export options:
- JSON export: All SDKs include methods to export logs as JSON
- File logging: Logs are automatically saved to local files
- API access: RESTful APIs for programmatic access
What are "rooms" and how do they work?
Rooms are logical groupings for logs, similar to channels in chat applications. Each room represents a project, team, or environment. This allows you to:
- Keep different projects' logs separate
- Control access to specific log streams
- Organize logs by environment (dev, staging, prod)
- Share logs with specific team members
Is LogMachine free to use?
Yes! LogMachine is open source and free to use. The hosted server at logmachine.org provides free access for basic usage, and paid options for serious deployments with additional features and support.
How do I troubleshoot connection issues?
If you're having trouble connecting to a central server:
- Check network connectivity: Ensure the server URL is accessible
- Verify configuration: Double-check room names and authentication
- Check logs: Look for connection error messages in your application logs
- Test with hosted server: Try the public server first to isolate issues
- Firewall settings: Ensure outbound connections are allowed
Can I integrate LogMachine with existing logging systems?
Yes! LogMachine is designed to complement existing logging infrastructure:
- Python: Works alongside standard logging module
- JavaScript: Can be used with console.log or winston
- Go: Built on slog, integrates with existing Go logging
- Rust: Uses the standard log crate
- PHP: Compatible with Monolog and PSR-3 loggers
You can use LogMachine for collaborative debugging while keeping your existing log aggregation systems.
How do I contribute to LogMachine?
We welcome contributions! Here's how you can help:
- Report bugs: Use GitHub issues for bug reports
- Request features: Suggest new SDKs or improvements
- Submit code: PRs are welcome for all repositories
- Improve docs: Help make documentation clearer
- Spread the word: Tell other developers about LogMachine
Check out our GitHub organization for all our repositories.
Still have questions?
Can't find what you're looking for? Check out our GitHub repositories or reach out to the community.