# 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

#### Using Docker Compose (Recommended)

1. Start all services:
```bash
docker compose up -d
```

2. Access the application:
   - Frontend: http://localhost:3000
   - Backend API: http://localhost:3001
   - PostgreSQL: localhost:5432 (user: oculog, password: oculog_password, db: oculog)

3. Stop services:
```bash
docker compose down
```

4. View logs:
```bash
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`.