-
Notifications
You must be signed in to change notification settings - Fork 3.8k
/
registry.go
323 lines (288 loc) · 9.47 KB
/
registry.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
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
// Copyright 2022 The Cockroach Authors.
//
// Use of this software is governed by the Business Source License
// included in the file licenses/BSL.txt.
//
// As of the Change Date specified in that file, in accordance with
// the Business Source License, use of this software will be governed
// by the Apache License, Version 2.0, included in the file
// licenses/APL.txt.
package insights
import (
"context"
"sync"
"github.com/cockroachdb/cockroach/pkg/obsservice/obspb"
"github.com/cockroachdb/cockroach/pkg/settings/cluster"
"github.com/cockroachdb/cockroach/pkg/sql/clusterunique"
"github.com/cockroachdb/cockroach/pkg/util/intsets"
"github.com/cockroachdb/cockroach/pkg/util/log"
"github.com/cockroachdb/cockroach/pkg/util/syncutil"
"github.com/cockroachdb/redact"
)
// This registry is the central object in the insights subsystem. It observes
// statement execution to determine which statements are outliers and
// writes insights into the provided sink.
type lockingRegistry struct {
mu struct {
syncutil.Mutex
statements map[clusterunique.ID]*statementBuf
}
detector detector
causes *causes
sink sink
}
var _ Writer = (*lockingRegistry)(nil)
var _ CacheClearer = (*lockingRegistry)(nil)
func (r *lockingRegistry) Clear(_ context.Context) {
r.mu.Lock()
defer r.mu.Unlock()
r.mu.statements = make(map[clusterunique.ID]*statementBuf)
}
func (r *lockingRegistry) ObserveStatement(sessionID clusterunique.ID, statement *Statement) {
if !r.enabled() {
return
}
r.mu.Lock()
defer r.mu.Unlock()
b, ok := r.mu.statements[sessionID]
if !ok {
b = statementsBufPool.Get().(*statementBuf)
r.mu.statements[sessionID] = b
}
b.append(statement)
}
type statementBuf []*Statement
func (b *statementBuf) append(statement *Statement) {
*b = append(*b, statement)
}
func (b *statementBuf) release() {
for i, n := 0, len(*b); i < n; i++ {
(*b)[i] = nil
}
*b = (*b)[:0]
statementsBufPool.Put(b)
}
var statementsBufPool = sync.Pool{
New: func() interface{} {
return new(statementBuf)
},
}
// Instead of creating and allocating a map to track duplicate
// causes each time, we just iterate through the array since
// we don't expect it to be very large.
func addCause(arr []Cause, n Cause) []Cause {
for i := range arr {
if arr[i] == n {
return arr
}
}
return append(arr, n)
}
// Instead of creating and allocating a map to track duplicate
// problems each time, we just iterate through the array since
// we don't expect it to be very large.
func addProblem(arr []Problem, n Problem) []Problem {
for i := range arr {
if arr[i] == n {
return arr
}
}
return append(arr, n)
}
func (r *lockingRegistry) ObserveTransaction(
ctx context.Context, sessionID clusterunique.ID, transaction *Transaction,
) {
if !r.enabled() {
return
}
if transaction.ID.String() == "00000000-0000-0000-0000-000000000000" {
return
}
statements, ok := func() (*statementBuf, bool) {
r.mu.Lock()
defer r.mu.Unlock()
statements, ok := r.mu.statements[sessionID]
if !ok {
return nil, false
}
delete(r.mu.statements, sessionID)
return statements, true
}()
if !ok {
return
}
defer statements.release()
// Mark statements which are detected as slow or have a failed status.
var slowOrFailedStatements intsets.Fast
for i, s := range *statements {
if !shouldIgnoreStatement(s) && (r.detector.isSlow(s) || isFailed(s)) {
slowOrFailedStatements.Add(i)
}
}
// So far this is the only case when a transaction is considered slow.
// In the future, we may want to make a detector for transactions if there
// are more cases.
highContention := false
if transaction.Contention != nil {
highContention = transaction.Contention.Seconds() >= LatencyThreshold.Get(&r.causes.st.SV).Seconds()
}
txnFailed := transaction.Status == Transaction_Failed
if slowOrFailedStatements.Empty() && !highContention && !txnFailed {
// We only record an insight if we have slow statements, high txn contention, or failed executions.
return
}
// Note that we'll record insights for every statement, not just for
// the slow ones.
insight := makeInsight(sessionID, transaction)
if highContention {
insight.Transaction.Problems = addProblem(insight.Transaction.Problems, Problem_SlowExecution)
insight.Transaction.Causes = addCause(insight.Transaction.Causes, Cause_HighContention)
}
if txnFailed {
insight.Transaction.Problems = addProblem(insight.Transaction.Problems, Problem_FailedExecution)
}
// The transaction status will reflect the status of its statements; it will
// default to completed unless a failed statement status is found. Note that
// this does not take into account the "Cancelled" transaction status.
var lastStmtErr redact.RedactableString
var lastStmtErrCode string
for i, s := range *statements {
if slowOrFailedStatements.Contains(i) {
switch s.Status {
case Statement_Completed:
s.Problem = Problem_SlowExecution
s.Causes = r.causes.examine(s.Causes, s)
case Statement_Failed:
s.Problem = Problem_FailedExecution
if transaction.LastErrorCode == "" {
lastStmtErr = s.ErrorMsg
lastStmtErrCode = s.ErrorCode
}
}
// Bubble up stmt problems and causes.
for i := range s.Causes {
insight.Transaction.Causes = addCause(insight.Transaction.Causes, s.Causes[i])
}
insight.Transaction.Problems = addProblem(insight.Transaction.Problems, s.Problem)
}
insight.Transaction.StmtExecutionIDs = append(insight.Transaction.StmtExecutionIDs, s.ID)
insight.Statements = append(insight.Statements, s)
}
if transaction.LastErrorCode == "" && lastStmtErrCode != "" {
// Stmt failure equates to transaction failure. Sometimes we
// can't propagate the error up to the transaction level so
// we manually set the transaction's failure info here.
transaction.LastErrorMsg = lastStmtErr
transaction.LastErrorCode = lastStmtErrCode
}
r.sink.AddInsight(insight)
// Exporting Insights to Observability Service.
if SQLInsightsStatsExportEnabled.Get(&r.causes.st.SV) {
err := r.sink.ExportInsight(ctx, insight)
if err != nil {
log.Errorf(ctx, "encountered an error at insights export: %v", err)
}
}
}
// TODO(todd):
//
// Once we can handle sufficient throughput to live on the hot
// execution path in #81021, we can probably get rid of this external
// concept of "enabled" and let the detectors just decide for themselves
// internally.
func (r *lockingRegistry) enabled() bool {
return r.detector.enabled()
}
func newRegistry(st *cluster.Settings, detector detector, sink sink) *lockingRegistry {
lr := &lockingRegistry{
detector: detector,
causes: &causes{st: st},
sink: sink,
}
lr.mu.statements = make(map[clusterunique.ID]*statementBuf)
return lr
}
func (s *Statement) CopyTo(
ctx context.Context, t *Transaction, session *Session, other *obspb.StatementInsightsStatistics,
) {
if other == nil {
log.Errorf(ctx, "no object passed from pool for Insights exporter")
return
}
other.AutoRetryReason = s.AutoRetryReason
other.Contention = s.Contention
other.CPUSQLNanos = s.CPUSQLNanos
other.Database = s.Database
other.EndTime = &s.EndTime
other.ErrorCode = s.ErrorCode
other.FingerprintID = uint64(s.FingerprintID)
other.FullScan = s.FullScan
other.IndexRecommendations = s.IndexRecommendations
other.Nodes = s.Nodes
other.PlanGist = s.PlanGist
other.Query = s.Query
other.Retries = s.Retries
other.RowsRead = s.RowsRead
other.RowsWritten = s.RowsWritten
other.ServiceLatSeconds = s.LatencyInSeconds
other.StartTime = &s.StartTime
other.LastErrorRedactable = string(s.ErrorMsg.Redact())
var err error
other.ID, err = s.ID.MarshalJSON()
if err != nil {
log.Errorf(ctx, "marshalling statement insights ID for Insights exporter")
}
other.ApplicationName = t.ApplicationName
other.ImplicitTxn = t.ImplicitTxn
other.TxnFingerprintID = uint64(t.FingerprintID)
other.User = t.User
other.UserPriority = t.UserPriority
txnID, err := t.ID.MarshalJSON()
if err != nil {
log.Errorf(ctx, "marshalling transaction insights ID for Insights exporter")
} else {
other.TransactionID = txnID
other.ID = txnID
}
other.SessionID, err = session.ID.MarshalJSON()
if err != nil {
log.Errorf(ctx, "marshalling sessions ID for Insights exporter")
}
switch s.Status {
case Statement_Completed:
other.Status = obspb.StatementInsightsStatistics_Completed
case Statement_Failed:
other.Status = obspb.StatementInsightsStatistics_Failed
default:
other.Status = obspb.StatementInsightsStatistics_Completed
}
switch s.Problem {
case Problem_FailedExecution:
other.Problem = obspb.StatementInsightsStatistics_FailedExecution
case Problem_SlowExecution:
other.Problem = obspb.StatementInsightsStatistics_SlowExecution
default:
other.Problem = obspb.StatementInsightsStatistics_None
}
other.Causes = []obspb.StatementInsightsStatistics_Cause{}
for _, c := range s.Causes {
switch c {
case Cause_SuboptimalPlan:
other.Causes = append(other.Causes, obspb.StatementInsightsStatistics_SuboptimalPlan)
case Cause_HighRetryCount:
other.Causes = append(other.Causes, obspb.StatementInsightsStatistics_HighRetryCount)
case Cause_PlanRegression:
other.Causes = append(other.Causes, obspb.StatementInsightsStatistics_PlanRegression)
case Cause_HighContention:
other.Causes = append(other.Causes, obspb.StatementInsightsStatistics_HighContention)
default:
other.Causes = append(other.Causes, obspb.StatementInsightsStatistics_Unset)
}
}
// TODO(maryliag): add information about Contention Events
// and Idle/Parse/Run Latencies.
//other.ContentionEvents
//other.IdleLatSeconds
//other.ParseLatSeconds
//other.RunLatSeconds
}