diff options
| author | Dmitriy Zaporozhets <dzaporozhets@gitlab.com> | 2014-12-02 10:47:40 +0000 |
|---|---|---|
| committer | Dmitriy Zaporozhets <dzaporozhets@gitlab.com> | 2014-12-02 10:47:40 +0000 |
| commit | 65320436973feb194ef5daf8b6904b2071de7e62 (patch) | |
| tree | 4a503f571a42420209c82bfcd8de68e717cde38d /doc | |
| parent | bf39347970865bcd97e5370c7a754406498a2d65 (diff) | |
| parent | 64919745544cd09cdb510bf15e9522280d61fdde (diff) | |
| download | gitlab-ce-65320436973feb194ef5daf8b6904b2071de7e62.tar.gz | |
Merge branch 'disable_arguments_logger' into 'master'
Disable Sidekiq arguments logging by default
Some of the arguments passed to Sidekiq jobs are secret. With this
change we avoid logging those secrets, by turning off 'argument
logging' altogether.
See merge request !1282
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). |