Skip to main content

​
Overview

This guide gets you from zero to seeing logs in 5 minutes:
  1. Create an account
  2. Get your API key
  3. Run the edge agent
  4. View logs in the dashboard
Already have an account? Skip to Step 2.

​
Step 1: Create Your Account

1

Sign Up

Go to app.logfleet.io/register and create your account.Or use the API:
curl -X POST https://api.logfleet.io/api/v1/auth/register \
  -H "Content-Type: application/json" \
  -d '{
    "organization_name": "My Company",
    "email": "you@example.com",
    "password": "YourSecureP@ss123!",
    "name": "Your Name"
  }'
2

Save Your Token

After registration, save the JWT token from the response:
export TOKEN="eyJhbGciOiJIUzI1NiIs..."

​
Step 2: Create an API Key

Edge agents authenticate with API keys. Create one in the dashboard or via API: 
curl -X POST https://api.logfleet.io/api/v1/api-keys \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name": "my-edge-agent", "permissions": ["read", "write"]}'
Save the raw_key immediately - it’s only shown once!
export API_KEY="lf_aBcDeFgHiJkLmNoPqRsTuVwXyZ123456"

​
Step 3: Run the Edge Agent

Deploy the agent using Docker: 
docker run -d \
  --name logfleet-agent \
  -e API_KEY=$API_KEY \
  -e CLOUD_URL=https://api.logfleet.io \
  -e AGENT_NAME="my-first-agent" \
  -p 9880:9880 \
  ghcr.io/sadhiappan/logfleet-agent:latest
The agent is now:
  • Collecting logs on port 9880 (HTTP JSON input)
  • Storing logs locally in Loki
  • Connected to LogFleet cloud

​
Step 4: Send a Test Log

Send a log to your agent: 
curl -X POST http://localhost:9880 \
  -H "Content-Type: application/json" \
  -d '{
    "message": "Hello from LogFleet!",
    "level": "info",
    "service": "quickstart"
  }'

​
Step 5: View in Dashboard

  1. Go to app.logfleet.io
  2. Click on your agent
  3. Click “Sample Logs” to fetch recent logs
You should see your test log!
Dashboard showing logs

​
What’s Next?

Deploy to Production

Configure the agent for production deployments

Custom Metrics

Extract metrics from your logs at the edge

Log Streaming

Stream logs in real-time via WebSocket

API Reference

Explore all available endpoints

​
Local Development

For local testing without cloud connectivity, clone the agent repo: 
git clone https://github.com/sadhiappan/logfleet.git
cd logfleet/agent
docker compose -f deploy/compose/docker-compose.core.yml up -d
This starts:
  • Vector on port 9881 (log collector)
  • Loki on port 3101 (log storage)
  • Control Plane on port 8081 (management API)
See the Edge Agent Setup Guide for details.