doc/admin/inspect.html.textile.liquid

   1 ---
   2 layout: default
   3 navsection: admin
   4 title: Inspecting active requests
   5 ...
   6
   7 {% comment %}
   8 Copyright (C) The Arvados Authors. All rights reserved.
   9
  10 SPDX-License-Identifier: CC-BY-SA-3.0
  11 {% endcomment %}
  12
  13 Most Arvados services publish a snapshot of HTTP requests currently being serviced at @/_inspect/requests@. This can be useful for troubleshooting slow requests and understanding high server load conditions.
  14
  15 To access snapshots, services must be configured with a "management token":management-token.html. When accessing this endpoint, prefix the management token with @"Bearer "@ and supply it in the @Authorization@ request header.
  16
  17 In an interactive setting, use the @jq@ tool to format the JSON response.
  18
  19 <notextile><pre><code>curl -sfH "Authorization: Bearer <span class="userinput">your_management_token_goes_here</span>" "https://<span class="userinput">0.0.0.0:25107</span>/_inspect/requests" | jq .
  20 </code></pre></notextile>
  21
  22 table(table table-bordered table-condensed table-hover){width:40em}.
  23 |_. Component|_. Provides @/_inspect/requests@ endpoint|
  24 |arvados-api-server||
  25 |arvados-controller|✓|
  26 |arvados-dispatch-cloud|✓|
  27 |arvados-dispatch-lsf|✓|
  28 |arvados-ws|✓|
  29 |composer||
  30 |keepproxy|✓|
  31 |keepstore|✓|
  32 |keep-balance|✓|
  33 |keep-web|✓|
  34 |workbench2||
  35
  36 h2. Report fields
  37
  38 Most fields are self explanatory.
  39
  40 The @Host@ field reports the virtual host specified in the incoming HTTP request.
  41
  42 The @RemoteAddr@ field reports the source of the incoming TCP connection, which is typically a local address associated with the Nginx proxy service.
  43
  44 The @Elapsed@ field reports the number of seconds since the incoming HTTP request headers were received.
  45
  46 h2. Example response
  47
  48 <pre>
  49 [
  50   {
  51     "RequestID": "req-1vzzj6nwrki0rd2hj08a",
  52     "Method": "GET",
  53     "Host": "tordo.arvadosapi.com",
  54     "URL": "/arvados/v1/groups?order=name+asc&filters=[[%22owner_uuid%22,%22%3D%22,%22zzzzz-tpzed-aaaaaaaaaaaaaaa%22],[%22group_class%22,%22in%22,[%22project%22,%22filter%22]]]",
  55     "RemoteAddr": "127.0.0.1:55822",
  56     "Elapsed": 0.006363228
  57   },
  58   {
  59     "RequestID": "req-1wrof2b2wlj5s1rao4u3",
  60     "Method": "GET",
  61     "Host": "tordo.arvadosapi.com",
  62     "URL": "/arvados/v1/users/current",
  63     "RemoteAddr": "127.0.0.1:55814",
  64     "Elapsed": 0.04796585
  65   }
  66 ]
  67 </pre>