Clogs

A lightweight toolset to provide visibility into container/stack logs, and their health status. An alternative to traditional status pages, with deeper insights into your container logs.

Clogs is a stack of tools, consisting of:

• Clogs Agent - A lightweight service that sources logs/metrics from your containers, and ships them to the Clogs Backend for processing and visualization.
• Clogs Server - A backend service that receives logs/metrics from the Clogs Agent, processes them, and provides an API for the Clogs Frontend.
• Clogs Frontend - A web-based dashboard that visualizes the logs/metrics received from the Clogs Backend.

Deploy (Simple)

To quickly deploy Clogs use the fully integrated Docker Image:

docker run -d -p 5173:5173 -p 8000:8000 -v /var/run/docker.sock:/var/run/docker.sock:ro ghcr.io/kiliansen/clogs:latest

Web UI will be available at http://localhost:5173. Agents can be configured to point to the server at http://<host-ip>:8000.

Deploy (Docker Swarm)

Clogs is optimized for Docker Swarm deployment, allowing for easy horizontal scaling and high availability. To deploy to a swarm cluster:

1. Initialize Swarm (if not already):

   docker swarm init

2. Deploy the Stack: You can use the provided script to load versions and deploy:

   ./scripts/deploy_swarm.sh

   Alternatively, manual deployment:

   export $(grep -v '^#' versions.env | xargs) && docker stack deploy -c docker-stack.yml clogs

This will deploy:

• Agent: A global service running on every node, monitoring local containers.
• Server: Replicated backend service (2 replicas by default).
• Web: Replicated frontend dashboard (2 replicas by default).

The dashboard will be accessible via port 8080.

Licensing

When using Clogs, please be aware of the following licensing options:

• LICENSE - AGPL-3.0 (community edition)
• Commercial - Enterprise/SaaS licensing
• CLA - Required for contributions

For just most use-cases, the AGPL-3.0 community edition will be sufficient. However, if you require a commercial license without AGPL obligations, please create an Issue in the respective repository to get in contact for commercial licensing options.