sdk/python/arvados/commands/ws.py

   1 #!/usr/bin/env python
   2
   3 from __future__ import print_function
   4 import sys
   5 import logging
   6 import argparse
   7 import arvados
   8 import json
   9 from arvados.events import subscribe
  10 from arvados._version import __version__
  11 import signal
  12
  13 def main(arguments=None):
  14     logger = logging.getLogger('arvados.arv-ws')
  15
  16     parser = argparse.ArgumentParser()
  17     parser.add_argument('--version', action='version',
  18                         version="%s %s" % (sys.argv[0], __version__),
  19                         help='Print version and exit.')
  20     parser.add_argument('-u', '--uuid', type=str, default="", help="Filter events on object_uuid")
  21     parser.add_argument('-f', '--filters', type=str, default="", help="Arvados query filter to apply to log events (JSON encoded)")
  22     parser.add_argument('-s', '--start-time', type=str, default="", help="Arvados query filter to fetch log events created at or after this time. This will be server time in UTC. Allowed format: YYYY-MM-DD or YYYY-MM-DD hh:mm:ss")
  23     parser.add_argument('-i', '--id', type=int, default=None, help="Start from given log id.")
  24
  25     group = parser.add_mutually_exclusive_group()
  26     group.add_argument('--poll-interval', default=15, type=int, help="If websockets is not available, specify the polling interval, default is every 15 seconds")
  27     group.add_argument('--no-poll', action='store_false', dest='poll_interval', help="Do not poll if websockets are not available, just fail")
  28
  29     group = parser.add_mutually_exclusive_group()
  30     group.add_argument('-p', '--pipeline', type=str, default="", help="Supply pipeline uuid, print log output from pipeline and its jobs")
  31     group.add_argument('-j', '--job', type=str, default="", help="Supply job uuid, print log output from jobs")
  32
  33     args = parser.parse_args(arguments)
  34
  35     global filters
  36     global known_component_jobs
  37     global ws
  38
  39     filters = []
  40     known_component_jobs = set()
  41     ws = None
  42
  43     def update_subscribed_components(components):
  44         global known_component_jobs
  45         global filters
  46         pipeline_jobs = set()
  47         for c in components:
  48             if "job" in components[c]:
  49                 pipeline_jobs.add(components[c]["job"]["uuid"])
  50         if known_component_jobs != pipeline_jobs:
  51             ws.unsubscribe(filters)
  52             filters = [['object_uuid', 'in', [args.pipeline] + list(pipeline_jobs)]]
  53             ws.subscribe([['object_uuid', 'in', [args.pipeline] + list(pipeline_jobs)]])
  54             known_component_jobs = pipeline_jobs
  55
  56     api = arvados.api('v1')
  57
  58     if args.uuid:
  59         filters += [ ['object_uuid', '=', args.uuid] ]
  60
  61     if args.filters:
  62         filters += json.loads(args.filters)
  63
  64     if args.job:
  65         filters += [ ['object_uuid', '=', args.job] ]
  66
  67     if args.pipeline:
  68         filters += [ ['object_uuid', '=', args.pipeline] ]
  69
  70     if args.start_time:
  71         last_log_id = 1
  72         filters += [ ['created_at', '>=', args.start_time] ]
  73     else:
  74         last_log_id = None
  75
  76     if args.id:
  77         last_log_id = args.id-1
  78
  79     def on_message(ev):
  80         global filters
  81         global ws
  82
  83         logger.debug(ev)
  84         if 'event_type' in ev and (args.pipeline or args.job):
  85             if ev['event_type'] in ('stderr', 'stdout'):
  86                 sys.stdout.write(ev["properties"]["text"])
  87             elif ev["event_type"] in ("create", "update"):
  88                 if ev["object_kind"] == "arvados#pipelineInstance":
  89                     update_subscribed_components(ev["properties"]["new_attributes"]["components"])
  90
  91                 if ev["object_kind"] == "arvados#pipelineInstance" and args.pipeline:
  92                     if ev["properties"]["new_attributes"]["state"] in ("Complete", "Failed", "Paused"):
  93                         ws.close()
  94
  95                 if ev["object_kind"] == "arvados#job" and args.job:
  96                     if ev["properties"]["new_attributes"]["state"] in ("Complete", "Failed", "Cancelled"):
  97                         ws.close()
  98         elif 'status' in ev and ev['status'] == 200:
  99             pass
 100         else:
 101             print(json.dumps(ev))
 102
 103     try:
 104         ws = subscribe(arvados.api('v1'), filters, on_message, poll_fallback=args.poll_interval, last_log_id=last_log_id)
 105         if ws:
 106             if args.pipeline:
 107                 c = api.pipeline_instances().get(uuid=args.pipeline).execute()
 108                 update_subscribed_components(c["components"])
 109                 if c["state"] in ("Complete", "Failed", "Paused"):
 110                     ws.close()
 111             ws.run_forever()
 112     except KeyboardInterrupt:
 113         pass
 114     except Exception as e:
 115         logger.error(e)
 116     finally:
 117         if ws:
 118             ws.close()