bronhy / arc

Skeleton for REST server with metrics endpoint

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Go skeleton application for REST server with additional metrics endpoint

check Go Reference Go Report License

You can run the server by typing docker-compose up --build.

Check main.go for example usage.

This project also includes the following middlewares which can be use independently of the server

  • RenderJSON - simplifies implementation of JSON REST API endpoints
  • ZapLogger - chi middleware for logging using zap logger
  • PromMetrics - chi middleware providing Prometheus metrics to your HTTP server Tracks total number of requests and requests duration partitioned by status code, method and request URI

Inside .examples directory you can find basic examples for each of the middlewares. Just run go run main.go and check the output in your browser, localhost:3000. To check the metrics in PromMetrics example, use localhost:3001.

About

Skeleton for REST server with metrics endpoint

License:MIT License


Languages

Language:Go 97.1%Language:Makefile 1.5%Language:Dockerfile 1.4%