summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorStan Hu <stanhu@gmail.com>2018-07-24 22:15:52 -0700
committerStan Hu <stanhu@gmail.com>2018-07-25 04:41:40 -0700
commitb755673fb63b57751657a55f568ca809e5c7901e (patch)
tree26aba0d729449126b86b5e36fa7efd180aa83555 /doc
parent6cb30f83255f0982646fea688f2fe275a3b22cc7 (diff)
downloadgitlab-ce-b755673fb63b57751657a55f568ca809e5c7901e.tar.gz
Add rbtrace to Gemfilesh-include-rbtrace
This will be enabled if ENABLE_RBTRACE environment variable is defined. This will allow us to debug all sorts of issues in production: https://github.com/tmm1/rbtrace
Diffstat (limited to 'doc')
-rw-r--r--doc/administration/troubleshooting/debug.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/doc/administration/troubleshooting/debug.md b/doc/administration/troubleshooting/debug.md
index 83a714810c1..7ae4f7c1515 100644
--- a/doc/administration/troubleshooting/debug.md
+++ b/doc/administration/troubleshooting/debug.md
@@ -66,6 +66,19 @@ On CentOS:
sudo yum install gdb
```
+### rbtrace
+
+GitLab 11.2 ships with [rbtrace](https://github.com/tmm1/rbtrace), which
+allows you to trace Ruby code, view all running threads, take memory dumps,
+and more. However, this is not enabled by default. To enable it, define the
+`ENABLE_RBTRACE` variable to the environment. For example, in Omnibus:
+
+```ruby
+gitlab_rails['env'] = {"ENABLE_RBTRACE" => "1"}
+```
+
+Then reconfigure the system and restart Unicorn and Sidekiq.
+
## Common Problems
Many of the tips to diagnose issues below apply to many different situations. We'll use one