Documentation Index
Fetch the complete documentation index at: https://docs.logfleet.io/llms.txt
Use this file to discover all available pages before exploring further.
Overview
LogFleet consists of two separate repositories, each serving a distinct purpose:
| Repository | Purpose | License |
|---|
| logfleet | Edge agent (open source) | Apache 2.0 |
| logfleet-cloud | Cloud platform + dashboard | Proprietary |
Architecture Diagram
+---------------------------------------------------------------+
| YOUR EDGE LOCATIONS |
| |
| +--------------+ +--------------+ +--------------+ |
| | Location A | | Location B | | Location C | |
| | | | | | | |
| | +----------+ | | +----------+ | | +----------+ | |
| | | Edge | | | | Edge | | | | Edge | | |
| | | Agent | | | | Agent | | | | Agent | | |
| | | (logfleet| | | | (logfleet| | | | (logfleet| | |
| | | repo) | | | | repo) | | | | repo) | | |
| | +----+-----+ | | +----+-----+ | | +----+-----+ | |
| +------+-------+ +------+-------+ +------+-------+ |
| | | | |
+----------|------------------|------------------|---------------+
| | |
| Metrics + WebSocket (on-demand) |
| | |
v v v
+---------------------------------------------------------------+
| LOGFLEET CLOUD |
| (logfleet-cloud repo) |
| |
| +-------------+ +-------------+ +-------------+ |
| | API | | Dashboard | | Database | |
| | Server | | (Next.js) | | (PostgreSQL)| |
| | (Go) | | | | | |
| | | | | | | |
| | api.logfleet| | app.logfleet| | | |
| | .io | | .io | | | |
| +-------------+ +-------------+ +-------------+ |
+---------------------------------------------------------------+
Repository Details
1. Edge Agent (logfleet)
GitHub: github.com/sadhiappan/logfleet
The open-source edge agent that runs at each edge location. Handles:
- Log Collection: Vector-based multi-protocol collection (HTTP, Syslog, file)
- Local Storage: Grafana Loki with configurable retention (7-30 days)
- Metric Extraction: Convert logs to metrics at the edge (100x bandwidth savings)
- Cloud Sync: WebSocket connection to LogFleet cloud for on-demand streaming
# Docker image
ghcr.io/sadhiappan/logfleet-agent:latest
# Key components
agent/
├── cmd/edge-control-plane/ # Main binary
├── internal/
│ ├── cloudws/ # WebSocket client
│ ├── loki/ # Loki query client
│ └── heartbeat/ # Health reporting
├── configs/vector/ # Vector configuration
└── deploy/ # Docker & Kubernetes
- API Server: Go-based REST API + WebSocket streaming hub
- Dashboard: Next.js 16 web application
- Documentation: Mintlify-powered docs (what you’re reading)
# Docker image
ghcr.io/sadhiappan/logfleet-cloud:latest
# Key components
cloud/
├── cmd/api-server/ # API entry point
├── internal/
│ ├── api/handlers/ # HTTP handlers
│ ├── streaming/ # WebSocket hub
│ └── repository/ # Database access
├── web/ # Dashboard (Next.js)
├── landing/ # Marketing site
└── docs/ # Documentation
Which Repo Do I Need?
| I want to… | Use this repo |
|---|
| Deploy an edge agent | logfleet (agent) |
| View logs in dashboard | logfleet-cloud (dashboard at app.logfleet.io) |
| Integrate via API | logfleet-cloud (API at api.logfleet.io) |
| Contribute to open source | logfleet (agent) |
Data Flow
Understanding how data flows through the system:
1. Your Devices → Edge Agent (logfleet repo)
- Logs ingested via HTTP/Syslog
- Stored locally in Loki (7-30 day retention)
- Metrics extracted and sent to cloud
2. Edge Agent → LogFleet Cloud (logfleet-cloud repo)
- Heartbeats every 30 seconds
- Metrics pushed continuously
- Full logs streamed on-demand via WebSocket
3. Dashboard → You
- Real-time agent status
- Request log samples from any agent
- Configure metric extraction rules
Getting Started
- Quick Start: Use the production cloud - no repo cloning needed
- Self-Hosted: Clone both repos and run with Docker Compose
- Development: Clone both repos for full local testing
See the Quickstart Guide for step-by-step instructions.
