gitlab-org--gitlab-foss/doc/development/sidekiq_debugging.md
Sean McGivern 9d2be75674 Limit Sidekiq args logging to 10 KB of JSON
When logging arguments from Sidekiq to JSON, restrict the size of `args`
to 10 KB (when converted to JSON). This is to avoid blowing up with
excessively large job payloads.
2019-01-22 10:54:12 +00:00

803 B

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 to 1 (true).

Example:

gitlab_rails['env'] = {"SIDEKIQ_LOG_ARGUMENTS" => "1"}

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).

When using Sidekiq JSON logging, arguments logs are limited to a maximum size of 10 kilobytes of text; any arguments after this limit will be discarded and replaced with a single argument containing the string "...".