Files
oculog/README.md
2026-02-12 14:51:39 -06:00

1.4 KiB

Oculog - Server Metrics Observability Platform

A server metrics observability platform that tracks:

  • Disk usage
  • CPU utilization
  • Memory usage
  • Network throughput

Project Structure

oculog/
├── server/           # Server application (backend + frontend)
│   ├── backend/     # Backend API and data collection
│   │   └── db/      # Database schema and migrations
│   └── frontend/    # Web dashboard UI
└── clients/         # Client agents for installation
    └── ubuntu/      # Ubuntu client installation scripts and binaries

Getting Started

Prerequisites

  • Docker and Docker Compose installed
  • Node.js 18+ (for local development, optional)

Server Setup

  1. Start all services:
docker compose up -d
  1. Access the application:

  2. Stop services:

docker compose down
  1. View logs:
docker compose logs -f

Client Installation (Ubuntu)

From the server dashboard, use the Client Download page to generate a pre-configured install script for your server, or copy the client files from clients/ubuntu/ and run install.sh after configuring client.conf.example as /etc/oculog/client.conf. Then install the systemd service and start oculog-client.