Docker deployment

1. Retrieve your credentials

1. Log in at panel.checklogs.dev.
2. Create or select a server in the dashboard.
3. Copy the generated API_KEY and UDP_PORT.

2. Install the agent

# Create the installation directory
mkdir -p /opt/checklogs && cd /opt/checklogs

# Download docker-compose.yml
curl -o docker-compose.yml https://raw.githubusercontent.com/checklogsdev/Docker/main/docker-compose.yml

# Download .env.example
curl -o .env.example https://raw.githubusercontent.com/checklogsdev/Docker/main/.env.example

# Prepare your configuration
cp .env.example .env
nano .env  # Add CHECKLOGS_API_KEY and CHECKLOGS_API_PORT

3. Start the stack

docker-compose up -d

4. Verify the deployment

# Check the container status
docker-compose ps

# Tail the agent logs
docker-compose logs -f

# Expected output
# ✓ Configuration valid
# ✓ Agent started successfully
# 📦 Sent metrics to api.checklogs.dev

Configuration reference

The agent is configured through the .env file. Required variables:

• CHECKLOGS_API_KEY – the key generated in the dashboard.
• CHECKLOGS_API_PORT – the dedicated UDP port assigned to your server.

Optional variables:

• SERVER_NAME – label displayed in the dashboard.
• COLLECT_INTERVAL – interval (in seconds) between metric collections.
• COLLECT_CPU, COLLECT_RAM, COLLECT_DISK, COLLECT_LOAD, COLLECT_PROCESSES – enable or disable specific collectors.
• TOP_PROCESSES_COUNT – number of processes tracked for CPU and RAM usage.
• LOG_LEVEL – logging verbosity (DEBUG, INFO, WARNING, ERROR).

Management commands

# Start the stack
docker-compose up -d

# Stop the stack
docker-compose down

# Restart the agent
docker-compose restart

# Follow the logs
docker-compose logs -f

# Last 100 lines
docker-compose logs --tail=100

# With timestamps
docker-compose logs -f -t

# Pull the latest image
docker-compose pull
docker-compose up -d

# Check resource usage
docker stats checklogs_agent

Troubleshooting

docker-compose exec agent printenv | grep CHECKLOGS
docker-compose logs -f | grep ERROR
docker-compose exec agent ping -c 3 api.checklogs.dev

docker-compose ps
docker-compose logs --tail=50
# Check API key and UDP port values

Security & collected metrics

• The agent runs with minimal privileges and mounts host volumes read-only.
• Resource limits are configured by default (0.25 vCPU / 256 MB RAM).
• Metrics collected: CPU usage, memory, disks, load averages, top processes, and uptime.