cleanups:
* move metrics endpoint protection middleware to correct file * move /metrics route to Chi route group * update readme
This commit is contained in:
1 parent
687e9accf8
commit
a26c0b2b47
3 files changed
+31
-19
No files matched your search
@@ -25,15 +25,18 @@ Alternately, even just feedback is great:
|
||||
* Stub Authentication middleware
|
||||
* Helper functions for encoding/decoding json
|
||||
* Healthcheck route
|
||||
* No global state
|
||||
* Prometheus metrics endpoint
|
||||
* No global state of our own
|
||||
* some deps have some, such as the metrics collector and Sentry
|
||||
|
||||
# Design Decisions
|
||||
|
||||
* TLS is terminated somewhere else, like on a sidecar or reverse proxy.
|
||||
* logging: [rs/zerolog](https://github.com/rs/zerolog)
|
||||
* configuration: [spf13/viper](https://github.com/spf13/viper)
|
||||
* mux/router: [go-chi/chi](https://github.com/go-chi/chi)
|
||||
* prometheus-style metrics via [slok/go-http-metrics](https://github.com/slok/go-http-metrics)
|
||||
* used as a wrapper around env vars
|
||||
* router is Chi: [go-chi/chi](https://github.com/go-chi/chi)
|
||||
* Prometheus-style metrics via [slok/go-http-metrics](https://github.com/slok/go-http-metrics)
|
||||
* database: TBD (thinking about [go-gorm/gorm](https://github.com/go-gorm/gorm))
|
||||
* templating: TBD (suggestions welcome)
|
||||
|
||||
@@ -44,6 +47,11 @@ Alternately, even just feedback is great:
|
||||
* sync.Once example for precompiling templates
|
||||
* Bundling Static Assets Into Binary
|
||||
|
||||
# Known Bugs (more TODO)
|
||||
|
||||
* Chi recovery middleware logs non-json when in non-tty stdout mode,
|
||||
breaking validity of stdout as a json stream
|
||||
|
||||
# Author
|
||||
|
||||
* [sneak@sneak.berlin](mailto:sneak@sneak.berlin)
|
||||
|
||||
Reference in new issue
Block a user