summaryrefslogtreecommitdiff
path: root/doc/development
diff options
context:
space:
mode:
authorSean McGivern <sean@gitlab.com>2019-01-18 16:21:38 +0000
committerSean McGivern <sean@gitlab.com>2019-01-22 10:54:12 +0000
commit9d2be75674c5d073bc8020a4ace1b7bff5bb16fb (patch)
tree4113b1ed5ce2322d96c033edfb720adb74d3ac81 /doc/development
parent5e01cf72249725cb6e0c8aa3d28325d9b4942566 (diff)
downloadgitlab-ce-9d2be75674c5d073bc8020a4ace1b7bff5bb16fb.tar.gz
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.
Diffstat (limited to 'doc/development')
-rw-r--r--doc/development/sidekiq_debugging.md9
1 files changed, 7 insertions, 2 deletions
diff --git a/doc/development/sidekiq_debugging.md b/doc/development/sidekiq_debugging.md
index 84b61bd7e61..2b3a9481b93 100644
--- a/doc/development/sidekiq_debugging.md
+++ b/doc/development/sidekiq_debugging.md
@@ -11,6 +11,11 @@ Example:
gitlab_rails['env'] = {"SIDEKIQ_LOG_ARGUMENTS" => "1"}
```
-Please note: It is not recommend to enable this setting in production because some
+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). \ No newline at end of file
+example the password reset token).
+
+When using [Sidekiq JSON logging](../administration/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 `"..."`.