doc/SidekiqUniqueJobs/Lock/BaseLock.html
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: SidekiqUniqueJobs::Lock::BaseLock
— Documentation by YARD 0.9.26
</title>
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
<link rel="stylesheet" href="../../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "SidekiqUniqueJobs::Lock::BaseLock";
relpath = '../../';
</script>
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../../_index.html">Index (B)</a> »
<span class='title'><span class='object_link'><a href="../../SidekiqUniqueJobs.html" title="SidekiqUniqueJobs (module)">SidekiqUniqueJobs</a></span></span> » <span class='title'><span class='object_link'><a href="../Lock.html" title="SidekiqUniqueJobs::Lock (class)">Lock</a></span></span>
»
<span class="title">BaseLock</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: SidekiqUniqueJobs::Lock::BaseLock
<span class="abstract note title">Abstract</span>
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName">Object</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">SidekiqUniqueJobs::Lock::BaseLock</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Extended by:</dt>
<dd>Forwardable</dd>
</dl>
<dl>
<dt>Includes:</dt>
<dd><span class='object_link'><a href="../Logging.html" title="SidekiqUniqueJobs::Logging (module)">SidekiqUniqueJobs::Logging</a></span>, <span class='object_link'><a href="../Reflectable.html" title="SidekiqUniqueJobs::Reflectable (module)">Reflectable</a></span></dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/sidekiq_unique_jobs/lock/base_lock.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<div class="note abstract">
<strong>This class is abstract.</strong>
<div class='inline'></div>
</div>
<p>Abstract base class for locks</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Author:</p>
<ul class="author">
<li>
<div class='inline'><p>Mikael Henriksson <a href="mailto:mikael@mhenrixon.com">mikael@mhenrixon.com</a></p>
</div>
</li>
</ul>
</div><div id="subclasses">
<h2>Direct Known Subclasses</h2>
<p class="children"><span class='object_link'><a href="UntilAndWhileExecuting.html" title="SidekiqUniqueJobs::Lock::UntilAndWhileExecuting (class)">UntilAndWhileExecuting</a></span>, <span class='object_link'><a href="UntilExecuted.html" title="SidekiqUniqueJobs::Lock::UntilExecuted (class)">UntilExecuted</a></span>, <span class='object_link'><a href="UntilExecuting.html" title="SidekiqUniqueJobs::Lock::UntilExecuting (class)">UntilExecuting</a></span>, <span class='object_link'><a href="WhileExecuting.html" title="SidekiqUniqueJobs::Lock::WhileExecuting (class)">WhileExecuting</a></span></p>
</div>
<h2>
Class Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#validate_options-class_method" title="validate_options (class method)">.<strong>validate_options</strong>(options = {}) ⇒ void </a>
</span>
<span class="summary_desc"><div class='inline'><p>Validates that the sidekiq_options for the worker is valid.</p>
</div></span>
</li>
</ul>
<h2>
Instance Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#build_message-instance_method" title="#build_message (instance method)">#<strong>build_message</strong>(message_or_exception, item = nil) ⇒ String </a>
</span>
<span class="note title not_defined_here">
included
from <span class='object_link'><a href="../Logging.html#build_message-instance_method" title="SidekiqUniqueJobs::Logging#build_message (method)">SidekiqUniqueJobs::Logging</a></span>
</span>
<span class="summary_desc"><div class='inline'><p>Build a log message.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#execute-instance_method" title="#execute (instance method)">#<strong>execute</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Execute the job in the Sidekiq server processor.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(item, callback, redis_pool = nil) ⇒ BaseLock </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'><p>A new instance of BaseLock.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#lock-instance_method" title="#lock (instance method)">#<strong>lock</strong> { ... } ⇒ String<sup>?</sup> </a>
</span>
<span class="summary_desc"><div class='inline'><p>Locks a sidekiq job.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#locksmith-instance_method" title="#locksmith (instance method)">#<strong>locksmith</strong> ⇒ SidekiqUniqueJobs::Locksmith </a>
</span>
<span class="private note title">private</span>
<span class="summary_desc"><div class='inline'><p>The lock manager/client.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#log_debug-instance_method" title="#log_debug (instance method)">#<strong>log_debug</strong>(message_or_exception = nil, item = nil) {|String, Exception| ... } ⇒ void </a>
</span>
<span class="note title not_defined_here">
included
from <span class='object_link'><a href="../Logging.html#log_debug-instance_method" title="SidekiqUniqueJobs::Logging#log_debug (method)">SidekiqUniqueJobs::Logging</a></span>
</span>
<span class="summary_desc"><div class='inline'><p>Logs a message at debug level.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#log_error-instance_method" title="#log_error (instance method)">#<strong>log_error</strong>(message_or_exception = nil, item = nil) {|String, Exception| ... } ⇒ void </a>
</span>
<span class="note title not_defined_here">
included
from <span class='object_link'><a href="../Logging.html#log_error-instance_method" title="SidekiqUniqueJobs::Logging#log_error (method)">SidekiqUniqueJobs::Logging</a></span>
</span>
<span class="summary_desc"><div class='inline'><p>Logs a message at error level.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#log_fatal-instance_method" title="#log_fatal (instance method)">#<strong>log_fatal</strong>(message_or_exception = nil, item = nil) {|String, Exception| ... } ⇒ void </a>
</span>
<span class="note title not_defined_here">
included
from <span class='object_link'><a href="../Logging.html#log_fatal-instance_method" title="SidekiqUniqueJobs::Logging#log_fatal (method)">SidekiqUniqueJobs::Logging</a></span>
</span>
<span class="summary_desc"><div class='inline'><p>Logs a message at fatal level.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#log_info-instance_method" title="#log_info (instance method)">#<strong>log_info</strong>(message_or_exception = nil, item = nil) {|String, Exception| ... } ⇒ void </a>
</span>
<span class="note title not_defined_here">
included
from <span class='object_link'><a href="../Logging.html#log_info-instance_method" title="SidekiqUniqueJobs::Logging#log_info (method)">SidekiqUniqueJobs::Logging</a></span>
</span>
<span class="summary_desc"><div class='inline'><p>Logs a message at info level.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#log_warn-instance_method" title="#log_warn (instance method)">#<strong>log_warn</strong>(message_or_exception = nil, item = nil) {|String, Exception| ... } ⇒ void </a>
</span>
<span class="note title not_defined_here">
included
from <span class='object_link'><a href="../Logging.html#log_warn-instance_method" title="SidekiqUniqueJobs::Logging#log_warn (method)">SidekiqUniqueJobs::Logging</a></span>
</span>
<span class="summary_desc"><div class='inline'><p>Logs a message at warn level.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#logger-instance_method" title="#logger (instance method)">#<strong>logger</strong> ⇒ Logger </a>
</span>
<span class="note title not_defined_here">
included
from <span class='object_link'><a href="../Logging.html#logger-instance_method" title="SidekiqUniqueJobs::Logging#logger (method)">SidekiqUniqueJobs::Logging</a></span>
</span>
<span class="summary_desc"><div class='inline'><p>A convenience method for using the configured gem logger.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#logging_context-instance_method" title="#logging_context (instance method)">#<strong>logging_context</strong> ⇒ Hash </a>
</span>
<span class="note title not_defined_here">
included
from <span class='object_link'><a href="../Logging.html#logging_context-instance_method" title="SidekiqUniqueJobs::Logging#logging_context (method)">SidekiqUniqueJobs::Logging</a></span>
</span>
<span class="summary_desc"><div class='inline'><p>Setup some variables to add to each log line.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#reflect-instance_method" title="#reflect (instance method)">#<strong>reflect</strong>(reflection, *args) ⇒ void </a>
</span>
<span class="note title not_defined_here">
included
from <span class='object_link'><a href="../Reflectable.html#reflect-instance_method" title="SidekiqUniqueJobs::Reflectable#reflect (method)">Reflectable</a></span>
</span>
<span class="summary_desc"><div class='inline'><p>Reflects on specific event.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#with_configured_loggers_context-instance_method" title="#with_configured_loggers_context (instance method)">#<strong>with_configured_loggers_context</strong> { ... } ⇒ void </a>
</span>
<span class="note title not_defined_here">
included
from <span class='object_link'><a href="../Logging.html#with_configured_loggers_context-instance_method" title="SidekiqUniqueJobs::Logging#with_configured_loggers_context (method)">SidekiqUniqueJobs::Logging</a></span>
</span>
<span class="summary_desc"><div class='inline'><p>Attempt to setup context aware logging for the given logger.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#with_logging_context-instance_method" title="#with_logging_context (instance method)">#<strong>with_logging_context</strong> ⇒ void </a>
</span>
<span class="note title not_defined_here">
included
from <span class='object_link'><a href="../Logging.html#with_logging_context-instance_method" title="SidekiqUniqueJobs::Logging#with_logging_context (method)">SidekiqUniqueJobs::Logging</a></span>
</span>
<span class="summary_desc"><div class='inline'><p>Wraps the middleware logic with context aware logging.</p>
</div></span>
</li>
</ul>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<div class="method_details first">
<h3 class="signature first" id="initialize-instance_method">
#<strong>initialize</strong>(item, callback, redis_pool = nil) ⇒ <tt><span class='object_link'><a href="" title="SidekiqUniqueJobs::Lock::BaseLock (class)">BaseLock</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns a new instance of BaseLock.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>item</span>
<span class='type'>(<tt><span class='object_link'><a href="../../Hash.html" title="Hash (class)">Hash</a></span></tt>)</span>
—
<div class='inline'><p>the Sidekiq job hash</p>
</div>
</li>
<li>
<span class='name'>callback</span>
<span class='type'>(<tt>Proc</tt>)</span>
—
<div class='inline'><p>the callback to use after unlock</p>
</div>
</li>
<li>
<span class='name'>redis_pool</span>
<span class='type'>(<tt>Sidekiq::RedisConnection</tt>, <tt>ConnectionPool</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'><p>the redis connection</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
38
39
40
41
42
43
44
45</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sidekiq_unique_jobs/lock/base_lock.rb', line 38</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_item'>item</span><span class='comma'>,</span> <span class='id identifier rubyid_callback'>callback</span><span class='comma'>,</span> <span class='id identifier rubyid_redis_pool'>redis_pool</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
<span class='ivar'>@item</span> <span class='op'>=</span> <span class='id identifier rubyid_item'>item</span>
<span class='ivar'>@callback</span> <span class='op'>=</span> <span class='id identifier rubyid_callback'>callback</span>
<span class='ivar'>@redis_pool</span> <span class='op'>=</span> <span class='id identifier rubyid_redis_pool'>redis_pool</span>
<span class='ivar'>@attempt</span> <span class='op'>=</span> <span class='int'>0</span>
<span class='id identifier rubyid_prepare_item'>prepare_item</span> <span class='comment'># Used to ease testing
</span> <span class='ivar'>@lock_config</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../LockConfig.html" title="SidekiqUniqueJobs::LockConfig (class)">LockConfig</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../LockConfig.html#initialize-instance_method" title="SidekiqUniqueJobs::LockConfig#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_item'>item</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="class_method_details" class="method_details_list">
<h2>Class Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="validate_options-class_method">
.<strong>validate_options</strong>(options = {}) ⇒ <tt>void</tt>
</h3><div class="docstring">
<div class="discussion">
<p class="note returns_void">This method returns an undefined value.</p><p>Validates that the sidekiq_options for the worker is valid</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>options</span>
<span class='type'>(<tt><span class='object_link'><a href="../../Hash.html" title="Hash (class)">Hash</a></span></tt>)</span>
<em class="default">(defaults to: <tt>{}</tt>)</em>
—
<div class='inline'><p>the sidekiq_options given to the worker</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
27
28
29</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sidekiq_unique_jobs/lock/base_lock.rb', line 27</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_validate_options'>validate_options</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
<span class='const'><span class='object_link'><a href="Validator.html" title="SidekiqUniqueJobs::Lock::Validator (class)">Validator</a></span></span><span class='period'>.</span><span class='id identifier rubyid_validate'><span class='object_link'><a href="Validator.html#validate-class_method" title="SidekiqUniqueJobs::Lock::Validator.validate (method)">validate</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="build_message-instance_method">
#<strong>build_message</strong>(message_or_exception, item = nil) ⇒ <tt>String</tt>
<span class="not_defined_here">
Originally defined in module
<span class='object_link'><a href="../Logging.html#build_message-instance_method" title="SidekiqUniqueJobs::Logging#build_message (method)">SidekiqUniqueJobs::Logging</a></span>
</span>
</h3><div class="docstring">
<div class="discussion">
<p>Build a log message</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>message_or_exception</span>
<span class='type'>(<tt>String</tt>, <tt>Exception</tt>)</span>
—
<div class='inline'><p>an entry to log</p>
</div>
</li>
<li>
<span class='name'>item</span>
<span class='type'>(<tt><span class='object_link'><a href="../../Hash.html" title="Hash (class)">Hash</a></span></tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'><p>the sidekiq job hash</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'><p>a complete log entry</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="execute-instance_method">
#<strong>execute</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Execute the job in the Sidekiq server processor</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'>(<tt>NotImplementedError</tt>)</span>
—
<div class='inline'><p>needs to be implemented in child class</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
62
63
64</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sidekiq_unique_jobs/lock/base_lock.rb', line 62</span>
<span class='kw'>def</span> <span class='id identifier rubyid_execute'>execute</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>NotImplementedError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>#</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid___method__'>__method__</span><span class='embexpr_end'>}</span><span class='tstring_content'> needs to be implemented in </span><span class='embexpr_beg'>#{</span><span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="lock-instance_method">
#<strong>lock</strong> { ... } ⇒ <tt>String</tt><sup>?</sup>
</h3><div class="docstring">
<div class="discussion">
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>Will call a conflict strategy if lock can't be achieved.</p>
</div>
</div>
<p>Locks a sidekiq job</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Yields:</p>
<ul class="yield">
<li>
<span class='type'></span>
<div class='inline'><p>to the caller when given a block</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
—
<div class='inline'><p>the locked jid when properly locked, else nil.</p>
</div>
</li>
</ul>
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'>(<tt>NotImplementedError</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
56
57
58</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sidekiq_unique_jobs/lock/base_lock.rb', line 56</span>
<span class='kw'>def</span> <span class='id identifier rubyid_lock'>lock</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>NotImplementedError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>#</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid___method__'>__method__</span><span class='embexpr_end'>}</span><span class='tstring_content'> needs to be implemented in </span><span class='embexpr_beg'>#{</span><span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="locksmith-instance_method">
#<strong>locksmith</strong> ⇒ <tt><span class='object_link'><a href="../Locksmith.html" title="SidekiqUniqueJobs::Locksmith (class)">SidekiqUniqueJobs::Locksmith</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p class="note private">
<strong>This method is part of a private API.</strong>
You should avoid using this method if possible, as it may be removed or be changed in the future.
</p>
<p>The lock manager/client</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="../Locksmith.html" title="SidekiqUniqueJobs::Locksmith (class)">SidekiqUniqueJobs::Locksmith</a></span></tt>)</span>
—
<div class='inline'><p>the locksmith for this sidekiq job</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
72
73
74</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sidekiq_unique_jobs/lock/base_lock.rb', line 72</span>
<span class='kw'>def</span> <span class='id identifier rubyid_locksmith'>locksmith</span>
<span class='ivar'>@locksmith</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="../../SidekiqUniqueJobs.html" title="SidekiqUniqueJobs (module)">SidekiqUniqueJobs</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Locksmith.html" title="SidekiqUniqueJobs::Locksmith (class)">Locksmith</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Locksmith.html#initialize-instance_method" title="SidekiqUniqueJobs::Locksmith#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_item'>item</span><span class='comma'>,</span> <span class='id identifier rubyid_redis_pool'>redis_pool</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="log_debug-instance_method">
#<strong>log_debug</strong>(message_or_exception = nil, item = nil) {|String, Exception| ... } ⇒ <tt>void</tt>
<span class="not_defined_here">
Originally defined in module
<span class='object_link'><a href="../Logging.html#log_debug-instance_method" title="SidekiqUniqueJobs::Logging#log_debug (method)">SidekiqUniqueJobs::Logging</a></span>
</span>
</h3><div class="docstring">
<div class="discussion">
<p class="note returns_void">This method returns an undefined value.</p><p>Logs a message at debug level</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>message_or_exception</span>
<span class='type'>(<tt>String</tt>, <tt>Exception</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'><p>the message or exception to log</p>
</div>
</li>
</ul>
<p class="tag_title">Yields:</p>
<ul class="yield">
<li>
<span class='type'>(<tt>String</tt>, <tt>Exception</tt>)</span>
—
<div class='inline'><p>the message or exception to use for log message</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="log_error-instance_method">
#<strong>log_error</strong>(message_or_exception = nil, item = nil) {|String, Exception| ... } ⇒ <tt>void</tt>
<span class="not_defined_here">
Originally defined in module
<span class='object_link'><a href="../Logging.html#log_error-instance_method" title="SidekiqUniqueJobs::Logging#log_error (method)">SidekiqUniqueJobs::Logging</a></span>
</span>
</h3><div class="docstring">
<div class="discussion">
<p class="note returns_void">This method returns an undefined value.</p><p>Logs a message at error level</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>message_or_exception</span>
<span class='type'>(<tt>String</tt>, <tt>Exception</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'><p>the message or exception to log</p>
</div>
</li>
</ul>
<p class="tag_title">Yields:</p>
<ul class="yield">
<li>
<span class='type'>(<tt>String</tt>, <tt>Exception</tt>)</span>
—
<div class='inline'><p>the message or exception to use for log message</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="log_fatal-instance_method">
#<strong>log_fatal</strong>(message_or_exception = nil, item = nil) {|String, Exception| ... } ⇒ <tt>void</tt>
<span class="not_defined_here">
Originally defined in module
<span class='object_link'><a href="../Logging.html#log_fatal-instance_method" title="SidekiqUniqueJobs::Logging#log_fatal (method)">SidekiqUniqueJobs::Logging</a></span>
</span>
</h3><div class="docstring">
<div class="discussion">
<p class="note returns_void">This method returns an undefined value.</p><p>Logs a message at fatal level</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>message_or_exception</span>
<span class='type'>(<tt>String</tt>, <tt>Exception</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'><p>the message or exception to log</p>
</div>
</li>
</ul>
<p class="tag_title">Yields:</p>
<ul class="yield">
<li>
<span class='type'>(<tt>String</tt>, <tt>Exception</tt>)</span>
—
<div class='inline'><p>the message or exception to use for log message</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="log_info-instance_method">
#<strong>log_info</strong>(message_or_exception = nil, item = nil) {|String, Exception| ... } ⇒ <tt>void</tt>
<span class="not_defined_here">
Originally defined in module
<span class='object_link'><a href="../Logging.html#log_info-instance_method" title="SidekiqUniqueJobs::Logging#log_info (method)">SidekiqUniqueJobs::Logging</a></span>
</span>
</h3><div class="docstring">
<div class="discussion">
<p class="note returns_void">This method returns an undefined value.</p><p>Logs a message at info level</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>message_or_exception</span>
<span class='type'>(<tt>String</tt>, <tt>Exception</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'><p>the message or exception to log</p>
</div>
</li>
</ul>
<p class="tag_title">Yields:</p>
<ul class="yield">
<li>
<span class='type'>(<tt>String</tt>, <tt>Exception</tt>)</span>
—
<div class='inline'><p>the message or exception to use for log message</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="log_warn-instance_method">
#<strong>log_warn</strong>(message_or_exception = nil, item = nil) {|String, Exception| ... } ⇒ <tt>void</tt>
<span class="not_defined_here">
Originally defined in module
<span class='object_link'><a href="../Logging.html#log_warn-instance_method" title="SidekiqUniqueJobs::Logging#log_warn (method)">SidekiqUniqueJobs::Logging</a></span>
</span>
</h3><div class="docstring">
<div class="discussion">
<p class="note returns_void">This method returns an undefined value.</p><p>Logs a message at warn level</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>message_or_exception</span>
<span class='type'>(<tt>String</tt>, <tt>Exception</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'><p>the message or exception to log</p>
</div>
</li>
</ul>
<p class="tag_title">Yields:</p>
<ul class="yield">
<li>
<span class='type'>(<tt>String</tt>, <tt>Exception</tt>)</span>
—
<div class='inline'><p>the message or exception to use for log message</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="logger-instance_method">
#<strong>logger</strong> ⇒ <tt>Logger</tt>
<span class="not_defined_here">
Originally defined in module
<span class='object_link'><a href="../Logging.html#logger-instance_method" title="SidekiqUniqueJobs::Logging#logger (method)">SidekiqUniqueJobs::Logging</a></span>
</span>
</h3><div class="docstring">
<div class="discussion">
<p>A convenience method for using the configured gem logger</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Logger</tt>)</span>
</li>
</ul>
<p class="tag_title">See Also:</p>
<ul class="see">
<li>SidekiqUniqueJobs#.logger</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="logging_context-instance_method">
#<strong>logging_context</strong> ⇒ <tt><span class='object_link'><a href="../../Hash.html" title="Hash (class)">Hash</a></span></tt>
<span class="not_defined_here">
Originally defined in module
<span class='object_link'><a href="../Logging.html#logging_context-instance_method" title="SidekiqUniqueJobs::Logging#logging_context (method)">SidekiqUniqueJobs::Logging</a></span>
</span>
</h3><div class="docstring">
<div class="discussion">
<p>Setup some variables to add to each log line</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="../../Hash.html" title="Hash (class)">Hash</a></span></tt>)</span>
—
<div class='inline'><p>the context to use for each log line</p>
</div>
</li>
</ul>
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'>(<tt>NotImplementedError</tt>)</span>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="reflect-instance_method">
#<strong>reflect</strong>(reflection, *args) ⇒ <tt>void</tt>
<span class="not_defined_here">
Originally defined in module
<span class='object_link'><a href="../Reflectable.html#reflect-instance_method" title="SidekiqUniqueJobs::Reflectable#reflect (method)">Reflectable</a></span>
</span>
</h3><div class="docstring">
<div class="discussion">
<p class="note returns_void">This method returns an undefined value.</p><p>Reflects on specific event</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>reflection</span>
<span class='type'>(<tt>Symbol</tt>)</span>
—
<div class='inline'><p>the reflected event</p>
</div>
</li>
<li>
<span class='name'>args</span>
<span class='type'>(<tt><span class='object_link'><a href="../../Array.html" title="Array (class)">Array</a></span></tt>)</span>
—
<div class='inline'><p>arguments to provide to reflector</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="with_configured_loggers_context-instance_method">
#<strong>with_configured_loggers_context</strong> { ... } ⇒ <tt>void</tt>
<span class="not_defined_here">
Originally defined in module
<span class='object_link'><a href="../Logging.html#with_configured_loggers_context-instance_method" title="SidekiqUniqueJobs::Logging#with_configured_loggers_context (method)">SidekiqUniqueJobs::Logging</a></span>
</span>
</h3><div class="docstring">
<div class="discussion">
<p class="note returns_void">This method returns an undefined value.</p><p>Attempt to setup context aware logging for the given logger</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Yields:</p>
<ul class="yield">
<li>
<span class='type'></span>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="with_logging_context-instance_method">
#<strong>with_logging_context</strong> ⇒ <tt>void</tt>
<span class="not_defined_here">
Originally defined in module
<span class='object_link'><a href="../Logging.html#with_logging_context-instance_method" title="SidekiqUniqueJobs::Logging#with_logging_context (method)">SidekiqUniqueJobs::Logging</a></span>
</span>
</h3><div class="docstring">
<div class="discussion">
<p class="note returns_void">This method returns an undefined value.</p><p>Wraps the middleware logic with context aware logging</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Yield Returns:</p>
<ul class="yieldreturn">
<li>
<span class='type'>(<tt>void</tt>)</span>
—
<div class='inline'><p>yield to the middleware instance</p>
</div>
</li>
</ul>
</div>
</div>
</div>
</div>
<div id="footer">
Generated on Mon Sep 27 15:29:08 2021 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.26 (ruby-3.0.2).
</div>
</div>
</body>
</html>