sebastiaanpasterkamp / gobernate

Gobernate provides an easy HTTP Handler containing all end-points required to run a golang service in Kubernetes.

Package gobernate provides an easy HTTP Handler containing all end-points required to run a golang service in Kubernetes. This code is roughly based on: https://blog.gopheracademy.com/advent-2017/kubernetes-ready-service/

To use the gobernate package to Kubernetes enable your service simply use:

import (
	"fmt"
	"net/http"

	"github.com/SebastiaanPasterkamp/gobernate"
)

func main() {
	g := gobernate.New("8080", "example", "1.0.0", "commit-sha", "build-time")

	shutdown := g.Launch()

	g.Router.HandleFunc("/hello", func(w http.ResponseWriter, _ *http.Request) {
		fmt.Fprint(w, "Hello! Your request was processed.")
	})

	g.Ready()
	<-shutdown
}

The gobernate http service provides:

• GET /version to return a JSON structure with the service.
• GET /health to return http.StatusOK to indicate the (web) service is running.
• GET /readiness to signal when the service is ready. Expects Ready() to be called before signaling http.StatusOK, and will report if the service is already shutting down.
• GET /metrics to return Prometheus formatted metric data.

To do

• Option to add a custom readiness callback.
• Constructor with configuration struct.
• Built in OpenTelemetry support.

gobernate's Issues

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• Update module github.com/gorilla/mux to v1.8.1
• Update module github.com/prometheus/client_golang to v1.18.0
• Update module github.com/sirupsen/logrus to v1.9.3
• Update actions/checkout action to v4
• Update github/codeql-action action to v3
• Click on this checkbox to rebase all open PRs at once

Detected dependencies

dockerfile

Dockerfile

• golang 1.18-stretch

droneci

.drone.yml

• golang 1.18-stretch
• golang 1.18-stretch

github-actions

.github/workflows/codeql-analysis.yml

• actions/checkout v3
• github/codeql-action v2
• github/codeql-action v2
• github/codeql-action v2

gomod

go.mod

• go 1.13
• github.com/gorilla/mux v1.8.0
• github.com/prometheus/client_golang v1.12.2
• github.com/sirupsen/logrus v1.8.1

---

• Check this box to trigger a request for Renovate to run again on this repository