Commit 65320436 authored by Dmitriy Zaporozhets's avatar Dmitriy Zaporozhets

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
parents bf393479 64919745
...@@ -21,6 +21,9 @@ v 7.6.0 ...@@ -21,6 +21,9 @@ v 7.6.0
- -
- -
v 7.5.2
- Don't log Sidekiq arguments by default
v 7.5.0 v 7.5.0
- API: Add support for Hipchat (Kevin Houdebert) - API: Add support for Hipchat (Kevin Houdebert)
- Add time zone configuration in gitlab.yml (Sullivan Senechal) - Add time zone configuration in gitlab.yml (Sullivan Senechal)
......
...@@ -14,7 +14,7 @@ Sidekiq.configure_server do |config| ...@@ -14,7 +14,7 @@ Sidekiq.configure_server do |config|
} }
config.server_middleware do |chain| config.server_middleware do |chain|
chain.add Gitlab::SidekiqMiddleware::ArgumentsLogger chain.add Gitlab::SidekiqMiddleware::ArgumentsLogger if ENV['SIDEKIQ_LOG_ARGUMENTS']
chain.add Gitlab::SidekiqMiddleware::MemoryKiller if ENV['SIDEKIQ_MAX_RSS'] chain.add Gitlab::SidekiqMiddleware::MemoryKiller if ENV['SIDEKIQ_MAX_RSS']
end end
end end
......
...@@ -4,3 +4,4 @@ ...@@ -4,3 +4,4 @@
- [Shell commands](shell_commands.md) in the GitLab codebase - [Shell commands](shell_commands.md) in the GitLab codebase
- [Rake tasks](rake_tasks.md) for development - [Rake tasks](rake_tasks.md) for development
- [CI setup](ci_setup.md) for testing GitLab - [CI setup](ci_setup.md) for testing GitLab
- [Sidekiq debugging](sidekiq_debugging.md)
# 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).
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment