-
Notifications
You must be signed in to change notification settings - Fork 3.8k
/
statement_diag.go
289 lines (270 loc) · 7.57 KB
/
statement_diag.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
// Copyright 2021 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 clisqlclient
import (
"database/sql/driver"
"io"
"os"
"time"
"github.com/cockroachdb/errors"
)
// StmtDiagBundleInfo contains information about a statement diagnostics bundle
// that was collected.
type StmtDiagBundleInfo struct {
ID int64
// Statement is the SQL statement fingerprint.
Statement string
CollectedAt time.Time
}
// StmtDiagListBundles retrieves information about all available statement
// diagnostics bundles.
func StmtDiagListBundles(conn Conn) ([]StmtDiagBundleInfo, error) {
result, err := stmtDiagListBundlesInternal(conn)
if err != nil {
return nil, errors.Wrap(
err, "failed to retrieve statement diagnostics bundles",
)
}
return result, nil
}
func stmtDiagListBundlesInternal(conn Conn) ([]StmtDiagBundleInfo, error) {
rows, err := conn.Query(
`SELECT id, statement_fingerprint, collected_at
FROM system.statement_diagnostics
WHERE error IS NULL
ORDER BY collected_at DESC`,
nil, /* args */
)
if err != nil {
return nil, err
}
var result []StmtDiagBundleInfo
vals := make([]driver.Value, 3)
for {
if err := rows.Next(vals); err == io.EOF {
break
} else if err != nil {
return nil, err
}
info := StmtDiagBundleInfo{
ID: vals[0].(int64),
Statement: vals[1].(string),
CollectedAt: vals[2].(time.Time),
}
result = append(result, info)
}
if err := rows.Close(); err != nil {
return nil, err
}
return result, nil
}
// StmtDiagActivationRequest contains information about a statement diagnostics
// activation request.
type StmtDiagActivationRequest struct {
ID int64
// Statement is the SQL statement fingerprint.
Statement string
RequestedAt time.Time
// Zero value indicates that there is no minimum latency set on the request.
MinExecutionLatency time.Duration
// Zero value indicates that the request never expires.
ExpiresAt time.Time
}
// StmtDiagListOutstandingRequests retrieves outstanding statement diagnostics
// activation requests.
func StmtDiagListOutstandingRequests(conn Conn) ([]StmtDiagActivationRequest, error) {
result, err := stmtDiagListOutstandingRequestsInternal(conn)
if err != nil {
return nil, errors.Wrap(
err, "failed to retrieve outstanding statement diagnostics activation requests",
)
}
return result, nil
}
func stmtDiagListOutstandingRequestsInternal(conn Conn) ([]StmtDiagActivationRequest, error) {
rows, err := conn.Query(
`SELECT id, statement_fingerprint, requested_at, EXTRACT(millisecond FROM min_execution_latency)::INT8, expires_at
FROM system.statement_diagnostics_requests
WHERE NOT completed
ORDER BY requested_at DESC`,
nil, /* args */
)
if err != nil {
return nil, err
}
var result []StmtDiagActivationRequest
vals := make([]driver.Value, 5)
for {
if err := rows.Next(vals); err == io.EOF {
break
} else if err != nil {
return nil, err
}
var minExecutionLatency time.Duration
if ms, ok := vals[3].(int64); ok {
minExecutionLatency = time.Millisecond * time.Duration(ms)
}
var expiresAt time.Time
if e, ok := vals[4].(time.Time); ok {
expiresAt = e
}
info := StmtDiagActivationRequest{
ID: vals[0].(int64),
Statement: vals[1].(string),
RequestedAt: vals[2].(time.Time),
MinExecutionLatency: minExecutionLatency,
ExpiresAt: expiresAt,
}
result = append(result, info)
}
if err := rows.Close(); err != nil {
return nil, err
}
return result, nil
}
// StmtDiagDownloadBundle downloads the bundle with the given ID to a file.
func StmtDiagDownloadBundle(conn Conn, id int64, filename string) error {
if err := stmtDiagDownloadBundleInternal(conn, id, filename); err != nil {
return errors.Wrapf(
err, "failed to download statement diagnostics bundle %d to '%s'", id, filename,
)
}
return nil
}
func stmtDiagDownloadBundleInternal(conn Conn, id int64, filename string) error {
// Retrieve the chunk IDs; these are stored in an INT ARRAY column.
rows, err := conn.Query(
"SELECT unnest(bundle_chunks) FROM system.statement_diagnostics WHERE id = $1",
[]driver.Value{id},
)
if err != nil {
return err
}
var chunkIDs []int64
vals := make([]driver.Value, 1)
for {
if err := rows.Next(vals); err == io.EOF {
break
} else if err != nil {
return err
}
chunkIDs = append(chunkIDs, vals[0].(int64))
}
if err := rows.Close(); err != nil {
return err
}
if len(chunkIDs) == 0 {
return errors.Newf("no statement diagnostics bundle with ID %d", id)
}
// Create the file and write out the chunks.
out, err := os.Create(filename)
if err != nil {
return err
}
for _, chunkID := range chunkIDs {
data, err := conn.QueryRow(
"SELECT data FROM system.statement_bundle_chunks WHERE id = $1",
[]driver.Value{chunkID},
)
if err != nil {
_ = out.Close()
return err
}
if _, err := out.Write(data[0].([]byte)); err != nil {
_ = out.Close()
return err
}
}
return out.Close()
}
// StmtDiagDeleteBundle deletes a statement diagnostics bundle.
func StmtDiagDeleteBundle(conn Conn, id int64) error {
_, err := conn.QueryRow(
"SELECT 1 FROM system.statement_diagnostics WHERE id = $1",
[]driver.Value{id},
)
if err != nil {
if err == io.EOF {
return errors.Newf("no statement diagnostics bundle with ID %d", id)
}
return err
}
return conn.ExecTxn(func(conn TxBoundConn) error {
// Delete the request metadata.
if err := conn.Exec(
"DELETE FROM system.statement_diagnostics_requests WHERE statement_diagnostics_id = $1",
[]driver.Value{id},
); err != nil {
return err
}
// Delete the bundle chunks.
if err := conn.Exec(
`DELETE FROM system.statement_bundle_chunks
WHERE id IN (
SELECT unnest(bundle_chunks) FROM system.statement_diagnostics WHERE id = $1
)`,
[]driver.Value{id},
); err != nil {
return err
}
// Finally, delete the diagnostics entry.
return conn.Exec(
"DELETE FROM system.statement_diagnostics WHERE id = $1",
[]driver.Value{id},
)
})
}
// StmtDiagDeleteAllBundles deletes all statement diagnostics bundles.
func StmtDiagDeleteAllBundles(conn Conn) error {
return conn.ExecTxn(func(conn TxBoundConn) error {
// Delete the request metadata.
if err := conn.Exec(
"DELETE FROM system.statement_diagnostics_requests WHERE completed",
nil,
); err != nil {
return err
}
// Delete all bundle chunks.
if err := conn.Exec(
`DELETE FROM system.statement_bundle_chunks WHERE true`,
nil,
); err != nil {
return err
}
// Finally, delete the diagnostics entry.
return conn.Exec(
"DELETE FROM system.statement_diagnostics WHERE true",
nil,
)
})
}
// StmtDiagCancelOutstandingRequest deletes an outstanding statement diagnostics
// activation request.
func StmtDiagCancelOutstandingRequest(conn Conn, id int64) error {
_, err := conn.QueryRow(
"DELETE FROM system.statement_diagnostics_requests WHERE id = $1 RETURNING id",
[]driver.Value{id},
)
if err != nil {
if err == io.EOF {
return errors.Newf("no outstanding activation request with ID %d", id)
}
return err
}
return nil
}
// StmtDiagCancelAllOutstandingRequests deletes all outstanding statement
// diagnostics activation requests.
func StmtDiagCancelAllOutstandingRequests(conn Conn) error {
return conn.Exec(
"DELETE FROM system.statement_diagnostics_requests WHERE NOT completed",
nil,
)
}