diff options
Diffstat (limited to 'doc/administration/troubleshooting/sidekiq.md')
| -rw-r--r-- | doc/administration/troubleshooting/sidekiq.md | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/doc/administration/troubleshooting/sidekiq.md b/doc/administration/troubleshooting/sidekiq.md index b72bce5b3c6..8176ebab2e8 100644 --- a/doc/administration/troubleshooting/sidekiq.md +++ b/doc/administration/troubleshooting/sidekiq.md @@ -18,6 +18,26 @@ troubleshooting steps that will help you diagnose the bottleneck. > may be using all available CPU, or have a Ruby Global Interpreter Lock, > preventing other threads from continuing. +## 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](https://docs.gitlab.com/omnibus/settings/environment-variables.html) 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](../logs.md#sidekiqlog), +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 `"..."`. + ## Thread dump Send the Sidekiq process ID the `TTIN` signal and it will output thread |