Class: Sidekiq::Process
- Inherits:
-
Object
- Object
- Sidekiq::Process
- Defined in:
- lib/sidekiq/api.rb
Overview
Sidekiq::Process represents an active Sidekiq process talking with Redis. Each process has a set of attributes which look like this:
'hostname' => 'app-1.example.com',
'started_at' => <process start time>,
'pid' => 12345,
'tag' => 'myapp'
'concurrency' => 25,
'queues' => ['default', 'low'],
'busy' => 10,
'beat' => <last heartbeat>,
'identity' => <unique string identifying the process>,
'embedded' => true,
Instance Method Summary collapse
- #[](key) ⇒ Object
-
#dump_threads ⇒ Object
Signal this process to log backtraces for all threads.
- #embedded? ⇒ Boolean
- #identity ⇒ Object
- #labels ⇒ Object
- #queues ⇒ Object
-
#quiet! ⇒ Object
Signal this process to stop processing new jobs.
-
#stop! ⇒ Object
Signal this process to shutdown.
-
#stopping? ⇒ Boolean
True if this process is quiet or shutting down.
- #tag ⇒ Object
- #version ⇒ Object
- #weights ⇒ Object
Instance Method Details
#[](key) ⇒ Object
1004 1005 1006 |
# File 'lib/sidekiq/api.rb', line 1004 def [](key) @attribs[key] end |
#dump_threads ⇒ Object
Signal this process to log backtraces for all threads. Useful if you have a frozen or deadlocked process which is still sending a heartbeat. This method is asynchronous and it can take 5-10 seconds.
1052 1053 1054 |
# File 'lib/sidekiq/api.rb', line 1052 def dump_threads signal("TTIN") end |
#embedded? ⇒ Boolean
1024 1025 1026 |
# File 'lib/sidekiq/api.rb', line 1024 def self["embedded"] end |
#identity ⇒ Object
1008 1009 1010 |
# File 'lib/sidekiq/api.rb', line 1008 def identity self["identity"] end |
#labels ⇒ Object
1000 1001 1002 |
# File 'lib/sidekiq/api.rb', line 1000 def labels self["labels"].to_a end |
#queues ⇒ Object
1012 1013 1014 |
# File 'lib/sidekiq/api.rb', line 1012 def queues self["queues"] end |
#quiet! ⇒ Object
Signal this process to stop processing new jobs. It will continue to execute jobs it has already fetched. This method is asynchronous and it can take 5-10 seconds for the process to quiet.
1032 1033 1034 1035 1036 |
# File 'lib/sidekiq/api.rb', line 1032 def quiet! raise "Can't quiet an embedded process" if signal("TSTP") end |
#stop! ⇒ Object
Signal this process to shutdown. It will shutdown within its configured :timeout value, default 25 seconds. This method is asynchronous and it can take 5-10 seconds for the process to start shutting down.
1042 1043 1044 1045 1046 |
# File 'lib/sidekiq/api.rb', line 1042 def stop! raise "Can't stop an embedded process" if signal("TERM") end |
#stopping? ⇒ Boolean
Returns true if this process is quiet or shutting down.
1057 1058 1059 |
# File 'lib/sidekiq/api.rb', line 1057 def stopping? self["quiet"] == "true" end |
#tag ⇒ Object
996 997 998 |
# File 'lib/sidekiq/api.rb', line 996 def tag self["tag"] end |
#version ⇒ Object
1020 1021 1022 |
# File 'lib/sidekiq/api.rb', line 1020 def version self["version"] end |
#weights ⇒ Object
1016 1017 1018 |
# File 'lib/sidekiq/api.rb', line 1016 def weights self["weights"] end |