/
router_metrics.go
155 lines (138 loc) · 5.36 KB
/
router_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
package core
import (
"github.com/wundergraph/cosmo/router/pkg/metric"
"strconv"
graphqlmetricsv1 "github.com/wundergraph/cosmo/router/gen/proto/wg/cosmo/graphqlmetrics/v1"
"github.com/wundergraph/cosmo/router/internal/graphqlmetrics"
"github.com/wundergraph/graphql-go-tools/v2/pkg/engine/plan"
"go.uber.org/zap"
)
type RouterMetrics interface {
StartOperation(clientInfo *ClientInfo, logger *zap.Logger, requestContentLength int64) *OperationMetrics
ExportSchemaUsageInfo(operationContext *operationContext, statusCode int, hasError bool)
GqlMetricsExporter() graphqlmetrics.SchemaUsageExporter
MetricStore() metric.Store
}
// routerMetrics encapsulates all data and configuration that the router
// uses to collect and its metrics
type routerMetrics struct {
metrics metric.Store
gqlMetricsExporter graphqlmetrics.SchemaUsageExporter
routerConfigVersion string
logger *zap.Logger
exportEnabled bool
}
type routerMetricsConfig struct {
metrics metric.Store
gqlMetricsExporter graphqlmetrics.SchemaUsageExporter
routerConfigVersion string
logger *zap.Logger
exportEnabled bool
}
func NewRouterMetrics(cfg *routerMetricsConfig) RouterMetrics {
return &routerMetrics{
metrics: cfg.metrics,
gqlMetricsExporter: cfg.gqlMetricsExporter,
routerConfigVersion: cfg.routerConfigVersion,
logger: cfg.logger,
exportEnabled: cfg.exportEnabled,
}
}
// StartOperation starts the metrics for a new GraphQL operation. The returned value is a OperationMetrics
// where the caller must always call Finish() (usually via defer()). If the metrics are disabled, this
// returns nil, but OperationMetrics is safe to call with a nil receiver.
func (m *routerMetrics) StartOperation(clientInfo *ClientInfo, logger *zap.Logger, requestContentLength int64) *OperationMetrics {
metrics := startOperationMetrics(m, logger, requestContentLength, m.routerConfigVersion)
metrics.AddClientInfo(clientInfo)
return metrics
}
func (m *routerMetrics) MetricStore() metric.Store {
return m.metrics
}
func (m *routerMetrics) GqlMetricsExporter() graphqlmetrics.SchemaUsageExporter {
return m.gqlMetricsExporter
}
func (m *routerMetrics) ExportSchemaUsageInfo(operationContext *operationContext, statusCode int, hasError bool) {
if !m.exportEnabled {
return
}
usageInfo, err := plan.GetSchemaUsageInfo(
operationContext.preparedPlan.preparedPlan,
operationContext.preparedPlan.operationDocument,
operationContext.preparedPlan.schemaDocument,
operationContext.Variables(),
)
if err != nil {
m.logger.Error("failed to get schema usage info", zap.Error(err))
return
}
fieldUsageInfos := make([]*graphqlmetricsv1.TypeFieldUsageInfo, len(usageInfo.TypeFields))
argumentUsageInfos := make([]*graphqlmetricsv1.ArgumentUsageInfo, len(usageInfo.Arguments))
inputUsageInfos := make([]*graphqlmetricsv1.InputUsageInfo, len(usageInfo.InputTypeFields))
for i := range usageInfo.TypeFields {
fieldUsageInfos[i] = &graphqlmetricsv1.TypeFieldUsageInfo{
Count: 1,
Path: usageInfo.TypeFields[i].Path,
TypeNames: usageInfo.TypeFields[i].EnclosingTypeNames,
SubgraphIDs: usageInfo.TypeFields[i].Source.IDs,
NamedType: usageInfo.TypeFields[i].FieldTypeName,
}
}
for i := range usageInfo.Arguments {
argumentUsageInfos[i] = &graphqlmetricsv1.ArgumentUsageInfo{
Count: 1,
Path: []string{usageInfo.Arguments[i].FieldName, usageInfo.Arguments[i].ArgumentName},
TypeName: usageInfo.Arguments[i].EnclosingTypeName,
NamedType: usageInfo.Arguments[i].ArgumentTypeName,
}
}
for i := range usageInfo.InputTypeFields {
// In that case it is a top level input field usage e.g employee(id: 1)
if len(usageInfo.InputTypeFields[i].EnclosingTypeNames) == 0 {
inputUsageInfos[i] = &graphqlmetricsv1.InputUsageInfo{
Count: uint64(usageInfo.InputTypeFields[i].Count),
NamedType: usageInfo.InputTypeFields[i].FieldTypeName,
// Root input fields have no enclosing type name and no path
}
} else {
inputUsageInfos[i] = &graphqlmetricsv1.InputUsageInfo{
Path: []string{usageInfo.InputTypeFields[i].EnclosingTypeNames[0], usageInfo.InputTypeFields[i].FieldName},
Count: uint64(usageInfo.InputTypeFields[i].Count),
TypeName: usageInfo.InputTypeFields[i].EnclosingTypeNames[0],
NamedType: usageInfo.InputTypeFields[i].FieldTypeName,
}
}
}
var opType graphqlmetricsv1.OperationType
switch operationContext.opType {
case "query":
opType = graphqlmetricsv1.OperationType_QUERY
case "mutation":
opType = graphqlmetricsv1.OperationType_MUTATION
case "subscription":
opType = graphqlmetricsv1.OperationType_SUBSCRIPTION
}
// Non-blocking
m.gqlMetricsExporter.Record(&graphqlmetricsv1.SchemaUsageInfo{
RequestDocument: operationContext.content,
TypeFieldMetrics: fieldUsageInfos,
OperationInfo: &graphqlmetricsv1.OperationInfo{
Type: opType,
Hash: strconv.FormatUint(operationContext.hash, 10),
Name: operationContext.name,
},
SchemaInfo: &graphqlmetricsv1.SchemaInfo{
Version: m.routerConfigVersion,
},
ClientInfo: &graphqlmetricsv1.ClientInfo{
Name: operationContext.clientInfo.Name,
Version: operationContext.clientInfo.Version,
},
ArgumentMetrics: argumentUsageInfos,
InputMetrics: inputUsageInfos,
RequestInfo: &graphqlmetricsv1.RequestInfo{
Error: hasError,
StatusCode: int32(statusCode),
},
})
}