Skip to content

Repository files navigation

Go Fast - Telemetry Service

A simple telemetry service built with Go that allows you to store and retrieve metric data.

Prerequisites

  • Go 1.23.5 or higher
  • Docker and Docker Compose
  • Make (optional)
  • Postman (optional)

Quick Start

  1. Clone the repository:
git clone https://github.com/bo0st3r/go-fast.git
cd go-fast
  1. Create a .env file in the root directory with the following content:
POSTGRES_USER=your_username
POSTGRES_PASSWORD=your_password
POSTGRES_DB=your_database_name
APP_PORT=8080
  1. Start the database:
make db-up
  1. Run the application:
make dev

The service will be available at http://localhost:8080

API Endpoints

Health Check

curl http://localhost:8080/health

Create Telemetry Entry

curl -X POST http://localhost:8080/v1/telemetry \
  -H "Content-Type: application/json" \
  -d '{"metric": "nb_players", "value": 5}'

Get All Telemetry Entries

curl http://localhost:8080/v1/telemetry

Get Peak Values Per Metric

curl http://localhost:8080/v1/telemetry/peak

Cleanup

To stop the database:

make db-down

To clean built artifacts:

make clean

Postman Collection

A Postman collection is included in the repository for easy API testing. Import go-fast.postman_collection.json into Postman to get started.

About

Telemetry service built with Go.

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages