diff options
| author | Jacob Vosmaer <contact@jacobvosmaer.nl> | 2014-12-01 20:58:37 +0300 |
|---|---|---|
| committer | Jacob Vosmaer <contact@jacobvosmaer.nl> | 2014-12-01 20:58:37 +0300 |
| commit | 64919745544cd09cdb510bf15e9522280d61fdde (patch) | |
| tree | e36cf535be787dd3b737996bd97f58a8d04531c2 /doc | |
| parent | 30e28a7e0c458395b7a205e72a89e7d1b68571eb (diff) | |
Disable Sidekiq arguments logging by default
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/development/README.md | 1 | ||||
| -rw-r--r-- | doc/sidekiq_debugging.md | 14 |
2 files changed, 15 insertions, 0 deletions
diff --git a/doc/development/README.md b/doc/development/README.md index 20db6662aca..c31e5d7ae97 100644 --- a/doc/development/README.md +++ b/doc/development/README.md @@ -4,3 +4,4 @@ - [Shell commands](shell_commands.md) in the GitLab codebase - [Rake tasks](rake_tasks.md) for development - [CI setup](ci_setup.md) for testing GitLab +- [Sidekiq debugging](sidekiq_debugging.md) diff --git a/doc/sidekiq_debugging.md b/doc/sidekiq_debugging.md new file mode 100644 index 00000000000..cea11e5f126 --- /dev/null +++ b/doc/sidekiq_debugging.md @@ -0,0 +1,14 @@ +# Sidekiq debugging + +## 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. + +``` +SIDEKIQ_LOG_ARGUMENTS=1 bundle exec foreman start +``` + +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). |