/
metrics.go
278 lines (254 loc) · 8.25 KB
/
metrics.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
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
/*
Copyright 2021 Adevinta
*/
package middleware
import (
"context"
"fmt"
"net/http"
"strings"
"time"
"github.com/adevinta/errors"
metrics "github.com/adevinta/vulcan-metrics-client"
jwtkit "github.com/go-kit/kit/auth/jwt"
kitendpoint "github.com/go-kit/kit/endpoint"
kithttp "github.com/go-kit/kit/transport/http"
stdjwt "github.com/golang-jwt/jwt/v4"
"github.com/adevinta/vulcan-api/pkg/api/endpoint"
"github.com/adevinta/vulcan-api/pkg/api/transport"
)
const (
// Metric names
metricTotal = "vulcan.request.total"
metricDuration = "vulcan.request.duration"
metricFailed = "vulcan.request.failed"
// Tags
tagComponent = "component"
tagAction = "action"
tagEntity = "entity"
tagMethod = "method"
tagStatus = "status"
tagUser = "user"
tagTeam = "team"
// Entities
entityUser = "user"
entityTeam = "team"
entityRecipient = "recipient"
entityAsset = "asset"
entityProgram = "program"
entityPolicy = "policiy"
entityCheck = "check"
entityScan = "scan"
entityFinding = "finding"
entityStats = "stats"
entityJob = "job"
apiComponent = "api"
unknownAction = "unknown"
)
var (
endpointToEntity = map[string]string{
// User
endpoint.ListUsers: entityUser,
endpoint.CreateUser: entityUser,
endpoint.UpdateUser: entityUser,
endpoint.FindUser: entityUser,
endpoint.DeleteUser: entityUser,
endpoint.FindProfile: entityUser,
endpoint.GenerateAPIToken: entityUser,
endpoint.ListTeamMembers: entityUser,
endpoint.FindTeamMember: entityUser,
endpoint.CreateTeamMember: entityUser,
endpoint.UpdateTeamMember: entityUser,
endpoint.DeleteTeamMember: entityUser,
// Team
endpoint.CreateTeam: entityTeam,
endpoint.UpdateTeam: entityTeam,
endpoint.FindTeam: entityTeam,
endpoint.ListTeams: entityTeam,
endpoint.DeleteTeam: entityTeam,
endpoint.FindTeamsByUser: entityTeam,
// Recipient
endpoint.ListRecipients: entityRecipient,
endpoint.UpdateRecipients: entityRecipient,
// Asset
endpoint.ListAssets: entityAsset,
endpoint.CreateAsset: entityAsset,
endpoint.CreateAssetMultiStatus: entityAsset,
endpoint.MergeDiscoveredAssets: entityAsset,
endpoint.FindAsset: entityAsset,
endpoint.UpdateAsset: entityAsset,
endpoint.DeleteAsset: entityAsset,
endpoint.CreateGroup: entityAsset,
endpoint.ListGroups: entityAsset,
endpoint.UpdateGroup: entityAsset,
endpoint.DeleteGroup: entityAsset,
endpoint.FindGroup: entityAsset,
endpoint.GroupAsset: entityAsset,
endpoint.UngroupAsset: entityAsset,
endpoint.ListAssetGroup: entityAsset,
// Program
endpoint.ListPrograms: entityProgram,
endpoint.CreateProgram: entityProgram,
endpoint.FindProgram: entityProgram,
endpoint.UpdateProgram: entityProgram,
endpoint.DeleteProgram: entityProgram,
endpoint.CreateSchedule: entityProgram,
endpoint.DeleteSchedule: entityProgram,
endpoint.ScheduleGlobalProgram: entityProgram,
// Policy
endpoint.ListPolicies: entityPolicy,
endpoint.CreatePolicy: entityPolicy,
endpoint.FindPolicy: entityPolicy,
endpoint.UpdatePolicy: entityPolicy,
endpoint.DeletePolicy: entityPolicy,
// Check
endpoint.ListChecktypeSetting: entityCheck,
endpoint.CreateChecktypeSetting: entityCheck,
endpoint.FindChecktypeSetting: entityCheck,
endpoint.UpdateChecktypeSetting: entityCheck,
endpoint.DeleteChecktypeSetting: entityCheck,
// Scan
endpoint.ListProgramScans: entityScan,
endpoint.CreateScan: entityScan,
endpoint.FindScan: entityScan,
endpoint.AbortScan: entityScan,
// Finding
endpoint.ListFindings: entityFinding,
endpoint.ListFindingsIssues: entityFinding,
endpoint.ListFindingsTargets: entityFinding,
endpoint.ListFindingsByIssue: entityFinding,
endpoint.ListFindingsByTarget: entityFinding,
endpoint.FindFinding: entityFinding,
endpoint.CreateFindingOverwrite: entityFinding,
endpoint.ListFindingOverwrites: entityFinding,
endpoint.ListFindingsLabels: entityFinding,
endpoint.CreateFindingTicket: entityFinding,
// Stats
endpoint.StatsCoverage: entityStats,
endpoint.StatsMTTR: entityStats,
endpoint.StatsExposure: entityStats,
endpoint.StatsCurrentExposure: entityStats,
endpoint.StatsOpen: entityStats,
endpoint.StatsFixed: entityStats,
endpoint.GlobalStatsMTTR: entityStats,
endpoint.GlobalStatsExposure: entityStats,
endpoint.GlobalStatsCurrentExposure: entityStats,
endpoint.GlobalStatsOpen: entityStats,
endpoint.GlobalStatsFixed: entityStats,
endpoint.GlobalStatsAssets: entityStats,
// Jobs
endpoint.FindJob: entityJob,
}
)
// MetricsMiddleware implements a metrics middleware over an endpoint.
type MetricsMiddleware interface {
Measure(next kitendpoint.Endpoint) kitendpoint.Endpoint
}
type metricsMiddleware struct {
metricsClient metrics.Client
}
// NewMetricsMiddleware creates a new metrics middleware pushing the
// metrics through the given metrics client.
func NewMetricsMiddleware(metricsClient metrics.Client) MetricsMiddleware {
return &metricsMiddleware{
metricsClient: metricsClient,
}
}
func (m *metricsMiddleware) Measure(next kitendpoint.Endpoint) kitendpoint.Endpoint {
return func(ctx context.Context, request interface{}) (interface{}, error) {
// Time and execute request
reqStart := time.Now()
res, err := next(ctx, request)
reqEnd := time.Now()
// Collect metrics
endpoint := ctx.Value(transport.ContextKeyEndpoint).(string)
httpMethod := ctx.Value(kithttp.ContextKeyRequestMethod).(string)
httpStatus := parseHTTPStatus(res, err)
duration := reqEnd.Sub(reqStart).Milliseconds()
failed := httpStatus >= 400
user := parseUser(ctx)
team := parseTeam(ctx)
// Build tags
tags := []string{
fmt.Sprint(tagComponent, ":", apiComponent),
fmt.Sprint(tagAction, ":", endpoint),
fmt.Sprint(tagEntity, ":", endpointToEntity[endpoint]),
fmt.Sprint(tagMethod, ":", httpMethod),
fmt.Sprint(tagStatus, ":", httpStatus),
fmt.Sprint(tagUser, ":", user),
fmt.Sprint(tagTeam, ":", team),
}
// Push metrics
m.pushMetrics(httpMethod, duration, failed, tags)
return res, err
}
}
func (m *metricsMiddleware) pushMetrics(httpMethod string, duration int64, failed bool, tags []string) {
mm := []metrics.Metric{
{
Name: metricTotal,
Typ: metrics.Count,
Value: 1,
Tags: tags,
},
{
Name: metricDuration,
Typ: metrics.Histogram,
Value: float64(duration),
Tags: tags,
},
}
if failed {
mm = append(mm, metrics.Metric{
Name: metricFailed,
Typ: metrics.Count,
Value: 1,
Tags: tags,
})
}
for _, met := range mm {
m.metricsClient.Push(met)
}
}
func parseHTTPStatus(resp interface{}, err error) int {
// If err is not nil, try to cast to ErrStack and
// return its StatusCode.
// Otherwise default to HTTP 500 status code.
if err != nil {
if errStack, ok := err.(*errors.ErrorStack); ok {
return errStack.StatusCode()
}
return http.StatusInternalServerError
}
// If err is nil, try to cast to endpoint HTTPResponse
// and return its StatusCode.
// Otherwise default to HTTP 200 status code.
if httpResp, ok := resp.(endpoint.HTTPResponse); ok {
return httpResp.StatusCode()
}
return http.StatusOK
}
// parseUser returns the user from the JWT token.
func parseUser(ctx context.Context) string {
user := ""
token, ok := ctx.Value(jwtkit.JWTTokenContextKey).(string)
if ok {
claims := stdjwt.MapClaims{}
// IMPORTANT: This trusts the user provided in the JWT token without
// verifying its signature. This is only used for metrics purposes.
_, _, err := new(stdjwt.Parser).ParseUnverified(token, claims)
if err == nil {
user = claims["sub"].(string)
}
}
return user
}
// parseTeam team returns the team from the URL path.
func parseTeam(ctx context.Context) string {
team := ""
httpPath := ctx.Value(kithttp.ContextKeyRequestPath).(string)
if strings.HasPrefix(httpPath, "/api/v1/teams/") {
team = strings.Split(httpPath, "/")[4]
}
return team
}