ClusterEye Documentation
Everything you need to get started with the database monitoring and management platform.
Content
Resources
Getting Started
ClusterEye is an agent-based platform for monitoring and managing your databases. It supports MSSQL, MongoDB, and PostgreSQL databases and communicates between agents and the Cloud API using the gRPC protocol.
Core Components
Agent
Installed on the database server or a nearby server. It monitors the database, collects metrics, and communicates with the Cloud API.
Cloud API
Processes, stores, and presents data from agents to the user interface. Provides high-performance communication over the gRPC protocol.
Database Adapters
Custom adapters for each database type collect database-specific metrics and perform database operations.
Security Layer
Ensures system security with TLS/SSL encryption, token-based authentication, and role-based access control.
System Requirements
| Component | Minimum Requirements | Recommended |
|---|---|---|
| Agent | 1 CPU, 1GB RAM, 10GB Disk | 2 CPU, 2GB RAM, 20GB SSD |
| Cloud Server | 2 CPU, 4GB RAM, 50GB SSD | 4+ CPU, 8GB+ RAM, 100GB+ SSD |
| Database | PostgreSQL 10+, MSSQL 2016+, MongoDB 4.0+ | PostgreSQL 13+, MSSQL 2019+, MongoDB 5.0+ |
Note: The Agent component is installed on the same server as the database. As it is completely lightweight, you don't need to worry about performance.
Next Steps
To get started with ClusterEye, you can follow these steps:
- Download and install the Agent component on your database server.
- Complete the configuration required for the Cloud API connection.
- Configure your first database connection and check the system health status.