-
Notifications
You must be signed in to change notification settings - Fork 64
/
citus.go
389 lines (351 loc) · 12.7 KB
/
citus.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
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
/*
* Copyright 2023 RapidLoop, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package collector
import (
"context"
"fmt"
"log"
"strconv"
"strings"
"github.com/rapidloop/pgmetrics"
"golang.org/x/mod/semver"
)
func (c *collector) getCitus(currdb string, fillSize bool) {
// check if citus extension is present in current database
found := false
for _, e := range c.result.Extensions {
if e.Name == "citus" && e.DBName == currdb {
found = true
break
}
}
if !found {
return
}
// setup result
if c.result.Citus == nil {
c.result.Citus = make(map[string]*pgmetrics.Citus)
}
if c.result.Citus[currdb] == nil {
c.result.Citus[currdb] = &pgmetrics.Citus{}
}
// get version
var majorVer int
c.getCitusVersion(currdb, &majorVer)
// get size (if not explicitly disabled)
if fillSize {
c.getCitusTableSizes(currdb)
}
c.getCitusNodes(currdb) // pg_dist_node
c.getCitusStatements(currdb) // citus_stat_statements
c.getCitusActivity(currdb, majorVer) // citus_{dist_,worker_,}stat_activity
c.getCitusLocks(currdb, majorVer) // citus_lock_waits
if majorVer >= 11 {
c.getCitusTables(currdb)
c.getCitusNodeIDs(currdb)
}
}
func (c *collector) getCitusVersion(currdb string, major *int) {
ctx, cancel := context.WithTimeout(context.Background(), c.timeout)
defer cancel()
var cv string
q := `SELECT citus_version()`
if err := c.db.QueryRowContext(ctx, q).Scan(&cv); err != nil {
log.Printf("warning: citus_version() in db %q failed:: %v", currdb, err)
return
}
c.result.Citus[currdb].Version = cv
if s := semver.Major("v" + c.setting("citus.version")); s != "" {
*major, _ = strconv.Atoi(strings.TrimPrefix(s, "v"))
}
}
func (c *collector) getCitusTableSizes(currdb string) {
ctx, cancel := context.WithTimeout(context.Background(), c.timeout)
defer cancel()
q := `SELECT logicalrelid::oid, citus_table_size(logicalrelid) FROM pg_dist_partition`
rows, err := c.db.QueryContext(ctx, q)
if err != nil {
log.Printf("warning: pg_dist_partition/citus_table_size query failed: %v", err)
return
}
defer rows.Close()
for rows.Next() {
var oid int
var size int64
if err := rows.Scan(&oid, &size); err != nil {
log.Printf("warning: pg_dist_partition/citus_table_size query failed: %v", err)
return
}
for i, t := range c.result.Tables { // update sizes
if t.OID == oid && t.DBName == currdb {
c.result.Tables[i].Size = size
break
}
}
}
if err := rows.Err(); err != nil {
log.Printf("warning: pg_dist_partition/citus_table_size query failed: %v", err)
}
}
func (c *collector) getCitusNodes(currdb string) {
ctx, cancel := context.WithTimeout(context.Background(), c.timeout)
defer cancel()
q := `SELECT nodeid, groupid, nodename, nodeport, COALESCE(noderack, ''),
isactive, noderole, nodecluster, shouldhaveshards
FROM pg_dist_node`
rows, err := c.db.QueryContext(ctx, q)
if err != nil {
log.Printf("warning: pg_dist_node query failed: %v", err)
return
}
defer rows.Close()
for rows.Next() {
var node pgmetrics.CitusNode
if err := rows.Scan(&node.ID, &node.GroupID, &node.Name, &node.Port,
&node.Rack, &node.IsActive, &node.Role, &node.Cluster,
&node.ShouldHaveShards); err != nil {
log.Printf("warning: pg_dist_node query failed: %v", err)
return
}
c.result.Citus[currdb].Nodes = append(c.result.Citus[currdb].Nodes, node)
}
if err := rows.Err(); err != nil {
log.Printf("warning: pg_dist_node query failed: %v", err)
}
}
// citus_stat_statements
func (c *collector) getCitusStatements(currdb string) {
ctx, cancel := context.WithTimeout(context.Background(), c.timeout)
defer cancel()
q := `SELECT queryid, userid, dbid, query, executor, COALESCE(partition_key, ''), calls
FROM citus_stat_statements`
rows, err := c.db.QueryContext(ctx, q)
if err != nil {
if strings.Contains(err.Error(), "Citus Enterprise") {
err = nil // silently ignore this "error"
} else {
log.Printf("warning: citus_stat_statements query failed: %v", err)
}
return
}
defer rows.Close()
for rows.Next() {
var s pgmetrics.CitusStatement
if err := rows.Scan(&s.QueryID, &s.UserOID, &s.DBOID, &s.Query,
&s.Executor, &s.PartitionKey, &s.Calls); err != nil {
log.Printf("warning: citus_stat_statements query failed: %v", err)
return
}
c.result.Citus[currdb].Statements = append(c.result.Citus[currdb].Statements, s)
}
if err := rows.Err(); err != nil {
log.Printf("warning: citus_stat_statements query failed: %v", err)
}
}
func (c *collector) getCitusBackendsv11() []pgmetrics.CitusBackendV11 {
ctx, cancel := context.WithTimeout(context.Background(), c.timeout)
defer cancel()
q := `SELECT COALESCE(datname, ''), COALESCE(usename, ''),
COALESCE(application_name, ''), COALESCE(pid, 0),
COALESCE(client_hostname::text, client_addr::text, ''),
COALESCE(EXTRACT(EPOCH FROM backend_start)::bigint, 0),
COALESCE(EXTRACT(EPOCH FROM xact_start)::bigint, 0),
COALESCE(EXTRACT(EPOCH FROM query_start)::bigint, 0),
COALESCE(EXTRACT(EPOCH FROM state_change)::bigint, 0),
COALESCE(wait_event_type, ''), COALESCE(wait_event, ''),
COALESCE(state, ''), COALESCE(backend_xid, ''),
COALESCE(backend_xmin, ''), LEFT(COALESCE(query, ''), $1),
COALESCE(global_pid, 0), COALESCE(nodeid, 0),
COALESCE(is_worker_query, false), COALESCE(query_id, 0),
COALESCE(backend_type, '')
FROM citus_stat_activity ORDER BY pid ASC`
rows, err := c.db.QueryContext(ctx, q, c.sqlLength)
if err != nil {
log.Printf("warning: citus_stat_activity query failed: %v", err)
return nil
}
defer rows.Close()
var out []pgmetrics.CitusBackendV11
for rows.Next() {
var b pgmetrics.CitusBackendV11
if err := rows.Scan(&b.DBName, &b.RoleName, &b.ApplicationName,
&b.PID, &b.ClientAddr, &b.BackendStart, &b.XactStart, &b.QueryStart,
&b.StateChange, &b.WaitEventType, &b.WaitEvent, &b.State,
&b.BackendXid, &b.BackendXmin, &b.Query, &b.GlobalPID,
&b.NodeID, &b.IsWorkerQuery, &b.QueryID, &b.BackendType); err != nil {
log.Printf("warning: citus_stat_activity query failed: %v", err)
return nil
}
out = append(out, b)
}
if err := rows.Err(); err != nil {
log.Printf("warning: citus_stat_activity query failed: %v", err)
return nil
}
return out
}
func (c *collector) getCitusBackends(table string) []pgmetrics.CitusBackend {
ctx, cancel := context.WithTimeout(context.Background(), c.timeout)
defer cancel()
q := `SELECT COALESCE(datname, ''), COALESCE(usename, ''),
COALESCE(application_name, ''), COALESCE(pid, 0),
COALESCE(client_hostname::text, client_addr::text, ''),
COALESCE(EXTRACT(EPOCH FROM backend_start)::bigint, 0),
COALESCE(EXTRACT(EPOCH FROM xact_start)::bigint, 0),
COALESCE(EXTRACT(EPOCH FROM query_start)::bigint, 0),
COALESCE(EXTRACT(EPOCH FROM state_change)::bigint, 0),
COALESCE(wait_event_type, ''), COALESCE(wait_event, ''),
COALESCE(state, ''), COALESCE(backend_xid, ''),
COALESCE(backend_xmin, ''), LEFT(COALESCE(query, ''), $1),
COALESCE(query_hostname, ''), COALESCE(query_hostport, 0),
COALESCE(master_query_host_name, ''),
COALESCE(master_query_host_port, 0),
COALESCE(transaction_number, 0),
COALESCE(EXTRACT(EPOCH FROM transaction_stamp)::bigint, 0)
FROM %s ORDER BY pid ASC`
q = fmt.Sprintf(q, table)
rows, err := c.db.QueryContext(ctx, q, c.sqlLength)
if err != nil {
log.Printf("warning: %s query failed: %v", table, err)
return nil
}
defer rows.Close()
var out []pgmetrics.CitusBackend
for rows.Next() {
var b pgmetrics.CitusBackend
if err := rows.Scan(&b.DBName, &b.RoleName, &b.ApplicationName,
&b.PID, &b.ClientAddr, &b.BackendStart, &b.XactStart, &b.QueryStart,
&b.StateChange, &b.WaitEventType, &b.WaitEvent, &b.State,
&b.BackendXid, &b.BackendXmin, &b.Query, &b.QueryHostname,
&b.QueryPort, &b.MasterQueryHostname, &b.MasterQueryPort,
&b.TxNumber, &b.TxStamp); err != nil {
log.Printf("warning: %s query failed: %v", table, err)
return nil
}
out = append(out, b)
}
if err := rows.Err(); err != nil {
log.Printf("warning: %s query failed: %v", table, err)
return nil
}
return out
}
func (c *collector) getCitusActivity(currdb string, major int) {
if major >= 11 {
c.result.Citus[currdb].AllBackends = c.getCitusBackendsv11()
} else {
c.result.Citus[currdb].Backends = c.getCitusBackends("citus_dist_stat_activity")
c.result.Citus[currdb].WorkerBackends = c.getCitusBackends("citus_worker_stat_activity")
}
}
// citus_lock_waits
func (c *collector) getCitusLocks(currdb string, majorVer int) {
ctx, cancel := context.WithTimeout(context.Background(), c.timeout)
defer cancel()
var q string
if majorVer >= 11 {
q = `SELECT 0, 0, blocked_statement,
current_statement_in_blocking_process, waiting_nodeid,
blocking_nodeid, '', '', 0, 0, waiting_gpid, blocking_gpid
FROM citus_lock_waits`
} else {
q = `SELECT waiting_pid, blocking_pid, blocked_statement,
current_statement_in_blocking_process, waiting_node_id,
blocking_node_id, waiting_node_name, blocking_node_name,
waiting_node_port, blocking_node_port, 0, 0
FROM citus_lock_waits`
}
rows, err := c.db.QueryContext(ctx, q)
if err != nil {
log.Printf("warning: citus_lock_waits query failed: %v", err)
return
}
defer rows.Close()
for rows.Next() {
var l pgmetrics.CitusLock
if err := rows.Scan(&l.WaitingPID, &l.BlockingPID, &l.BlockedStmt,
&l.CurrStmt, &l.WaitingNodeID, &l.BlockingNodeID,
&l.WaitingNodeName, &l.BlockingNodeName, &l.WaitingNodePort,
&l.BlockingNodePort, &l.WaitingGPID, &l.BlockingGPID); err != nil {
log.Printf("warning: citus_lock_waits query failed: %v", err)
return
}
c.result.Citus[currdb].Locks = append(c.result.Citus[currdb].Locks, l)
}
if err := rows.Err(); err != nil {
log.Printf("warning: citus_lock_waits query failed: %v", err)
}
}
// citusTablesSQL is a slightly modified version of the SQL used for citus_tables
const citusTablesSQL = `
SELECT p.logicalrelid::oid::int AS table_oid,
p.logicalrelid AS table_name,
CASE
WHEN p.partkey IS NOT NULL THEN 'distributed'::text
ELSE
CASE
WHEN p.repmodel = 't'::"char" THEN 'reference'::text
ELSE 'local'::text
END
END AS citus_table_type,
COALESCE(column_to_column_name(p.logicalrelid, p.partkey), ''::text) AS distribution_column,
p.colocationid AS colocation_id,
COALESCE(citus_total_relation_size(p.logicalrelid, fail_on_error => false), 0::bigint) AS table_size,
( SELECT count(*) AS count
FROM pg_dist_shard
WHERE pg_dist_shard.logicalrelid::oid = p.logicalrelid::oid) AS shard_count,
pg_get_userbyid(c.relowner) AS table_owner,
a.amname AS access_method
FROM pg_dist_partition p
JOIN pg_class c ON p.logicalrelid::oid = c.oid
LEFT JOIN pg_am a ON a.oid = c.relam
WHERE NOT (p.logicalrelid::oid IN ( SELECT pg_depend.objid
FROM pg_depend
WHERE pg_depend.classid = 'pg_class'::regclass::oid AND pg_depend.refclassid = 'pg_extension'::regclass::oid AND pg_depend.deptype = 'e'::"char"))
ORDER BY (p.logicalrelid::text)
`
func (c *collector) getCitusTables(currdb string) {
ctx, cancel := context.WithTimeout(context.Background(), c.timeout)
defer cancel()
rows, err := c.db.QueryContext(ctx, citusTablesSQL)
if err != nil {
log.Printf("warning: citus tables query failed: %v", err)
return
}
defer rows.Close()
for rows.Next() {
var t pgmetrics.CitusTable
if err := rows.Scan(&t.OID, &t.TableName, &t.TableType,
&t.DistributionColumn, &t.ColocationID, &t.Size, &t.ShardCount,
&t.TableOwner, &t.AccessMethod); err != nil {
log.Printf("warning: citus tables query failed: %v", err)
return
}
c.result.Citus[currdb].Tables = append(c.result.Citus[currdb].Tables, t)
}
if err := rows.Err(); err != nil {
log.Printf("warning: citus tables query failed: %v", err)
}
}
func (c *collector) getCitusNodeIDs(currdb string) {
ctx, cancel := context.WithTimeout(context.Background(), c.timeout)
defer cancel()
q := `SELECT COALESCE(citus_coordinator_nodeid(), 0), COALESCE(citus_backend_gpid(), 0)/10000000000`
if err := c.db.QueryRowContext(ctx, q).Scan(&c.result.Citus[currdb].CoordinatorNodeID,
&c.result.Citus[currdb].ConnectedNodeID); err != nil {
log.Printf("warning: citus_coordinator_nodeid()/citus_backend_gpid() query failed: %v", err)
}
}