https://github.com/itallix/go-metrics

A scalable metrics collection system for distributed environments, built in Go.
https://github.com/itallix/go-metrics

development devops golang

Last synced: 6 days ago
JSON representation

A scalable metrics collection system for distributed environments, built in Go.

• Host: GitHub
• URL: https://github.com/itallix/go-metrics
• Owner: itallix
• Created: 2024-04-28T10:30:38.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2024-10-12T21:27:25.000Z (4 months ago)
• Last Synced: 2024-12-15T02:12:10.347Z (2 months ago)
• Topics: development, devops, golang
• Language: Go
• Homepage:
• Size: 8.25 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# go-metrics

My pet project to learn Golang with Yandex Practicum [Advanced Go Developer](https://practicum.yandex.ru/go-advanced/) course.

## Overview

`go-metrics` is a robust, scalable metrics collection system designed for distributed environments. It consists of two main components: an agent that collects and sends metrics in batches, and a server that receives, processes, and exposes these metrics through a RESTful API.

![Server-Agent](./doc/server-agent.png)

## Key Features

- Efficient Metric Collection: Agents collect system and application metrics with minimal overhead.

- Batch Processing: Metrics are sent in batches to optimize network usage and server processing.

- Scalable Architecture: Designed to handle multiple agents sending data to a centralized server.

- RESTful API: Server exposes collected metrics through a REST API.

## Components

### Agent

- Lightweight process that runs on target systems

- Collects various system metrics (CPU, memory, disk usage, network stats, etc.)

- Aggregates metrics and sends them in configurable batches (with assymetric encryption support)

- Implements retry logic

### Server

- Centralized metrics receiver and processor

- Efficiently handles incoming batch metrics from multiple agents

- Can store metrics in memory (with filesystem synchronization) or in PostgreSQL

- Provides a RESTful API for querying and analyzing metrics

## REST API Endpoints

- GET / - list all metrics as an HTML page

- POST /update { "id": "cpu", "type": "gauge", "value": 23.46 } - update one metric

- POST /updates - update the batch of metrics

- POST /value { "id": "cpu", "type": "gauge" } - get one metric

- POST /update/gauge/cpu/23.46 - update one metric

- GET /value/gauge/cpu - read metric value

- GET /ping - check database status (if started in DB mode)

## Tech Stack

_TBD_

## Development

### To get updates from template

Add git remote:

```

git remote add -m main template https://github.com/Yandex-Practicum/go-musthave-metrics-tpl.git

```

Update autotests:

```

git fetch template && git checkout template/main .github

```

### Requirements to run autotests

- Branch name should follow pattern `iter`, where `` — number of increment. E.g., branch `iter4` will trigger autotests for increments 1-4.