-
Notifications
You must be signed in to change notification settings - Fork 13
/
status.go
546 lines (504 loc) · 20.6 KB
/
status.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
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
// Copyright © 2016-2021 Genome Research Limited
// Author: Sendu Bala <sb10@sanger.ac.uk>.
//
// This file is part of wr.
//
// wr is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// wr is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with wr. If not, see <http://www.gnu.org/licenses/>.
package cmd
import (
"encoding/json"
"fmt"
"os"
"sort"
"strconv"
"strings"
"time"
"github.com/VertebrateResequencing/wr/jobqueue"
"github.com/carbocation/runningvariance"
"github.com/spf13/cobra"
)
const shortTimeFormat = "06/1/2-15:04:05"
const allRepGrps = "all above"
// options for this cmd
var cmdFileStatus string
var cmdIDStatus string
var cmdIDIsSubStr bool
var cmdIDIsInternal bool
var cmdLine string
var showBuried bool
var showRunning bool
var showStd bool
var showEnv bool
var outputFormat string
var statusLimit int
var fromHost string
// statusCmd represents the status command
var statusCmd = &cobra.Command{
Use: "status",
Short: "Get status of commands",
Long: `You can find the status of commands you've previously added using
"wr add" by running this command.
Specify one of the flags -f, -l or -i to choose which commands you want the
status of. If none are supplied, you will get the status of all your currently
incomplete commands.
-i is the report group (-i) you supplied to "wr add" when you added the job(s)
you want the status of now. Combining with -z lets you get the status of jobs
in multiple report groups, assuming you have arranged that related groups share
some substring. Alternatively -y lets you specify -i as the internal job id
reported when using this command.
The file to provide -f is in the format taken by "wr add".
In -f and -l mode you must provide the cwd the commands were set to run in, if
CwdMatters (and must NOT be provided otherwise). Likewise provide the mounts
option that was used when the command was added, if any. You can do this by
using the -c and --mounts/--mounts_json options in -l mode, or by providing the
same file you gave to "wr add" in -f mode.
There are 4 output formats to choose from with -o (you can shorten the output
name to just the first letter, eg. -o c):
"counts" just displays the count of jobs in each possible state.
"summary" shows the counts broken down by report group, along with the mean
(and standard deviation) resource usage of completed jobs in each report
group, and the internal identifiers of any buried jobs, broken down by exit
code+failure reason.
"details" groups jobs with the same state, reason for failure and exitcode
together and shows the complete details of --limit random jobs in each group
(and you are told how many are not being displayed). A limit of 0 turns off
grouping and shows all your desired commands individually, but you could hit
a timeout if retrieving the details of very many (tens of thousands+)
commands.
"plain" outputs 2 tab separated columns: internal job id and current state of
that job. Possible states are: delayed, ready, reserved, running, lost,
buried, complete. If any jobs are buried, exits non-0 as well.
"json" simply dumps the complete details of every job out as an array of
JSON objects. The properties of the JSON objects are described in the
documentation for wr's REST API.`,
Run: func(cmd *cobra.Command, args []string) {
set := countGetJobArgs()
if set > 1 {
die("-f, -i and -l are mutually exclusive; only specify one of them")
}
var cmdState jobqueue.JobState
if showBuried {
cmdState = jobqueue.JobStateBuried
} else if showRunning {
cmdState = jobqueue.JobStateRunning
}
timeout := time.Duration(timeoutint) * time.Second
jq := connect(timeout)
var err error
defer func() {
err = jq.Disconnect()
if err != nil {
warn("Disconnecting from the server failed: %s", err)
}
}()
if outputFormat != "details" && outputFormat != "d" {
statusLimit = 0
showStd = false
showEnv = false
}
jobs := getJobs(jq, cmdState, set == 0, statusLimit, showStd, showEnv)
showextra := cmdFileStatus == ""
if fromHost != "" {
var subset []*jobqueue.Job
for _, job := range jobs {
if job.Host == fromHost || job.HostID == fromHost || job.HostIP == fromHost {
subset = append(subset, job)
}
}
jobs = subset
}
switch outputFormat {
case "counts", "c":
var d, re, b, ru, l, c, dep int
for _, job := range jobs {
switch job.State {
case jobqueue.JobStateDelayed:
d += 1 + job.Similar
case jobqueue.JobStateReady:
re += 1 + job.Similar
case jobqueue.JobStateBuried:
b += 1 + job.Similar
case jobqueue.JobStateReserved, jobqueue.JobStateRunning:
ru += 1 + job.Similar
case jobqueue.JobStateLost:
l += 1 + job.Similar
case jobqueue.JobStateComplete:
c += 1 + job.Similar
case jobqueue.JobStateDependent:
dep += 1 + job.Similar
}
}
fmt.Printf("complete: %d\nrunning: %d\nready: %d\ndependent: %d\nlost contact: %d\ndelayed: %d\nburied: %d\n", c, ru, re, dep, l, d, b)
case "plain", "p":
buried := false
for _, job := range jobs {
fmt.Printf("%s\t%s\n", job.Key(), job.State)
if job.State == jobqueue.JobStateBuried {
buried = true
}
}
if buried {
os.Exit(1)
}
os.Exit(0)
case "summary", "s":
counts := make(map[string]map[jobqueue.JobState]int)
buried := make(map[string]map[string][]string)
memory := make(map[string]*runningvariance.RunningStat)
disk := make(map[string]*runningvariance.RunningStat)
walltime := make(map[string]*runningvariance.RunningStat)
cputime := make(map[string]*runningvariance.RunningStat)
startends := make(map[string][]time.Time)
counts[allRepGrps] = make(map[jobqueue.JobState]int)
for _, job := range jobs {
if _, exists := counts[job.RepGroup]; !exists {
counts[job.RepGroup] = make(map[jobqueue.JobState]int)
}
state := job.State
if state == jobqueue.JobStateReserved {
state = jobqueue.JobStateRunning
}
counts[job.RepGroup][job.State]++
counts[allRepGrps][job.State]++
if state == jobqueue.JobStateBuried {
if _, exists := buried[job.RepGroup]; !exists {
buried[job.RepGroup] = make(map[string][]string)
}
group := fmt.Sprintf("exitcode.%d,\"%s\"", job.Exitcode, job.FailReason)
buried[job.RepGroup][group] = append(buried[job.RepGroup][group], job.Key())
} else if state == jobqueue.JobStateComplete {
if _, exists := memory[job.RepGroup]; !exists {
memory[job.RepGroup] = runningvariance.NewRunningStat()
disk[job.RepGroup] = runningvariance.NewRunningStat()
walltime[job.RepGroup] = runningvariance.NewRunningStat()
cputime[job.RepGroup] = runningvariance.NewRunningStat()
startends[job.RepGroup] = []time.Time{job.StartTime, job.EndTime}
}
memory[job.RepGroup].Push(float64(job.PeakRAM))
disk[job.RepGroup].Push(float64(job.PeakDisk))
walltime[job.RepGroup].Push(float64(job.WallTime()))
cputime[job.RepGroup].Push(float64(job.CPUtime))
if job.StartTime.Before(startends[job.RepGroup][0]) {
startends[job.RepGroup][0] = job.StartTime
}
if job.EndTime.After(startends[job.RepGroup][1]) {
startends[job.RepGroup][1] = job.EndTime
}
if _, exists := memory[allRepGrps]; !exists {
memory[allRepGrps] = runningvariance.NewRunningStat()
disk[allRepGrps] = runningvariance.NewRunningStat()
walltime[allRepGrps] = runningvariance.NewRunningStat()
cputime[allRepGrps] = runningvariance.NewRunningStat()
startends[allRepGrps] = []time.Time{job.StartTime, job.EndTime}
}
memory[allRepGrps].Push(float64(job.PeakRAM))
disk[allRepGrps].Push(float64(job.PeakDisk))
walltime[allRepGrps].Push(float64(job.WallTime()))
cputime[allRepGrps].Push(float64(job.CPUtime))
if job.StartTime.Before(startends[allRepGrps][0]) {
startends[allRepGrps][0] = job.StartTime
}
if job.EndTime.After(startends[allRepGrps][1]) {
startends[allRepGrps][1] = job.EndTime
}
}
}
// sort RepGroups for a nicer display
all := counts[allRepGrps]
delete(counts, allRepGrps)
var rgs []string
for rg := range counts {
rgs = append(rgs, rg)
}
sort.Strings(rgs)
if len(rgs) > 1 {
rgs = append(rgs, allRepGrps)
counts[allRepGrps] = all
}
// display summary for each RepGroup
for _, rg := range rgs {
var usage string
if counts[rg][jobqueue.JobStateComplete] > 0 {
usage = fmt.Sprintf(" memory=%dMB(+/-%dMB) disk=%dMB(+/-%dMB) walltime=%s(+/-%s) cputime=%s(+/-%s)", int(memory[rg].Mean()), int(memory[rg].StandardDeviation()), int(disk[rg].Mean()), int(disk[rg].StandardDeviation()), time.Duration(walltime[rg].Mean()), time.Duration(walltime[rg].StandardDeviation()), time.Duration(cputime[rg].Mean()), time.Duration(cputime[rg].StandardDeviation()))
if counts[rg][jobqueue.JobStateComplete] > 1 {
usage = usage + fmt.Sprintf(" started=%s ended=%s elapsed=%s", startends[rg][0].Format(shortTimeFormat), startends[rg][1].Format(shortTimeFormat), startends[rg][1].Sub(startends[rg][0]))
}
}
var dead string
if counts[rg][jobqueue.JobStateBuried] > 0 {
// sort the bury groups
var bgs []string
for bg := range buried[rg] {
bgs = append(bgs, bg)
}
sort.Strings(bgs)
for _, bg := range bgs {
dead += fmt.Sprintf(" %s=%s", bg, strings.Join(buried[rg][bg], ","))
}
}
fmt.Printf("%s : complete=%d running=%d ready=%d dependent=%d lost=%d delayed=%d buried=%d%s%s\n", rg, counts[rg][jobqueue.JobStateComplete], counts[rg][jobqueue.JobStateRunning], counts[rg][jobqueue.JobStateReady], counts[rg][jobqueue.JobStateDependent], counts[rg][jobqueue.JobStateLost], counts[rg][jobqueue.JobStateDelayed], counts[rg][jobqueue.JobStateBuried], usage, dead)
}
case "details", "d":
// print out status information for each job
for _, job := range jobs {
cwd := job.Cwd
var mounts string
if len(job.MountConfigs) > 0 {
mounts = fmt.Sprintf("Mounts: %s\n", job.MountConfigs)
}
var homeChanged string
if job.ActualCwd != "" {
cwd = job.ActualCwd
if job.ChangeHome {
homeChanged = "Changed home: true\n"
}
}
var groups string
if len(job.DepGroups) > 0 {
groups = fmt.Sprintf("Dependency groups: %s; ", strings.Join(job.DepGroups, ", "))
}
if len(job.Dependencies) > 0 {
groups += fmt.Sprintf("Dependencies: %s; ", strings.Join(job.Dependencies.Stringify(), ", "))
}
if len(job.LimitGroups) > 0 {
groups += fmt.Sprintf("Limit groups: %s; ", strings.Join(job.LimitGroups, ", "))
}
var containerInfo string
if job.WithDocker != "" {
containerInfo = fmt.Sprintf("Cmd running inside docker container running image: %s\n", job.WithDocker)
}
if job.WithSingularity != "" {
containerInfo = fmt.Sprintf("Cmd running inside singularity container running image: %s\n", job.WithSingularity)
}
if job.ContainerMounts != "" {
containerInfo += fmt.Sprintf("Container has these mounts: %s\n", job.ContainerMounts)
}
if job.MonitorDocker != "" {
dockerID := job.MonitorDocker
if dockerID == "?" {
dockerID += " (first container started after cmd)"
}
containerInfo += fmt.Sprintf("Docker container monitoring turned on for: %s\n", dockerID)
}
var behaviours string
if len(job.Behaviours) > 0 {
behaviours = fmt.Sprintf("Behaviours: %s\n", job.Behaviours)
}
var other string
if len(job.Requirements.Other) > 0 {
var others []string
for key, val := range job.Requirements.Other {
others = append(others, key+":"+val)
}
other = fmt.Sprintf("Resource requirements: %s\n", strings.Join(others, ", "))
}
fmt.Printf("\n# %s\nCwd: %s\n%s%s%s%s%sId: %s (%s); Requirements group: %s; %sPriority: %d; Attempts: %d\nExpected requirements: { memory: %dMB; time: %s; cpus: %s disk: %dGB }\n", job.Cmd, cwd, mounts, homeChanged, containerInfo, behaviours, other, job.RepGroup, job.Key(), job.ReqGroup, groups, job.Priority, job.Attempts, job.Requirements.RAM, job.Requirements.Time, strconv.FormatFloat(job.Requirements.Cores, 'f', -1, 64), job.Requirements.Disk)
switch job.State {
case jobqueue.JobStateDelayed:
ready := job.EndTime.Add(job.DelayTime)
fmt.Printf("Status: delayed following a problem, prior to retrying; will become ready in %s (attempted at %s)\n",
time.Until(ready).Round(time.Second), job.StartTime.Format(shortTimeFormat))
case jobqueue.JobStateReady:
fmt.Println("Status: ready to be picked up by a `wr runner`")
case jobqueue.JobStateDependent:
fmt.Println("Status: dependent on other jobs")
case jobqueue.JobStateBuried:
fmt.Printf("Status: buried - you need to fix the problem and then `wr retry` (attempted at %s)\n", job.StartTime.Format(shortTimeFormat))
case jobqueue.JobStateReserved, jobqueue.JobStateRunning:
fmt.Printf("Status: running (started %s)\n", job.StartTime.Format(shortTimeFormat))
case jobqueue.JobStateLost:
fmt.Printf("Status: lost contact (started %s; lost %s)\n", job.StartTime.Format(shortTimeFormat), job.EndTime.Format(shortTimeFormat))
case jobqueue.JobStateComplete:
fmt.Printf("Status: complete (started %s; ended %s)\n", job.StartTime.Format(shortTimeFormat), job.EndTime.Format(shortTimeFormat))
}
if job.FailReason != "" {
fmt.Printf("Previous problem: %s\n", job.FailReason)
}
var hostID string
if job.HostID != "" {
hostID = ", ID: " + job.HostID
}
if job.Exited {
prefix := "Stats"
if job.State != jobqueue.JobStateComplete {
prefix = "Stats of previous attempt"
}
fmt.Printf("%s: { Exit code: %d; Peak memory: %dMB; Peak disk: %dMB; Wall time: %s; CPU time: %s }\nHost: %s (IP: %s%s); Pid: %d\n", prefix, job.Exitcode, job.PeakRAM, job.PeakDisk, job.WallTime(), job.CPUtime, job.Host, job.HostIP, hostID, job.Pid)
if showextra && showStd && job.Exitcode != 0 {
stdout, errs := job.StdOut()
if errs != nil {
warn("problem reading the cmd's STDOUT: %s", errs)
} else if stdout != "" {
fmt.Printf("StdOut:\n%s\n", stdout)
} else {
fmt.Printf("StdOut: [none]\n")
}
stderr, errs := job.StdErr()
if errs != nil {
warn("problem reading the cmd's STDERR: %s", errs)
} else if stderr != "" {
fmt.Printf("StdErr:\n%s\n", stderr)
} else {
fmt.Printf("StdErr: [none]\n")
}
}
} else if job.State == jobqueue.JobStateRunning || job.State == jobqueue.JobStateLost {
fmt.Printf("Stats: { Wall time: %s }\nHost: %s (IP: %s%s); Pid: %d\n", job.WallTime(), job.Host, job.HostIP, hostID, job.Pid)
//*** we should be able to peek at STDOUT & STDERR, and see
// Peak memory during a run... but is that possible/ too
// expensive? Maybe we could communicate directly with the
// runner?...
} else if showextra && showStd {
// it's possible for jobs that got buried before they even
// ran to have details of the bury in their stderr
stderr, errs := job.StdErr()
if errs == nil && stderr != "" {
fmt.Printf("Details: %s\n", stderr)
}
}
if showextra && showEnv {
env, erre := job.Env()
if erre != nil {
warn("problem reading the cmd's Env: %s", erre)
} else {
fmt.Printf("Env: %s\n", env)
}
}
if job.Similar > 0 {
fr := ""
if job.FailReason != "" {
fr = " and problem"
}
er := ""
if job.Exited && job.Exitcode != 0 {
if fr != "" {
er = ", exit code"
} else {
er = " and exit code"
}
}
fmt.Printf("+ %d other commands with the same status%s%s\n", job.Similar, er, fr)
}
}
case "json", "j":
jstati := make([]jobqueue.JStatus, len(jobs))
for i, job := range jobs {
jstati[i], err = job.ToStatus()
if err != nil {
die("failed to convert job to status: %s", err)
}
}
encoder := json.NewEncoder(os.Stdout)
encoder.SetEscapeHTML(false)
err = encoder.Encode(jstati)
if err != nil {
die("failed to encode jobs: %s", err)
}
default:
die("invalid -o format specified")
}
fmt.Printf("\n")
},
}
func init() {
RootCmd.AddCommand(statusCmd)
// flags specific to this sub-command
statusCmd.Flags().StringVarP(&cmdFileStatus, "file", "f", "", "file containing commands you want the status of; - means read from STDIN")
statusCmd.Flags().StringVarP(&cmdIDStatus, "identifier", "i", "", "identifier of the commands you want the status of")
statusCmd.Flags().BoolVarP(&cmdIDIsSubStr, "search", "z", false, "treat -i as a substring to match against all report groups")
statusCmd.Flags().BoolVarP(&cmdIDIsInternal, "internal", "y", false, "treat -i as an internal job id")
statusCmd.Flags().StringVarP(&cmdLine, "cmdline", "l", "", "a command line you want the status of")
statusCmd.Flags().StringVarP(&cmdCwd, "cwd", "c", "", "working dir that the command(s) specified by -l or -f were set to run in")
statusCmd.Flags().StringVarP(&mountJSON, "mount_json", "j", "", "mounts that the command(s) specified by -l or -f were set to use (JSON format)")
statusCmd.Flags().StringVar(&mountSimple, "mounts", "", "mounts that the command(s) specified by -l or -f were set to use (simple format)")
statusCmd.Flags().BoolVarP(&showBuried, "buried", "b", false, "in default or -i mode only, only show the status of buried commands")
statusCmd.Flags().StringVar(&fromHost, "host", "", "filter output to only show the status of commands that ran on the given host (ID, name or IP)")
statusCmd.Flags().BoolVarP(&showRunning, "running", "r", false, "in default or -i mode only, only show the status of running commands")
statusCmd.Flags().BoolVarP(&showStd, "std", "s", false, "in -o d mode, except in -f mode, also show the most recent STDOUT and STDERR of incomplete commands")
statusCmd.Flags().BoolVarP(&showEnv, "env", "e", false, "in -o d mode, except in -f mode, also show the environment variables the command(s) ran with")
statusCmd.Flags().StringVarP(&outputFormat, "output", "o", "details", "['counts','summary','details','json'] output format")
statusCmd.Flags().IntVar(&statusLimit, "limit", 1, "in -o d mode, number of commands that share the same properties to display; 0 displays all")
statusCmd.Flags().IntVar(&timeoutint, "timeout", 120, "how long (seconds) to wait to get a reply from 'wr manager'")
}
func countGetJobArgs() int {
set := 0
if cmdFileStatus != "" {
set++
}
if cmdIDStatus != "" {
set++
}
if cmdLine != "" {
set++
}
if cmdAll {
set++
}
return set
}
func getJobs(jq *jobqueue.Client, cmdState jobqueue.JobState, all bool, statusLimit int, showStd, showEnv bool) []*jobqueue.Job {
var jobs []*jobqueue.Job
var err error
switch {
case all:
// get all jobs
jobs, err = jq.GetIncomplete(statusLimit, cmdState, showStd, showEnv)
case cmdIDStatus != "":
if cmdIDIsInternal {
// get the job with this internal id
var job *jobqueue.Job
job, err = jq.GetByEssence(&jobqueue.JobEssence{
JobKey: cmdIDStatus,
}, showStd, showEnv)
if job != nil {
jobs = append(jobs, job)
}
} else {
// get all jobs with this identifier (repgroup)
jobs, err = jq.GetByRepGroup(cmdIDStatus, cmdIDIsSubStr, statusLimit, cmdState, showStd, showEnv)
}
case cmdFileStatus != "":
// parse the supplied commands
parsedJobs, _, _ := parseCmdFile(jq, false)
// round-trip via the server to get those that actually exist in
// the queue
jes := jobsToJobEssenses(parsedJobs)
jobs, err = jq.GetByEssences(jes)
if len(jobs) < len(parsedJobs) {
warn("%d/%d cmds were not found", len(parsedJobs)-len(jobs), len(parsedJobs))
}
case cmdLine != "":
// get job that has the supplied command
var defaultMounts jobqueue.MountConfigs
if mountJSON != "" || mountSimple != "" {
defaultMounts = mountParse(mountJSON, mountSimple)
}
var job *jobqueue.Job
job, err = jq.GetByEssence(&jobqueue.JobEssence{Cmd: cmdLine, Cwd: cmdCwd, MountConfigs: defaultMounts}, showStd, showEnv)
if job != nil {
jobs = append(jobs, job)
}
}
if err != nil {
die("failed to get jobs corresponding to your settings: %s", err)
}
return jobs
}
func jobsToJobEssenses(jobs []*jobqueue.Job) []*jobqueue.JobEssence {
jes := make([]*jobqueue.JobEssence, 0, len(jobs))
for _, job := range jobs {
jes = append(jes, job.ToEssense())
}
return jes
}