feat: fix metrics readme

metrics/readme.go

@@ -2,31 +2,23 @@ package metrics
 
 import (
 	"github.com/foomo/keel/markdown"
-	"github.com/foomo/keel/telemetry/nonrecording"
 	"github.com/prometheus/client_golang/prometheus"
 )
 
 func Readme() string {
 	md := markdown.Markdown{}
-	values := nonrecording.Metrics()
+	var rows [][]string
 
-	gatherer, _ := prometheus.DefaultRegisterer.(*prometheus.Registry).Gather()
-	for _, value := range gatherer {
-		values = append(values, nonrecording.Metric{
-			Name: value.GetName(),
-			Type: value.GetType().String(),
-			Help: value.GetHelp(),
-		})
+	if gatherer, err := prometheus.DefaultGatherer.Gather(); err == nil {
+		for _, value := range gatherer {
+			rows = append(rows, []string{
+				value.GetName(),
+				value.GetType().String(),
+				value.GetHelp(),
+			})
+		}
 	}
 
-	rows := make([][]string, 0, len(values))
-	for _, value := range values {
-		rows = append(rows, []string{
-			markdown.Code(value.Name),
-			value.Type,
-			value.Help,
-		})
-	}
 	if len(rows) > 0 {
 		md.Println("### Metrics")
 		md.Println("")

service/httpreadme_test.go

@@ -11,6 +11,9 @@ import (
 	"github.com/foomo/keel/config"
 	"github.com/foomo/keel/env"
 	"github.com/foomo/keel/service"
+	"github.com/prometheus/client_golang/prometheus"
+	"github.com/prometheus/client_golang/prometheus/promauto"
+	"go.opentelemetry.io/otel/metric/instrument"
 	"go.uber.org/zap"
 )
 
@@ -21,6 +24,7 @@ func ExampleNewHTTPReadme() {
 
 	svr := keel.NewServer(
 		keel.WithLogger(zap.NewNop()),
+		keel.WithPrometheusMeter(true),
 		keel.WithHTTPReadmeService(true),
 	)
 
@@ -40,6 +44,18 @@ func ExampleNewHTTPReadme() {
 	_ = config.MustGetBool(c, "example.required.bool")
 	_ = config.MustGetString(c, "example.required.string")
 
+	m := svr.Meter()
+
+	// add metrics
+	fooBarCounter := promauto.NewCounter(prometheus.CounterOpts{
+		Name: "foo_bar_total",
+		Help: "Foo bar metrics",
+	})
+	fooBazCounter, _ := m.SyncInt64().Counter("foo_baz_total", instrument.WithDescription("Foo baz metrics"))
+
+	fooBarCounter.Add(1)
+	fooBazCounter.Add(svr.Context(), 1)
+
 	// add http service
 	svr.AddService(service.NewHTTP(l, "demp-http", "localhost:8080", http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
 		w.WriteHeader(http.StatusOK)
@@ -136,6 +152,8 @@ func ExampleNewHTTPReadme() {
 	//
 	// | Name                               | Type    | Description                                                        |
 	// | ---------------------------------- | ------- | ------------------------------------------------------------------ |
+	// | foo_bar_total                      | COUNTER | Foo bar metrics                                                    |
+	// | foo_baz_total                      | COUNTER | Foo baz metrics                                                    |
 	// | `go_gc_duration_seconds`           | SUMMARY | A summary of the pause duration of garbage collection cycles.      |
 	// | `go_goroutines`                    | GAUGE   | Number of goroutines that currently exist.                         |
 	// | `go_info`                          | GAUGE   | Information about the Go environment.                              |