doc/user/cwl/costanalyzer.html.textile.liquid

   1 ---
   2 layout: default
   3 navsection: userguide
   4 title: Analyzing workflow cost (cloud only)
   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 {% include 'notebox_begin' %}
  13
  14 This is only applicable when Arvados runs in a cloud environment and @arvados-dispatch-cloud@ is used to dispatch @crunch@ jobs. The per node-hour price for each defined InstanceType most be supplied in "config.yml":{{site.baseurl}}/admin/config.html.
  15
  16 {% include 'notebox_end' %}
  17
  18 The @arvados-client@ program can be used to analyze the cost of a workflow. It can be installed from packages (@apt install arvados-client@ or @yum install arvados-client@). The @arvados-client costanalyzer@ command analyzes the cost accounting information associated with Arvados container requests.
  19
  20 h2(#syntax). Syntax
  21
  22 The @arvados-client costanalyzer@ tool has a number of command line arguments:
  23
  24 <notextile>
  25 <pre><code>~$ <span class="userinput">arvados-client costanalyzer -h</span>
  26 Usage:
  27   ./arvados-client costanalyzer [options ...] [UUID ...]
  28
  29   This program analyzes the cost of Arvados container requests and calculates
  30   the total cost across all requests. At least one UUID or a timestamp range
  31   must be specified.
  32
  33   When the '-output' option is specified, a set of CSV files with cost details
  34   will be written to the provided directory. Each file is a CSV report that lists
  35   all the containers used to fulfill the container request, together with the
  36   machine type and cost of each container.
  37
  38   When supplied with the UUID of a container request, it will calculate the
  39   cost of that container request and all its children.
  40
  41   When supplied with the UUID of a collection, it will see if there is a
  42   container_request UUID in the properties of the collection, and if so, it
  43   will calculate the cost of that container request and all its children.
  44
  45   When supplied with a project UUID or when supplied with multiple container
  46   request or collection UUIDs, it will calculate the total cost for all
  47   supplied UUIDs.
  48
  49   When supplied with a 'begin' and 'end' timestamp (format:
  50   2006-01-02T15:04:05), it will calculate the cost for all top-level container
  51   requests whose containers finished during the specified interval.
  52
  53   The total cost calculation takes container reuse into account: if a container
  54   was reused between several container requests, its cost will only be counted
  55   once.
  56
  57   Caveats:
  58
  59   - This program uses the cost data from config.yml at the time of the
  60   execution of the container, stored in the 'node.json' file in its log
  61   collection. If the cost data was not correctly configured at the time the
  62   container was executed, the output from this program will be incorrect.
  63
  64   - If a container was run on a preemptible ("spot") instance, the cost data
  65   reported by this program may be wildly inaccurate, because it does not have
  66   access to the spot pricing in effect for the node then the container ran. The
  67   UUID report file that is generated when the '-output' option is specified has
  68   a column that indicates the preemptible state of the instance that ran the
  69   container.
  70
  71   - This program does not take into account overhead costs like the time spent
  72   starting and stopping compute nodes that run containers, the cost of the
  73   permanent cloud nodes that provide the Arvados services, the cost of data
  74   stored in Arvados, etc.
  75
  76   - When provided with a project UUID, subprojects will not be considered.
  77
  78   In order to get the data for the UUIDs supplied, the ARVADOS_API_HOST and
  79   ARVADOS_API_TOKEN environment variables must be set.
  80
  81   This program prints the total dollar amount from the aggregate cost
  82   accounting across all provided UUIDs on stdout.
  83
  84 Options:
  85   -begin begin
  86       timestamp begin for date range operation (format: 2006-01-02T15:04:05)
  87   -cache
  88       create and use a local disk cache of Arvados objects (default true)
  89   -end end
  90       timestamp end for date range operation (format: 2006-01-02T15:04:05)
  91   -log-level level
  92       logging level (debug, info, ...) (default "info")
  93   -output directory
  94       output directory for the CSV reports
  95 </code></pre>
  96 </notextile>