Kanshi Core

Kanshi Core is a gRPC and REST server that manages metrics and agent data for the Kanshi monitoring system.

Features

• gRPC Ingestion: Receives IngestBatch and ReportAgent requests from Kanshi Agent.
• Persistent Storage: Stores metrics and agent metadata in TimescaleDB.
• REST API: Provides endpoints for querying agent status and historical metrics.

Architecture

• gRPC Server: Port :50051 (for agent communication)
• REST API: Port :8080 (for querying data)
• Database: TimescaleDB (PostgreSQL with time-series extensions)

REST API Endpoints

• GET /api/v1/agents: List all registered agents and their current status (online/offline).
• GET /api/v1/metrics: Query historical metrics for a specific agent.
• GET /api/v1/metrics/aggregate: Query aggregated metrics (min, max, avg) over a time interval.
  • Example: ${API_URL}/api/v1/metrics/aggregate?agentId=${agentId}&name=${name}&interval=30s
  • Supported Intervals: 30s, 1m, 5m, 15m
  • Supported Metrics: cpu.used_percent, mem.used_percent, disk.used_percent

Run

# Ensure you have a running PostgreSQL/TimescaleDB instance
# and the DATABASE_URL environment variable set.
go run cmd/core/main.go

Database Setup

Schema is located in db/schema/schema.sql.

Purpose

This project is the central component of the Kanshi data pipeline: Agent → Core