4142091150

Committed 10 Feb 2023 08:24AM UTC coverage: 90.999% (-0.2%) from 91.179%

Build # 4142091150

Build Type

github

Committed by Adrian Shum

Commit Message

refactor interfaces

Pull Request Pull Request #282: feat(server): Add optional Prometheus metrics server

Run Details

67 of 67 new or added lines in 4 files covered. (100.0%)

5530 of 6077 relevant lines covered (91.0%)

1.07 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

76.32

/metrics/prometheusmetrics/prometheus.go

package prometheusmetrics

import (
        "context"
        "net/http"

        "github.com/prometheus/client_golang/prometheus/promhttp"
        "go.uber.org/zap"
)

// PrometheusMetrics wraps the Service with additional http and app lifecycle handling
type PrometheusMetrics struct {
        http.Server

        Path   string
        Logger *zap.Logger
}

// New create new metrics PrometheusMetrics
func New(options ...Option) *PrometheusMetrics {
        s := &PrometheusMetrics{
                Logger: zap.NewNop(),
        }
        for _, option := range options {
                option(s)
        }
        if s.Path != "" {
                mux := http.NewServeMux()
                mux.Handle(s.Path, promhttp.Handler())
                mux.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
                        http.Redirect(w, r, s.Path, http.StatusPermanentRedirect)
                })
                s.Handler = mux
        } else {
                s.Handler = promhttp.Handler()
        }
        return s
}

// Startup prometheus metrics server
func (s *PrometheusMetrics) Startup(_ context.Context) error {
        go func() {
                if err := s.ListenAndServe(); err != nil && err != http.ErrServerClosed {
                        s.Logger.Fatal("prometheus listen", zap.Error(err))
                }
        }()
        s.Logger.Info("prometheus listen", zap.String("addr", s.Addr), zap.String("path", s.Path))
        return nil
}

// Option PrometheusMetrics option
type Option func(s *PrometheusMetrics)

// WithAddr with server and port option
func WithAddr(addr string) Option {
        return func(s *PrometheusMetrics) {
                s.Addr = addr
        }
}

// WithPath with path option
func WithPath(path string) Option {
        return func(s *PrometheusMetrics) {
                s.Path = path
        }
}

// WithLogger with logger option
func WithLogger(logger *zap.Logger) Option {
        return func(s *PrometheusMetrics) {
                if logger != nil {
                        s.Logger = logger
                }
        }
}

1	package prometheusmetrics
2
3	import (
4	"context"
5	"net/http"
6
7	"github.com/prometheus/client_golang/prometheus/promhttp"
8	"go.uber.org/zap"
9	)
10
11	// PrometheusMetrics wraps the Service with additional http and app lifecycle handling
12	type PrometheusMetrics struct {
13	http.Server
14
15	Path string
16	Logger *zap.Logger
17	}
18
19	// New create new metrics PrometheusMetrics
20	func New(options ...Option) *PrometheusMetrics {	1✔
21	s := &PrometheusMetrics{	1✔
22	Logger: zap.NewNop(),	1✔
23	}	1✔
24	for _, option := range options {	2✔
25	option(s)	1✔
26	}	1✔
27	if s.Path != "" {	2✔
28	mux := http.NewServeMux()	1✔
29	mux.Handle(s.Path, promhttp.Handler())	1✔
30	mux.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {	1✔
31	http.Redirect(w, r, s.Path, http.StatusPermanentRedirect)	×
32	})	×
33	s.Handler = mux	1✔
34	} else {	1✔
35	s.Handler = promhttp.Handler()	1✔
36	}	1✔
37	return s	1✔
38	}
39
40	// Startup prometheus metrics server
41	func (s *PrometheusMetrics) Startup(_ context.Context) error {	×
42	go func() {	×
43	if err := s.ListenAndServe(); err != nil && err != http.ErrServerClosed {	×
44	s.Logger.Fatal("prometheus listen", zap.Error(err))	×
45	}	×
46	}()
47	s.Logger.Info("prometheus listen", zap.String("addr", s.Addr), zap.String("path", s.Path))	×
48	return nil	×
49	}
50
51	// Option PrometheusMetrics option
52	type Option func(s *PrometheusMetrics)
53
54	// WithAddr with server and port option
55	func WithAddr(addr string) Option {	1✔
56	return func(s *PrometheusMetrics) {	2✔
57	s.Addr = addr	1✔
58	}	1✔
59	}
60
61	// WithPath with path option
62	func WithPath(path string) Option {	1✔
63	return func(s *PrometheusMetrics) {	2✔
64	s.Path = path	1✔
65	}	1✔
66	}
67
68	// WithLogger with logger option
69	func WithLogger(logger *zap.Logger) Option {	1✔
70	return func(s *PrometheusMetrics) {	2✔
71	if logger != nil {	2✔
72	s.Logger = logger	1✔
73	}	1✔
74	}
75	}

cshum / imagor / 4142091150

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous