From: Lucas Di Pentima <ldipentima@veritasgenetics.com>
Date: Mon, 15 Jul 2019 20:56:42 +0000 (-0300)
Subject: 15319: Fixes example log path and links troubleshooting page from install page.
X-Git-Tag: 2.0.0~253^2
X-Git-Url: https://git.arvados.org/arvados.git/commitdiff_plain/0779cb4c6b2768b42748077f212b472dfc24b055

15319: Fixes example log path and links troubleshooting page from install page.

Arvados-DCO-1.1-Signed-off-by: Lucas Di Pentima <ldipentima@veritasgenetics.com>
---

diff --git a/doc/admin/troubleshooting.html.textile.liquid b/doc/admin/troubleshooting.html.textile.liquid
index b0d9973c96..66c75f344d 100644
--- a/doc/admin/troubleshooting.html.textile.liquid
+++ b/doc/admin/troubleshooting.html.textile.liquid
@@ -27,10 +27,10 @@ $ arv collection create --collection '{}'
 Error: #<RuntimeError: Whoops, something bad happened> (req-ku5ct9ehw0y71f1c5p79)
 </pre>
 
-The API Server logs every request in JSON format on the @production.log@ file, so we can retrieve more information about this by using @grep@ and @jq@ tools:
+The API Server logs every request in JSON format on the @production.log@ (usually under @/var/www/arvados-api/current/log/@ when installing from packages) file, so we can retrieve more information about this by using @grep@ and @jq@ tools:
 
 <pre>
-# grep req-ku5ct9ehw0y71f1c5p79 /path/to/apiserver/production.log | jq .
+# grep req-ku5ct9ehw0y71f1c5p79 /var/www/arvados-api/current/log/production.log | jq .
 {
   "method": "POST",
   "path": "/arvados/v1/collections",
@@ -45,7 +45,7 @@ The API Server logs every request in JSON format on the @production.log@ file, s
   "client_ipaddr": "127.0.0.1",
   "client_auth": "zzzzz-gj3su-jllemyj9v3s5emu",
   "exception": "#<RuntimeError: Whoops, something bad happened>",
-  "exception_backtrace": "/usr/src/arvados/services/api/app/controllers/arvados/v1/collections_controller.rb:43:in `create'\n/var/lib/gems/ruby/2.3.0/gems/actionpack-5.0.7.2/lib/action_controller/metal/basic_implicit_render.rb:4:in `send_action'\n ...[snipped]",
+  "exception_backtrace": "/var/www/arvados-api/current/app/controllers/arvados/v1/collections_controller.rb:43:in `create'\n/var/lib/gems/ruby/2.3.0/gems/actionpack-5.0.7.2/lib/action_controller/metal/basic_implicit_render.rb:4:in `send_action'\n ...[snipped]",
   "params": {
     "collection": "{}",
     "_profile": "true",
@@ -63,8 +63,8 @@ The API Server logs every request in JSON format on the @production.log@ file, s
 When logging a request that produced an error, the API Server adds @exception@ and @exception_backtrace@ keys to the JSON log. The latter includes the complete error stack trace as a string, and can be displayed in a more readable form like so:
 
 <pre>
-# grep req-ku5ct9ehw0y71f1c5p79 /path/to/apiserver/production.log | jq -r .exception_backtrace
-/usr/src/arvados/services/api/app/controllers/arvados/v1/collections_controller.rb:43:in `create'
+# grep req-ku5ct9ehw0y71f1c5p79 /var/www/arvados-api/current/log/production.log | jq -r .exception_backtrace
+/var/www/arvados-api/current/app/controllers/arvados/v1/collections_controller.rb:43:in `create'
 /var/lib/gems/ruby/2.3.0/gems/actionpack-5.0.7.2/lib/action_controller/metal/basic_implicit_render.rb:4:in `send_action'
 /var/lib/gems/ruby/2.3.0/gems/actionpack-5.0.7.2/lib/abstract_controller/base.rb:188:in `process_action'
 /var/lib/gems/ruby/2.3.0/gems/actionpack-5.0.7.2/lib/action_controller/metal/rendering.rb:30:in `process_action'
diff --git a/doc/install/install-api-server.html.textile.liquid b/doc/install/install-api-server.html.textile.liquid
index 424fc3cf24..c234bca927 100644
--- a/doc/install/install-api-server.html.textile.liquid
+++ b/doc/install/install-api-server.html.textile.liquid
@@ -271,3 +271,7 @@ break this application for all non-root users on this machine.</pre></notextile>
 
 <notextile><pre>fatal: Not a git repository (or any of the parent directories): .git</pre></notextile>
 {% include 'notebox_end' %}
+
+h2. Troubleshooting
+
+Once you have the API Server up and running you may need to check it back if dealing with client related issues. Please read our "admin troubleshooting notes":{{site.baseurl}}/admin/troubleshooting.html on how requests can be tracked down between services.
\ No newline at end of file