Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
1
Merge Requests
1
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
nexedi
gitlab-ce
Commits
2cfec07a
Commit
2cfec07a
authored
Mar 06, 2020
by
Wei-Meng Lee
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Move Sidekiq args logging to troubleshooting docs
parent
bae06faf
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
with
22 additions
and
17 deletions
+22
-17
doc/administration/troubleshooting/sidekiq.md
doc/administration/troubleshooting/sidekiq.md
+20
-0
doc/development/sidekiq_debugging.md
doc/development/sidekiq_debugging.md
+2
-17
No files found.
doc/administration/troubleshooting/sidekiq.md
View file @
2cfec07a
...
...
@@ -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
...
...
doc/development/sidekiq_debugging.md
View file @
2cfec07a
...
...
@@ -2,20 +2,5 @@
## 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
](
../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
`"..."`
.
This content has been moved to the
[
Troubleshooting Sidekiq docs
](
../administration/troubleshooting/sidekiq.md
)
.
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment