doc/admin/user-activity.html.textile.liquid

   1 ---
   2 layout: default
   3 navsection: admin
   4 title: "User activity report"
   5 ...
   6 {% comment %}
   7 Copyright (C) The Arvados Authors. All rights reserved.
   8
   9 SPDX-License-Identifier: CC-BY-SA-3.0
  10 {% endcomment %}
  11
  12 The @arv-user-activity@ tool generates a summary report of user activity on an Arvados instance based on the audit logs (the @logs@ table).
  13
  14 h2. Installation
  15
  16 h2. Option 1: Install from a distribution package
  17
  18 This installation method is recommended to make the CLI tools available system-wide. It can coexist with the installation method described in option 2, below.
  19
  20 First, configure the "Arvados package repositories":../../install/packages.html
  21
  22 {% assign arvados_component = 'python3-arvados-user-activity' %}
  23
  24 {% include 'install_packages' %}
  25
  26 h2. Option 2: Install from source
  27
  28 Step 1: Check out the arvados source code
  29
  30 Step 2: Change directory to @arvados/tools/user-activity@
  31
  32 Step 3: Run @pip install .@ in an appropriate installation environment, such as a @virtualenv@.
  33
  34 Note: depends on the "Arvados Python SDK":../sdk/python/sdk-python.html and its associated build prerequisites (e.g. @pycurl@).
  35
  36 h2. Usage
  37
  38 Set ARVADOS_API_HOST and ARVADOS_API_TOKEN for an admin user or system root token.
  39
  40 Run the tool with the option @--days@ giving the number of days to report on.  It will request activity logs from the API and generate a summary report on standard output.
  41
  42 Example run:
  43
  44 <pre>
  45 $ bin/arv-user-activity --days 14
  46 User activity on pirca between 2020-11-10 16:42 and 2020-11-24 16:42
  47
  48 Peter Amstutz <peter.amstutz@curii.com> (https://workbench.pirca.arvadosapi.com/users/jutro-tpzed-a4qnxq3pcfcgtkz)
  49   organization: "Curii"
  50   role: "Software Developer"
  51
  52   2020-11-10 16:51-05:00 to 2020-11-11 13:51-05:00 (21:00) Account activity
  53   2020-11-13 13:47-05:00 to 2020-11-14 03:32-05:00 (13:45) Account activity
  54   2020-11-14 04:33-05:00 to 2020-11-15 20:33-05:00 (40:00) Account activity
  55   2020-11-15 21:34-05:00 to 2020-11-16 13:34-05:00 (16:00) Account activity
  56   2020-11-16 16:21-05:00 to 2020-11-16 16:28-05:00 (00:07) Account activity
  57   2020-11-17 15:49-05:00 to 2020-11-17 15:49-05:00 (00:00) Account activity
  58   2020-11-17 15:51-05:00 Created project "New project" (pirca-j7d0g-7bxvkyr4khfa1a4)
  59   2020-11-17 15:51-05:00 Updated project "Test run" (pirca-j7d0g-7bxvkyr4khfa1a4)
  60   2020-11-17 15:51-05:00 Ran container "bwa-mem.cwl container" (pirca-xvhdp-xf2w8dkk17jkk5r)
  61   2020-11-17 15:51-05:00 to 2020-11-17 15:51-05:00 (0:00) Account activity
  62   2020-11-17 15:53-05:00 Ran container "WGS processing workflow scattered over samples container" (pirca-xvhdp-u7bm0wdy6lq4r8k)
  63   2020-11-17 15:53-05:00 to 2020-11-17 15:54-05:00 (00:01) Account activity
  64   2020-11-17 15:55-05:00 Created collection "output for pirca-dz642-36ffk81c8zzopxz" (pirca-4zz18-np35gw690ndzzk7)
  65   2020-11-17 15:55-05:00 to 2020-11-17 15:55-05:00 (0:00) Account activity
  66   2020-11-17 15:55-05:00 Created collection "Output of main" (pirca-4zz18-oiiymetwhnnhhwc)
  67   2020-11-17 15:55-05:00 Tagged pirca-4zz18-oiiymetwhnnhhwc
  68   2020-11-17 15:55-05:00 Updated collection "Output of main" (pirca-4zz18-oiiymetwhnnhhwc)
  69   2020-11-17 15:55-05:00 to 2020-11-17 16:04-05:00 (00:09) Account activity
  70   2020-11-17 16:04-05:00 Created collection "Output of main" (pirca-4zz18-f6n9n89e3dhtwvl)
  71   2020-11-17 16:04-05:00 Tagged pirca-4zz18-f6n9n89e3dhtwvl
  72   2020-11-17 16:04-05:00 Updated collection "Output of main" (pirca-4zz18-f6n9n89e3dhtwvl)
  73   2020-11-17 16:04-05:00 to 2020-11-17 17:55-05:00 (01:51) Account activity
  74   2020-11-17 20:09-05:00 to 2020-11-17 20:09-05:00 (00:00) Account activity
  75   2020-11-17 21:35-05:00 to 2020-11-17 21:35-05:00 (00:00) Account activity
  76   2020-11-18 10:09-05:00 to 2020-11-18 11:00-05:00 (00:51) Account activity
  77   2020-11-18 14:37-05:00 Untagged pirca-4zz18-st8yzjan1nhxo1a
  78   2020-11-18 14:37-05:00 Deleted collection "Output of main" (pirca-4zz18-st8yzjan1nhxo1a)
  79   2020-11-18 17:44-05:00 to 2020-11-18 17:44-05:00 (00:00) Account activity
  80   2020-11-19 12:18-05:00 to 2020-11-19 12:19-05:00 (00:01) Account activity
  81   2020-11-19 13:57-05:00 to 2020-11-19 14:21-05:00 (00:24) Account activity
  82   2020-11-20 09:48-05:00 to 2020-11-20 22:51-05:00 (13:03) Account activity
  83   2020-11-20 23:52-05:00 to 2020-11-22 22:32-05:00 (46:40) Account activity
  84   2020-11-22 23:37-05:00 to 2020-11-23 13:52-05:00 (14:15) Account activity
  85   2020-11-23 14:53-05:00 to 2020-11-24 11:58-05:00 (21:05) Account activity
  86   2020-11-24 15:06-05:00 to 2020-11-24 16:38-05:00 (01:32) Account activity
  87
  88 Marc Rubenfield <mrubenfield@curii.com> (https://workbench.pirca.arvadosapi.com/users/jutro-tpzed-v9s9q97pgydh1yf)
  89   2020-11-11 12:27-05:00 Untagged pirca-4zz18-xmq257bsla4kdco
  90   2020-11-11 12:27-05:00 Deleted collection "Output of main" (pirca-4zz18-xmq257bsla4kdco)
  91
  92 Ward Vandewege <ward@curii.com> (https://workbench.pirca.arvadosapi.com/users/jutro-tpzed-9z6foyez9ydn2hl)
  93   organization: "Curii Corporation, Inc."
  94   organization_email: "ward@curii.com"
  95   role: "System Administrator"
  96   website_url: "https://curii.com"
  97
  98   2020-11-19 19:30-05:00 to 2020-11-19 19:46-05:00 (00:16) Account activity
  99   2020-11-20 10:51-05:00 to 2020-11-20 11:26-05:00 (00:35) Account activity
 100   2020-11-24 12:01-05:00 to 2020-11-24 13:01-05:00 (01:00) Account activity
 101 </pre>