summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSean McGivern <sean@mcgivern.me.uk>2016-12-28 12:56:58 +0000
committerSean McGivern <sean@mcgivern.me.uk>2016-12-28 12:56:58 +0000
commitd1debe18ae5a1ad77ad31dd71048d3da7964ae11 (patch)
treef08b70ca2550ea41beb84d545f9bf28c2ac62146
parent0dcbd4c7f6cfc69d3190c4622bbc73da718056c7 (diff)
parent7422ea7a3e2ff8b3f15eeceffbb8232061233c2b (diff)
downloadgitlab-ce-d1debe18ae5a1ad77ad31dd71048d3da7964ae11.tar.gz
Merge branch 'mrchrisw-set-SIDEKIQ_LOG_ARGUMENTS' into 'master'
Set SIDEKIQ_LOG_ARGUMENTS in gitlab.rb See merge request !8340
-rw-r--r--doc/development/sidekiq_debugging.md13
1 files changed, 8 insertions, 5 deletions
diff --git a/doc/development/sidekiq_debugging.md b/doc/development/sidekiq_debugging.md
index cea11e5f126..d6d770e27c1 100644
--- a/doc/development/sidekiq_debugging.md
+++ b/doc/development/sidekiq_debugging.md
@@ -3,12 +3,15 @@
## Log arguments to Sidekiq jobs
If you want to see what arguments are being passed to Sidekiq jobs you can set
-the SIDEKIQ_LOG_ARGUMENTS environment variable.
+the `SIDEKIQ_LOG_ARGUMENTS` [environment variable]
+(https://docs.gitlab.com/omnibus/settings/environment-variables.html) to `1` (true).
+
+Example:
```
-SIDEKIQ_LOG_ARGUMENTS=1 bundle exec foreman start
+gitlab_rails['env'] = {"SIDEKIQ_LOG_ARGUMENTS" => "1"}
```
-It is not recommend to enable this setting in production because some Sidekiq
-jobs (such as sending a password reset email) take secret arguments (for
-example the password reset token).
+Please note: It is not recommend to enable this setting in production because some
+Sidekiq jobs (such as sending a password reset email) take secret arguments (for
+example the password reset token). \ No newline at end of file