sdk/python/arvados/commands/ws.py

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