alexellis / hash-browns

Generate SHA256 hashes in Go with Prometheus metrics

hash-browns

This repository contains:

• A Quick-Start recipe for monitoring an application with Prometheus.
• A tiny web-server for creating SHA256 hashes with a /metrics endpoint

Read more on the related blog post

Get started

• Initialize Docker Swarm locally

  docker swarm init

• Deploy:

  docker stack deploy tutorial --compose-file=./docker-compose.yml

• View logs:

  docker service logs tutorial_hashbrowns

• View scrape targets

  http://localhost:9090/targets

• View the site:

  http://127.0.0.1:8080/

• Invoke the service to generate some logs

  curl -d test http://localhost:8080/hash
  
  9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08

• Open Prometheus:

  http://127.0.0.1:9090/

  View metrics such as hash_seconds_sum hash_seconds_count and hash_seconds_bucket

• Build the image (optional)

  make docker push manifest

Notes for Raspberry PI:

A multi-arch Docker image is available, so you can use the same instructions.

hash-browns's Issues

Deprecated prometheus Handler

hash-browns/server.go

Line 18 in 73a168a

return prometheus.Handler()

you have to use promhttp.Handler()

Why vendor Directory

I'm more just curious about this. I have seen a couple projects include the vendor directory in their git repo along with the Gopkg files. Wouldn't you just need one or the other? Is there a reason to include this directory?

Pin Prometheus version and migrate config

The Prometheus version of the Docker image in docker-compose.yml is not pinned to a specific version, this means breaking changes in the config prometheus.yml will break the example.

Tasks:

• Pin Prometheus version to latest
• Migrate config in prometheus.yml
• Fully test

https://github.com/alexellis/hash-browns/blob/master/prometheus.yml

Project License

What license is this project under? Maybe consider adding a LICENSE file?

Question about histogram metric

https://github.com/alexellis/hash-browns/blob/master/main.go:101
The value of "code" is never set to 200 after processing the hash.