-
Notifications
You must be signed in to change notification settings - Fork 91
/
prometheus_test.go
223 lines (178 loc) · 6.63 KB
/
prometheus_test.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
package prometheus
import (
"fmt"
"net/http"
"net/http/httptest"
"strings"
"testing"
"github.com/labstack/echo/v4"
"github.com/prometheus/client_golang/prometheus"
"github.com/stretchr/testify/assert"
)
func unregister(p *Prometheus) {
prometheus.Unregister(p.reqCnt)
prometheus.Unregister(p.reqDur)
prometheus.Unregister(p.reqSz)
prometheus.Unregister(p.resSz)
}
func TestPrometheus_Use(t *testing.T) {
e := echo.New()
p := NewPrometheus("echo", nil)
p.Use(e)
assert.Equal(t, 1, len(e.Routes()), "only one route should be added")
assert.NotNil(t, e, "the engine should not be empty")
assert.Equal(t, e.Routes()[0].Path, p.MetricsPath, "the path should match the metrics path")
unregister(p)
}
func TestPrometheus_Buckets(t *testing.T) {
e := echo.New()
p := NewPrometheus("echo", nil)
p.Use(e)
path := "/ping"
req := httptest.NewRequest(http.MethodGet, path, nil)
rec := httptest.NewRecorder()
e.ServeHTTP(rec, req)
assert.Equal(t, http.StatusNotFound, rec.Code)
req = httptest.NewRequest(http.MethodGet, p.MetricsPath, nil)
rec = httptest.NewRecorder()
e.ServeHTTP(rec, req)
assert.Equal(t, http.StatusOK, rec.Code)
assert.Contains(t, rec.Body.String(), fmt.Sprintf("%s_request_duration_seconds", p.Subsystem))
assert.Regexp(t, "request_duration_seconds.*le=\"0.005\"", rec.Body.String(), "duration should have time bucket (like, 0.005s)")
assert.NotRegexp(t, "request_duration_seconds.*le=\"512000\"", rec.Body.String(), "duration should NOT have a size bucket (like, 512K)")
assert.Regexp(t, "response_size_bytes.*le=\"512000\"", rec.Body.String(), "response size should have a 512K (size) bucket")
assert.NotRegexp(t, "response_size_bytes.*le=\"0.005\"", rec.Body.String(), "response size should NOT have time bucket (like, 0.005s)")
assert.Regexp(t, "request_size_bytes.*le=\"512000\"", rec.Body.String(), "request size should have a 512K (size) bucket")
assert.NotRegexp(t, "request_size_bytes.*le=\"0.005\"", rec.Body.String(), "request should NOT have time bucket (like, 0.005s)")
unregister(p)
}
func TestPath(t *testing.T) {
p := NewPrometheus("echo", nil)
assert.Equal(t, p.MetricsPath, defaultMetricPath, "no usage of path should yield default path")
unregister(p)
}
func TestSubsystem(t *testing.T) {
p := NewPrometheus("echo", nil)
assert.Equal(t, p.Subsystem, "echo", "subsystem should be default")
unregister(p)
}
func TestUse(t *testing.T) {
e := echo.New()
p := NewPrometheus("echo", nil)
req := httptest.NewRequest(http.MethodGet, p.MetricsPath, nil)
rec := httptest.NewRecorder()
e.ServeHTTP(rec, req)
assert.Equal(t, http.StatusNotFound, rec.Code)
p.Use(e)
req = httptest.NewRequest(http.MethodGet, p.MetricsPath, nil)
rec = httptest.NewRecorder()
e.ServeHTTP(rec, req)
assert.Equal(t, http.StatusOK, rec.Code)
unregister(p)
}
func TestIgnore(t *testing.T) {
e := echo.New()
ipath := "/ping"
lipath := fmt.Sprintf(`path="%s"`, ipath)
ignore := func(c echo.Context) bool {
if strings.HasPrefix(c.Path(), ipath) {
return true
}
return false
}
p := NewPrometheus("echo", ignore)
p.Use(e)
req := httptest.NewRequest(http.MethodGet, p.MetricsPath, nil)
rec := httptest.NewRecorder()
e.ServeHTTP(rec, req)
assert.Equal(t, http.StatusOK, rec.Code)
assert.NotContains(t, rec.Body.String(), fmt.Sprintf("%s_requests_total", p.Subsystem))
req = httptest.NewRequest(http.MethodGet, "/ping", nil)
rec = httptest.NewRecorder()
e.ServeHTTP(rec, req)
assert.Equal(t, http.StatusNotFound, rec.Code)
req = httptest.NewRequest(http.MethodGet, p.MetricsPath, nil)
rec = httptest.NewRecorder()
e.ServeHTTP(rec, req)
assert.Equal(t, http.StatusOK, rec.Code)
assert.NotContains(t, rec.Body.String(), lipath, "ignored path must not be present")
unregister(p)
}
func TestMetricsGenerated(t *testing.T) {
e := echo.New()
p := NewPrometheus("echo", nil)
p.Use(e)
req := httptest.NewRequest(http.MethodGet, "/ping?test=1", nil)
rec := httptest.NewRecorder()
e.ServeHTTP(rec, req)
assert.Equal(t, http.StatusNotFound, rec.Code)
req = httptest.NewRequest(http.MethodGet, p.MetricsPath, nil)
rec = httptest.NewRecorder()
e.ServeHTTP(rec, req)
assert.Equal(t, http.StatusOK, rec.Code)
s := rec.Body.String()
assert.Contains(t, s, `url="/ping"`, "path must be present")
unregister(p)
}
func TestMetricsPathIgnored(t *testing.T) {
e := echo.New()
p := NewPrometheus("echo", nil)
p.Use(e)
req := httptest.NewRequest(http.MethodGet, p.MetricsPath, nil)
rec := httptest.NewRecorder()
e.ServeHTTP(rec, req)
assert.Equal(t, http.StatusOK, rec.Code)
assert.NotContains(t, rec.Body.String(), fmt.Sprintf("%s_requests_total", p.Subsystem))
unregister(p)
}
func TestMetricsPushGateway(t *testing.T) {
e := echo.New()
p := NewPrometheus("echo", nil)
p.Use(e)
req := httptest.NewRequest(http.MethodGet, p.MetricsPath, nil)
rec := httptest.NewRecorder()
e.ServeHTTP(rec, req)
assert.Equal(t, http.StatusOK, rec.Code)
assert.NotContains(t, rec.Body.String(), fmt.Sprintf("%s_request_duration", p.Subsystem))
unregister(p)
}
func TestMetricsForErrors(t *testing.T) {
e := echo.New()
p := NewPrometheus("echo", nil)
p.Use(e)
e.GET("/handler_for_ok", func(c echo.Context) error {
return c.JSON(http.StatusOK, "OK")
})
e.GET("/handler_for_nok", func(c echo.Context) error {
return c.JSON(http.StatusConflict, "NOK")
})
e.GET("/handler_for_error", func(c echo.Context) error {
return echo.NewHTTPError(http.StatusBadGateway, "BAD")
})
req := httptest.NewRequest(http.MethodGet, "/handler_for_ok", nil)
rec := httptest.NewRecorder()
e.ServeHTTP(rec, req)
assert.Equal(t, http.StatusOK, rec.Code)
req = httptest.NewRequest(http.MethodGet, "/handler_for_nok", nil)
rec = httptest.NewRecorder()
e.ServeHTTP(rec, req)
assert.Equal(t, http.StatusConflict, rec.Code)
req = httptest.NewRequest(http.MethodGet, "/handler_for_nok", nil)
rec = httptest.NewRecorder()
e.ServeHTTP(rec, req)
assert.Equal(t, http.StatusConflict, rec.Code)
req = httptest.NewRequest(http.MethodGet, "/handler_for_error", nil)
rec = httptest.NewRecorder()
e.ServeHTTP(rec, req)
assert.Equal(t, http.StatusBadGateway, rec.Code)
req = httptest.NewRequest(http.MethodGet, p.MetricsPath, nil)
rec = httptest.NewRecorder()
e.ServeHTTP(rec, req)
assert.Equal(t, http.StatusOK, rec.Code)
body := rec.Body.String()
assert.Contains(t, body, fmt.Sprintf("%s_requests_total", p.Subsystem))
assert.Contains(t, body, `echo_requests_total{code="200",host="example.com",method="GET",url="/handler_for_ok"} 1`)
assert.Contains(t, body, `echo_requests_total{code="409",host="example.com",method="GET",url="/handler_for_nok"} 2`)
assert.Contains(t, body, `echo_requests_total{code="502",host="example.com",method="GET",url="/handler_for_error"} 1`)
unregister(p)
}