Google Git
Sign in
apache / logging-log4j-site / 9755b12b39efbc0142688f9b1a11ec68db89f97b / . / 2.13.1 / log4j-core / xref / org / apache / logging / log4j / core / async / AsyncLoggerConfigDisruptor.html
blob: 34d8f15f7684c577e232f1530f2bc997aba21fbc [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head><meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<title>AsyncLoggerConfigDisruptor xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../../apidocs/org/apache/logging/log4j/core/async/AsyncLoggerConfigDisruptor.html">View Javadoc</a></div><pre>
<a class="jxr_linenumber" name="L1" href="#L1">1</a> <em class="jxr_comment">/*</em>
<a class="jxr_linenumber" name="L2" href="#L2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one or more</em>
<a class="jxr_linenumber" name="L3" href="#L3">3</a> <em class="jxr_comment"> * contributor license agreements. See the NOTICE file distributed with</em>
<a class="jxr_linenumber" name="L4" href="#L4">4</a> <em class="jxr_comment"> * this work for additional information regarding copyright ownership.</em>
<a class="jxr_linenumber" name="L5" href="#L5">5</a> <em class="jxr_comment"> * The ASF licenses this file to You under the Apache license, Version 2.0</em>
<a class="jxr_linenumber" name="L6" href="#L6">6</a> <em class="jxr_comment"> * (the "License"); you may not use this file except in compliance with</em>
<a class="jxr_linenumber" name="L7" href="#L7">7</a> <em class="jxr_comment"> * the License. You may obtain a copy of the License at</em>
<a class="jxr_linenumber" name="L8" href="#L8">8</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="L9" href="#L9">9</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2." target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.</a>0</em>
<a class="jxr_linenumber" name="L10" href="#L10">10</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="L11" href="#L11">11</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing, software</em>
<a class="jxr_linenumber" name="L12" href="#L12">12</a> <em class="jxr_comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em>
<a class="jxr_linenumber" name="L13" href="#L13">13</a> <em class="jxr_comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
<a class="jxr_linenumber" name="L14" href="#L14">14</a> <em class="jxr_comment"> * See the license for the specific language governing permissions and</em>
<a class="jxr_linenumber" name="L15" href="#L15">15</a> <em class="jxr_comment"> * limitations under the license.</em>
<a class="jxr_linenumber" name="L16" href="#L16">16</a> <em class="jxr_comment"> */</em>
<a class="jxr_linenumber" name="L17" href="#L17">17</a> <strong class="jxr_keyword">package</strong> org.apache.logging.log4j.core.async;
<a class="jxr_linenumber" name="L18" href="#L18">18</a>
<a class="jxr_linenumber" name="L19" href="#L19">19</a> <strong class="jxr_keyword">import</strong> java.util.concurrent.ThreadFactory;
<a class="jxr_linenumber" name="L20" href="#L20">20</a> <strong class="jxr_keyword">import</strong> java.util.concurrent.TimeUnit;
<a class="jxr_linenumber" name="L21" href="#L21">21</a>
<a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.Level;
<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.AbstractLifeCycle;
<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.LogEvent;
<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.impl.Log4jLogEvent;
<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.impl.LogEventFactory;
<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.impl.MutableLogEvent;
<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.impl.ReusableLogEventFactory;
<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.jmx.RingBufferAdmin;
<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.util.Log4jThreadFactory;
<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.util.Throwables;
<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.message.ReusableMessage;
<a class="jxr_linenumber" name="L33" href="#L33">33</a>
<a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong class="jxr_keyword">import</strong> com.lmax.disruptor.EventFactory;
<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">import</strong> com.lmax.disruptor.EventTranslatorTwoArg;
<a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong class="jxr_keyword">import</strong> com.lmax.disruptor.ExceptionHandler;
<a class="jxr_linenumber" name="L37" href="#L37">37</a> <strong class="jxr_keyword">import</strong> com.lmax.disruptor.RingBuffer;
<a class="jxr_linenumber" name="L38" href="#L38">38</a> <strong class="jxr_keyword">import</strong> com.lmax.disruptor.Sequence;
<a class="jxr_linenumber" name="L39" href="#L39">39</a> <strong class="jxr_keyword">import</strong> com.lmax.disruptor.SequenceReportingEventHandler;
<a class="jxr_linenumber" name="L40" href="#L40">40</a> <strong class="jxr_keyword">import</strong> com.lmax.disruptor.TimeoutException;
<a class="jxr_linenumber" name="L41" href="#L41">41</a> <strong class="jxr_keyword">import</strong> com.lmax.disruptor.WaitStrategy;
<a class="jxr_linenumber" name="L42" href="#L42">42</a> <strong class="jxr_keyword">import</strong> com.lmax.disruptor.dsl.Disruptor;
<a class="jxr_linenumber" name="L43" href="#L43">43</a> <strong class="jxr_keyword">import</strong> com.lmax.disruptor.dsl.ProducerType;
<a class="jxr_linenumber" name="L44" href="#L44">44</a>
<a class="jxr_linenumber" name="L45" href="#L45">45</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment"> * Helper class decoupling the {@code AsyncLoggerConfig} class from the LMAX Disruptor library.</em>
<a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment"> * &lt;p&gt;</em>
<a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment"> * {@code AsyncLoggerConfig} is a plugin, and will be loaded even if users do not configure any {@code &lt;asyncLogger&gt;} or</em>
<a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment"> * {@code &lt;asyncRoot&gt;} elements in the configuration. If {@code AsyncLoggerConfig} has inner classes that extend or</em>
<a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment"> * implement classes from the Disruptor library, a {@code NoClassDefFoundError} is thrown if the Disruptor jar is not in</em>
<a class="jxr_linenumber" name="L51" href="#L51">51</a> <em class="jxr_javadoccomment"> * the classpath when the PluginManager loads the {@code AsyncLoggerConfig} plugin from the pre-defined plugins</em>
<a class="jxr_linenumber" name="L52" href="#L52">52</a> <em class="jxr_javadoccomment"> * definition file.</em>
<a class="jxr_linenumber" name="L53" href="#L53">53</a> <em class="jxr_javadoccomment"> * &lt;p&gt;</em>
<a class="jxr_linenumber" name="L54" href="#L54">54</a> <em class="jxr_javadoccomment"> * This class serves to make the dependency on the Disruptor optional, so that these classes are only loaded when the</em>
<a class="jxr_linenumber" name="L55" href="#L55">55</a> <em class="jxr_javadoccomment"> * {@code AsyncLoggerConfig} is actually used.</em>
<a class="jxr_linenumber" name="L56" href="#L56">56</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L57" href="#L57">57</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../org/apache/logging/log4j/core/async/AsyncLoggerConfigDisruptor.html">AsyncLoggerConfigDisruptor</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../../org/apache/logging/log4j/core/AbstractLifeCycle.html">AbstractLifeCycle</a> <strong class="jxr_keyword">implements</strong> <a href="../../../../../../org/apache/logging/log4j/core/async/AsyncLoggerConfigDelegate.html">AsyncLoggerConfigDelegate</a> {
<a class="jxr_linenumber" name="L58" href="#L58">58</a>
<a class="jxr_linenumber" name="L59" href="#L59">59</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> MAX_DRAIN_ATTEMPTS_BEFORE_SHUTDOWN = 200;
<a class="jxr_linenumber" name="L60" href="#L60">60</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> SLEEP_MILLIS_BETWEEN_DRAIN_ATTEMPTS = 50;
<a class="jxr_linenumber" name="L61" href="#L61">61</a>
<a class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L63" href="#L63">63</a> <em class="jxr_javadoccomment"> * RingBuffer events contain all information necessary to perform the work in a separate thread.</em>
<a class="jxr_linenumber" name="L64" href="#L64">64</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L65" href="#L65">65</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../org/apache/logging/log4j/core/async/AsyncLoggerConfigDisruptor.html">Log4jEventWrapper</a> {
<a class="jxr_linenumber" name="L66" href="#L66">66</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../org/apache/logging/log4j/core/async/AsyncLoggerConfigDisruptor.html">Log4jEventWrapper</a>() {
<a class="jxr_linenumber" name="L67" href="#L67">67</a> }
<a class="jxr_linenumber" name="L68" href="#L68">68</a>
<a class="jxr_linenumber" name="L69" href="#L69">69</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../org/apache/logging/log4j/core/async/AsyncLoggerConfigDisruptor.html">Log4jEventWrapper</a>(<strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/logging/log4j/core/impl/MutableLogEvent.html">MutableLogEvent</a> mutableLogEvent) {
<a class="jxr_linenumber" name="L70" href="#L70">70</a> event = mutableLogEvent;
<a class="jxr_linenumber" name="L71" href="#L71">71</a> }
<a class="jxr_linenumber" name="L72" href="#L72">72</a>
<a class="jxr_linenumber" name="L73" href="#L73">73</a> <strong class="jxr_keyword">private</strong> <a href="../../../../../../org/apache/logging/log4j/core/async/AsyncLoggerConfig.html">AsyncLoggerConfig</a> loggerConfig;
<a class="jxr_linenumber" name="L74" href="#L74">74</a> <strong class="jxr_keyword">private</strong> <a href="../../../../../../org/apache/logging/log4j/core/LogEvent.html">LogEvent</a> event;
<a class="jxr_linenumber" name="L75" href="#L75">75</a>
<a class="jxr_linenumber" name="L76" href="#L76">76</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L77" href="#L77">77</a> <em class="jxr_javadoccomment"> * Release references held by ring buffer to allow objects to be garbage-collected.</em>
<a class="jxr_linenumber" name="L78" href="#L78">78</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L79" href="#L79">79</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> clear() {
<a class="jxr_linenumber" name="L80" href="#L80">80</a> loggerConfig = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L81" href="#L81">81</a> <strong class="jxr_keyword">if</strong> (event instanceof MutableLogEvent) {
<a class="jxr_linenumber" name="L82" href="#L82">82</a> ((<a href="../../../../../../org/apache/logging/log4j/core/impl/MutableLogEvent.html">MutableLogEvent</a>) event).clear();
<a class="jxr_linenumber" name="L83" href="#L83">83</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L84" href="#L84">84</a> event = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L85" href="#L85">85</a> }
<a class="jxr_linenumber" name="L86" href="#L86">86</a> }
<a class="jxr_linenumber" name="L87" href="#L87">87</a>
<a class="jxr_linenumber" name="L88" href="#L88">88</a> @Override
<a class="jxr_linenumber" name="L89" href="#L89">89</a> <strong class="jxr_keyword">public</strong> String toString() {
<a class="jxr_linenumber" name="L90" href="#L90">90</a> <strong class="jxr_keyword">return</strong> String.valueOf(event);
<a class="jxr_linenumber" name="L91" href="#L91">91</a> }
<a class="jxr_linenumber" name="L92" href="#L92">92</a> }
<a class="jxr_linenumber" name="L93" href="#L93">93</a>
<a class="jxr_linenumber" name="L94" href="#L94">94</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L95" href="#L95">95</a> <em class="jxr_javadoccomment"> * EventHandler performs the work in a separate thread.</em>
<a class="jxr_linenumber" name="L96" href="#L96">96</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L97" href="#L97">97</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../org/apache/logging/log4j/core/async/AsyncLoggerConfigDisruptor.html">Log4jEventWrapperHandler</a> <strong class="jxr_keyword">implements</strong> SequenceReportingEventHandler&lt;Log4jEventWrapper&gt; {
<a class="jxr_linenumber" name="L98" href="#L98">98</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> NOTIFY_PROGRESS_THRESHOLD = 50;
<a class="jxr_linenumber" name="L99" href="#L99">99</a> <strong class="jxr_keyword">private</strong> Sequence sequenceCallback;
<a class="jxr_linenumber" name="L100" href="#L100">100</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">int</strong> counter;
<a class="jxr_linenumber" name="L101" href="#L101">101</a>
<a class="jxr_linenumber" name="L102" href="#L102">102</a> @Override
<a class="jxr_linenumber" name="L103" href="#L103">103</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setSequenceCallback(<strong class="jxr_keyword">final</strong> Sequence sequenceCallback) {
<a class="jxr_linenumber" name="L104" href="#L104">104</a> <strong class="jxr_keyword">this</strong>.sequenceCallback = sequenceCallback;
<a class="jxr_linenumber" name="L105" href="#L105">105</a> }
<a class="jxr_linenumber" name="L106" href="#L106">106</a>
<a class="jxr_linenumber" name="L107" href="#L107">107</a> @Override
<a class="jxr_linenumber" name="L108" href="#L108">108</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> onEvent(<strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/logging/log4j/core/async/AsyncLoggerConfigDisruptor.html">Log4jEventWrapper</a> event, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">long</strong> sequence, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> endOfBatch)
<a class="jxr_linenumber" name="L109" href="#L109">109</a> <strong class="jxr_keyword">throws</strong> Exception {
<a class="jxr_linenumber" name="L110" href="#L110">110</a> event.event.setEndOfBatch(endOfBatch);
<a class="jxr_linenumber" name="L111" href="#L111">111</a> event.loggerConfig.logToAsyncLoggerConfigsOnCurrentThread(event.event);
<a class="jxr_linenumber" name="L112" href="#L112">112</a> event.clear();
<a class="jxr_linenumber" name="L113" href="#L113">113</a>
<a class="jxr_linenumber" name="L114" href="#L114">114</a> notifyIntermediateProgress(sequence);
<a class="jxr_linenumber" name="L115" href="#L115">115</a> }
<a class="jxr_linenumber" name="L116" href="#L116">116</a>
<a class="jxr_linenumber" name="L117" href="#L117">117</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L118" href="#L118">118</a> <em class="jxr_javadoccomment"> * Notify the BatchEventProcessor that the sequence has progressed. Without this callback the sequence would not</em>
<a class="jxr_linenumber" name="L119" href="#L119">119</a> <em class="jxr_javadoccomment"> * be progressed until the batch has completely finished.</em>
<a class="jxr_linenumber" name="L120" href="#L120">120</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L121" href="#L121">121</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> notifyIntermediateProgress(<strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">long</strong> sequence) {
<a class="jxr_linenumber" name="L122" href="#L122">122</a> <strong class="jxr_keyword">if</strong> (++counter &gt; NOTIFY_PROGRESS_THRESHOLD) {
<a class="jxr_linenumber" name="L123" href="#L123">123</a> sequenceCallback.set(sequence);
<a class="jxr_linenumber" name="L124" href="#L124">124</a> counter = 0;
<a class="jxr_linenumber" name="L125" href="#L125">125</a> }
<a class="jxr_linenumber" name="L126" href="#L126">126</a> }
<a class="jxr_linenumber" name="L127" href="#L127">127</a> }
<a class="jxr_linenumber" name="L128" href="#L128">128</a>
<a class="jxr_linenumber" name="L129" href="#L129">129</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L130" href="#L130">130</a> <em class="jxr_javadoccomment"> * Factory used to populate the RingBuffer with events. These event objects are then re-used during the life of the</em>
<a class="jxr_linenumber" name="L131" href="#L131">131</a> <em class="jxr_javadoccomment"> * RingBuffer.</em>
<a class="jxr_linenumber" name="L132" href="#L132">132</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L133" href="#L133">133</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> EventFactory&lt;Log4jEventWrapper&gt; FACTORY = <strong class="jxr_keyword">new</strong> EventFactory&lt;Log4jEventWrapper&gt;() {
<a class="jxr_linenumber" name="L134" href="#L134">134</a> @Override
<a class="jxr_linenumber" name="L135" href="#L135">135</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../org/apache/logging/log4j/core/async/AsyncLoggerConfigDisruptor.html">Log4jEventWrapper</a> newInstance() {
<a class="jxr_linenumber" name="L136" href="#L136">136</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/apache/logging/log4j/core/async/AsyncLoggerConfigDisruptor.html">Log4jEventWrapper</a>();
<a class="jxr_linenumber" name="L137" href="#L137">137</a> }
<a class="jxr_linenumber" name="L138" href="#L138">138</a> };
<a class="jxr_linenumber" name="L139" href="#L139">139</a>
<a class="jxr_linenumber" name="L140" href="#L140">140</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L141" href="#L141">141</a> <em class="jxr_javadoccomment"> * Factory used to populate the RingBuffer with events. These event objects are then re-used during the life of the</em>
<a class="jxr_linenumber" name="L142" href="#L142">142</a> <em class="jxr_javadoccomment"> * RingBuffer.</em>
<a class="jxr_linenumber" name="L143" href="#L143">143</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L144" href="#L144">144</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> EventFactory&lt;Log4jEventWrapper&gt; MUTABLE_FACTORY = <strong class="jxr_keyword">new</strong> EventFactory&lt;Log4jEventWrapper&gt;() {
<a class="jxr_linenumber" name="L145" href="#L145">145</a> @Override
<a class="jxr_linenumber" name="L146" href="#L146">146</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../org/apache/logging/log4j/core/async/AsyncLoggerConfigDisruptor.html">Log4jEventWrapper</a> newInstance() {
<a class="jxr_linenumber" name="L147" href="#L147">147</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/apache/logging/log4j/core/async/AsyncLoggerConfigDisruptor.html">Log4jEventWrapper</a>(<strong class="jxr_keyword">new</strong> <a href="../../../../../../org/apache/logging/log4j/core/impl/MutableLogEvent.html">MutableLogEvent</a>());
<a class="jxr_linenumber" name="L148" href="#L148">148</a> }
<a class="jxr_linenumber" name="L149" href="#L149">149</a> };
<a class="jxr_linenumber" name="L150" href="#L150">150</a>
<a class="jxr_linenumber" name="L151" href="#L151">151</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L152" href="#L152">152</a> <em class="jxr_javadoccomment"> * Object responsible for passing on data to a specific RingBuffer event.</em>
<a class="jxr_linenumber" name="L153" href="#L153">153</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L154" href="#L154">154</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> EventTranslatorTwoArg&lt;Log4jEventWrapper, LogEvent, AsyncLoggerConfig&gt; TRANSLATOR =
<a class="jxr_linenumber" name="L155" href="#L155">155</a> <strong class="jxr_keyword">new</strong> EventTranslatorTwoArg&lt;Log4jEventWrapper, LogEvent, AsyncLoggerConfig&gt;() {
<a class="jxr_linenumber" name="L156" href="#L156">156</a>
<a class="jxr_linenumber" name="L157" href="#L157">157</a> @Override
<a class="jxr_linenumber" name="L158" href="#L158">158</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> translateTo(<strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/logging/log4j/core/async/AsyncLoggerConfigDisruptor.html">Log4jEventWrapper</a> ringBufferElement, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">long</strong> sequence,
<a class="jxr_linenumber" name="L159" href="#L159">159</a> <strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/logging/log4j/core/LogEvent.html">LogEvent</a> logEvent, <strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/logging/log4j/core/async/AsyncLoggerConfig.html">AsyncLoggerConfig</a> loggerConfig) {
<a class="jxr_linenumber" name="L160" href="#L160">160</a> ringBufferElement.event = logEvent;
<a class="jxr_linenumber" name="L161" href="#L161">161</a> ringBufferElement.loggerConfig = loggerConfig;
<a class="jxr_linenumber" name="L162" href="#L162">162</a> }
<a class="jxr_linenumber" name="L163" href="#L163">163</a> };
<a class="jxr_linenumber" name="L164" href="#L164">164</a>
<a class="jxr_linenumber" name="L165" href="#L165">165</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L166" href="#L166">166</a> <em class="jxr_javadoccomment"> * Object responsible for passing on data to a RingBuffer event with a MutableLogEvent.</em>
<a class="jxr_linenumber" name="L167" href="#L167">167</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L168" href="#L168">168</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> EventTranslatorTwoArg&lt;Log4jEventWrapper, LogEvent, AsyncLoggerConfig&gt; MUTABLE_TRANSLATOR =
<a class="jxr_linenumber" name="L169" href="#L169">169</a> <strong class="jxr_keyword">new</strong> EventTranslatorTwoArg&lt;Log4jEventWrapper, LogEvent, AsyncLoggerConfig&gt;() {
<a class="jxr_linenumber" name="L170" href="#L170">170</a>
<a class="jxr_linenumber" name="L171" href="#L171">171</a> @Override
<a class="jxr_linenumber" name="L172" href="#L172">172</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> translateTo(<strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/logging/log4j/core/async/AsyncLoggerConfigDisruptor.html">Log4jEventWrapper</a> ringBufferElement, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">long</strong> sequence,
<a class="jxr_linenumber" name="L173" href="#L173">173</a> <strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/logging/log4j/core/LogEvent.html">LogEvent</a> logEvent, <strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/logging/log4j/core/async/AsyncLoggerConfig.html">AsyncLoggerConfig</a> loggerConfig) {
<a class="jxr_linenumber" name="L174" href="#L174">174</a> ((<a href="../../../../../../org/apache/logging/log4j/core/impl/MutableLogEvent.html">MutableLogEvent</a>) ringBufferElement.event).initFrom(logEvent);
<a class="jxr_linenumber" name="L175" href="#L175">175</a> ringBufferElement.loggerConfig = loggerConfig;
<a class="jxr_linenumber" name="L176" href="#L176">176</a> }
<a class="jxr_linenumber" name="L177" href="#L177">177</a> };
<a class="jxr_linenumber" name="L178" href="#L178">178</a>
<a class="jxr_linenumber" name="L179" href="#L179">179</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">int</strong> ringBufferSize;
<a class="jxr_linenumber" name="L180" href="#L180">180</a> <strong class="jxr_keyword">private</strong> <a href="../../../../../../org/apache/logging/log4j/core/async/AsyncQueueFullPolicy.html">AsyncQueueFullPolicy</a> asyncQueueFullPolicy;
<a class="jxr_linenumber" name="L181" href="#L181">181</a> <strong class="jxr_keyword">private</strong> Boolean mutable = Boolean.FALSE;
<a class="jxr_linenumber" name="L182" href="#L182">182</a>
<a class="jxr_linenumber" name="L183" href="#L183">183</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">volatile</strong> Disruptor&lt;Log4jEventWrapper&gt; disruptor;
<a class="jxr_linenumber" name="L184" href="#L184">184</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">long</strong> backgroundThreadId; <em class="jxr_comment">// LOG4J2-471</em>
<a class="jxr_linenumber" name="L185" href="#L185">185</a> <strong class="jxr_keyword">private</strong> EventFactory&lt;Log4jEventWrapper&gt; factory;
<a class="jxr_linenumber" name="L186" href="#L186">186</a> <strong class="jxr_keyword">private</strong> EventTranslatorTwoArg&lt;Log4jEventWrapper, LogEvent, AsyncLoggerConfig&gt; translator;
<a class="jxr_linenumber" name="L187" href="#L187">187</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">volatile</strong> <strong class="jxr_keyword">boolean</strong> alreadyLoggedWarning = false;
<a class="jxr_linenumber" name="L188" href="#L188">188</a>
<a class="jxr_linenumber" name="L189" href="#L189">189</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> Object queueFullEnqueueLock = <strong class="jxr_keyword">new</strong> Object();
<a class="jxr_linenumber" name="L190" href="#L190">190</a>
<a class="jxr_linenumber" name="L191" href="#L191">191</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../org/apache/logging/log4j/core/async/AsyncLoggerConfigDisruptor.html">AsyncLoggerConfigDisruptor</a>() {
<a class="jxr_linenumber" name="L192" href="#L192">192</a> }
<a class="jxr_linenumber" name="L193" href="#L193">193</a>
<a class="jxr_linenumber" name="L194" href="#L194">194</a> <em class="jxr_comment">// called from AsyncLoggerConfig constructor</em>
<a class="jxr_linenumber" name="L195" href="#L195">195</a> @Override
<a class="jxr_linenumber" name="L196" href="#L196">196</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setLogEventFactory(<strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/logging/log4j/core/impl/LogEventFactory.html">LogEventFactory</a> logEventFactory) {
<a class="jxr_linenumber" name="L197" href="#L197">197</a> <em class="jxr_comment">// if any AsyncLoggerConfig uses a ReusableLogEventFactory</em>
<a class="jxr_linenumber" name="L198" href="#L198">198</a> <em class="jxr_comment">// then we need to populate our ringbuffer with MutableLogEvents</em>
<a class="jxr_linenumber" name="L199" href="#L199">199</a> <strong class="jxr_keyword">this</strong>.mutable = mutable || (logEventFactory instanceof ReusableLogEventFactory);
<a class="jxr_linenumber" name="L200" href="#L200">200</a> }
<a class="jxr_linenumber" name="L201" href="#L201">201</a>
<a class="jxr_linenumber" name="L202" href="#L202">202</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L203" href="#L203">203</a> <em class="jxr_javadoccomment"> * Increases the reference count and creates and starts a new Disruptor and associated thread if none currently</em>
<a class="jxr_linenumber" name="L204" href="#L204">204</a> <em class="jxr_javadoccomment"> * exists.</em>
<a class="jxr_linenumber" name="L205" href="#L205">205</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L206" href="#L206">206</a> <em class="jxr_javadoccomment"> * @see #stop()</em>
<a class="jxr_linenumber" name="L207" href="#L207">207</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L208" href="#L208">208</a> @Override
<a class="jxr_linenumber" name="L209" href="#L209">209</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">synchronized</strong> <strong class="jxr_keyword">void</strong> start() {
<a class="jxr_linenumber" name="L210" href="#L210">210</a> <strong class="jxr_keyword">if</strong> (disruptor != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L211" href="#L211">211</a> LOGGER.trace(<span class="jxr_string">"AsyncLoggerConfigDisruptor not starting new disruptor for this configuration, "</span>
<a class="jxr_linenumber" name="L212" href="#L212">212</a> + <span class="jxr_string">"using existing object."</span>);
<a class="jxr_linenumber" name="L213" href="#L213">213</a> <strong class="jxr_keyword">return</strong>;
<a class="jxr_linenumber" name="L214" href="#L214">214</a> }
<a class="jxr_linenumber" name="L215" href="#L215">215</a> LOGGER.trace(<span class="jxr_string">"AsyncLoggerConfigDisruptor creating new disruptor for this configuration."</span>);
<a class="jxr_linenumber" name="L216" href="#L216">216</a> ringBufferSize = DisruptorUtil.calculateRingBufferSize(<span class="jxr_string">"AsyncLoggerConfig.RingBufferSize"</span>);
<a class="jxr_linenumber" name="L217" href="#L217">217</a> <strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/logging/log4j/core/async/JCToolsBlockingQueueFactory.html">WaitStrategy</a> waitStrategy = DisruptorUtil.createWaitStrategy(<span class="jxr_string">"AsyncLoggerConfig.WaitStrategy"</span>);
<a class="jxr_linenumber" name="L218" href="#L218">218</a>
<a class="jxr_linenumber" name="L219" href="#L219">219</a> <strong class="jxr_keyword">final</strong> ThreadFactory threadFactory = <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/apache/logging/log4j/core/util/Log4jThreadFactory.html">Log4jThreadFactory</a>(<span class="jxr_string">"AsyncLoggerConfig"</span>, <strong class="jxr_keyword">true</strong>, Thread.NORM_PRIORITY) {
<a class="jxr_linenumber" name="L220" href="#L220">220</a> @Override
<a class="jxr_linenumber" name="L221" href="#L221">221</a> <strong class="jxr_keyword">public</strong> Thread newThread(<strong class="jxr_keyword">final</strong> Runnable r) {
<a class="jxr_linenumber" name="L222" href="#L222">222</a> <strong class="jxr_keyword">final</strong> Thread result = <strong class="jxr_keyword">super</strong>.newThread(r);
<a class="jxr_linenumber" name="L223" href="#L223">223</a> backgroundThreadId = result.getId();
<a class="jxr_linenumber" name="L224" href="#L224">224</a> <strong class="jxr_keyword">return</strong> result;
<a class="jxr_linenumber" name="L225" href="#L225">225</a> }
<a class="jxr_linenumber" name="L226" href="#L226">226</a> };
<a class="jxr_linenumber" name="L227" href="#L227">227</a> asyncQueueFullPolicy = AsyncQueueFullPolicyFactory.create();
<a class="jxr_linenumber" name="L228" href="#L228">228</a>
<a class="jxr_linenumber" name="L229" href="#L229">229</a> translator = mutable ? MUTABLE_TRANSLATOR : TRANSLATOR;
<a class="jxr_linenumber" name="L230" href="#L230">230</a> factory = mutable ? MUTABLE_FACTORY : FACTORY;
<a class="jxr_linenumber" name="L231" href="#L231">231</a> disruptor = <strong class="jxr_keyword">new</strong> Disruptor&lt;&gt;(factory, ringBufferSize, threadFactory, ProducerType.MULTI, waitStrategy);
<a class="jxr_linenumber" name="L232" href="#L232">232</a>
<a class="jxr_linenumber" name="L233" href="#L233">233</a> <strong class="jxr_keyword">final</strong> ExceptionHandler&lt;Log4jEventWrapper&gt; errorHandler = DisruptorUtil.getAsyncLoggerConfigExceptionHandler();
<a class="jxr_linenumber" name="L234" href="#L234">234</a> disruptor.setDefaultExceptionHandler(errorHandler);
<a class="jxr_linenumber" name="L235" href="#L235">235</a>
<a class="jxr_linenumber" name="L236" href="#L236">236</a> <strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/logging/log4j/core/async/AsyncLoggerConfigDisruptor.html">Log4jEventWrapperHandler</a>[] handlers = {<strong class="jxr_keyword">new</strong> Log4jEventWrapperHandler()};
<a class="jxr_linenumber" name="L237" href="#L237">237</a> disruptor.handleEventsWith(handlers);
<a class="jxr_linenumber" name="L238" href="#L238">238</a>
<a class="jxr_linenumber" name="L239" href="#L239">239</a> LOGGER.debug(<span class="jxr_string">"Starting AsyncLoggerConfig disruptor for this configuration with ringbufferSize={}, "</span>
<a class="jxr_linenumber" name="L240" href="#L240">240</a> + <span class="jxr_string">"waitStrategy={}, exceptionHandler={}..."</span>, disruptor.getRingBuffer().getBufferSize(), waitStrategy
<a class="jxr_linenumber" name="L241" href="#L241">241</a> .getClass().getSimpleName(), errorHandler);
<a class="jxr_linenumber" name="L242" href="#L242">242</a> disruptor.start();
<a class="jxr_linenumber" name="L243" href="#L243">243</a> <strong class="jxr_keyword">super</strong>.start();
<a class="jxr_linenumber" name="L244" href="#L244">244</a> }
<a class="jxr_linenumber" name="L245" href="#L245">245</a>
<a class="jxr_linenumber" name="L246" href="#L246">246</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L247" href="#L247">247</a> <em class="jxr_javadoccomment"> * Decreases the reference count. If the reference count reached zero, the Disruptor and its associated thread are</em>
<a class="jxr_linenumber" name="L248" href="#L248">248</a> <em class="jxr_javadoccomment"> * shut down and their references set to {@code null}.</em>
<a class="jxr_linenumber" name="L249" href="#L249">249</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L250" href="#L250">250</a> @Override
<a class="jxr_linenumber" name="L251" href="#L251">251</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> stop(<strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">long</strong> timeout, <strong class="jxr_keyword">final</strong> TimeUnit timeUnit) {
<a class="jxr_linenumber" name="L252" href="#L252">252</a> <strong class="jxr_keyword">final</strong> Disruptor&lt;Log4jEventWrapper&gt; temp = disruptor;
<a class="jxr_linenumber" name="L253" href="#L253">253</a> <strong class="jxr_keyword">if</strong> (temp == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L254" href="#L254">254</a> LOGGER.trace(<span class="jxr_string">"AsyncLoggerConfigDisruptor: disruptor for this configuration already shut down."</span>);
<a class="jxr_linenumber" name="L255" href="#L255">255</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>; <em class="jxr_comment">// disruptor was already shut down by another thread</em>
<a class="jxr_linenumber" name="L256" href="#L256">256</a> }
<a class="jxr_linenumber" name="L257" href="#L257">257</a> setStopping();
<a class="jxr_linenumber" name="L258" href="#L258">258</a> LOGGER.trace(<span class="jxr_string">"AsyncLoggerConfigDisruptor: shutting down disruptor for this configuration."</span>);
<a class="jxr_linenumber" name="L259" href="#L259">259</a>
<a class="jxr_linenumber" name="L260" href="#L260">260</a> <em class="jxr_comment">// We must guarantee that publishing to the RingBuffer has stopped before we call disruptor.shutdown().</em>
<a class="jxr_linenumber" name="L261" href="#L261">261</a> disruptor = <strong class="jxr_keyword">null</strong>; <em class="jxr_comment">// client code fails with NPE if log after stop = OK</em>
<a class="jxr_linenumber" name="L262" href="#L262">262</a>
<a class="jxr_linenumber" name="L263" href="#L263">263</a> <em class="jxr_comment">// Calling Disruptor.shutdown() will wait until all enqueued events are fully processed,</em>
<a class="jxr_linenumber" name="L264" href="#L264">264</a> <em class="jxr_comment">// but this waiting happens in a busy-spin. To avoid (postpone) wasting CPU,</em>
<a class="jxr_linenumber" name="L265" href="#L265">265</a> <em class="jxr_comment">// we sleep in short chunks, up to 10 seconds, waiting for the ringbuffer to drain.</em>
<a class="jxr_linenumber" name="L266" href="#L266">266</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i = 0; hasBacklog(temp) &amp;&amp; i &lt; MAX_DRAIN_ATTEMPTS_BEFORE_SHUTDOWN; i++) {
<a class="jxr_linenumber" name="L267" href="#L267">267</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L268" href="#L268">268</a> Thread.sleep(SLEEP_MILLIS_BETWEEN_DRAIN_ATTEMPTS); <em class="jxr_comment">// give up the CPU for a while</em>
<a class="jxr_linenumber" name="L269" href="#L269">269</a> } <strong class="jxr_keyword">catch</strong> (<strong class="jxr_keyword">final</strong> InterruptedException e) { <em class="jxr_comment">// ignored</em>
<a class="jxr_linenumber" name="L270" href="#L270">270</a> }
<a class="jxr_linenumber" name="L271" href="#L271">271</a> }
<a class="jxr_linenumber" name="L272" href="#L272">272</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L273" href="#L273">273</a> <em class="jxr_comment">// busy-spins until all events currently in the disruptor have been processed, or timeout</em>
<a class="jxr_linenumber" name="L274" href="#L274">274</a> temp.shutdown(timeout, timeUnit);
<a class="jxr_linenumber" name="L275" href="#L275">275</a> } <strong class="jxr_keyword">catch</strong> (<strong class="jxr_keyword">final</strong> TimeoutException e) {
<a class="jxr_linenumber" name="L276" href="#L276">276</a> LOGGER.warn(<span class="jxr_string">"AsyncLoggerConfigDisruptor: shutdown timed out after {} {}"</span>, timeout, timeUnit);
<a class="jxr_linenumber" name="L277" href="#L277">277</a> temp.halt(); <em class="jxr_comment">// give up on remaining log events, if any</em>
<a class="jxr_linenumber" name="L278" href="#L278">278</a> }
<a class="jxr_linenumber" name="L279" href="#L279">279</a> LOGGER.trace(<span class="jxr_string">"AsyncLoggerConfigDisruptor: disruptor has been shut down."</span>);
<a class="jxr_linenumber" name="L280" href="#L280">280</a>
<a class="jxr_linenumber" name="L281" href="#L281">281</a> <strong class="jxr_keyword">if</strong> (DiscardingAsyncQueueFullPolicy.getDiscardCount(asyncQueueFullPolicy) &gt; 0) {
<a class="jxr_linenumber" name="L282" href="#L282">282</a> LOGGER.trace(<span class="jxr_string">"AsyncLoggerConfigDisruptor: {} discarded {} events."</span>, asyncQueueFullPolicy,
<a class="jxr_linenumber" name="L283" href="#L283">283</a> DiscardingAsyncQueueFullPolicy.getDiscardCount(asyncQueueFullPolicy));
<a class="jxr_linenumber" name="L284" href="#L284">284</a> }
<a class="jxr_linenumber" name="L285" href="#L285">285</a> setStopped();
<a class="jxr_linenumber" name="L286" href="#L286">286</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
<a class="jxr_linenumber" name="L287" href="#L287">287</a> }
<a class="jxr_linenumber" name="L288" href="#L288">288</a>
<a class="jxr_linenumber" name="L289" href="#L289">289</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L290" href="#L290">290</a> <em class="jxr_javadoccomment"> * Returns {@code true} if the specified disruptor still has unprocessed events.</em>
<a class="jxr_linenumber" name="L291" href="#L291">291</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L292" href="#L292">292</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">boolean</strong> hasBacklog(<strong class="jxr_keyword">final</strong> Disruptor&lt;?&gt; theDisruptor) {
<a class="jxr_linenumber" name="L293" href="#L293">293</a> <strong class="jxr_keyword">final</strong> RingBuffer&lt;?&gt; ringBuffer = theDisruptor.getRingBuffer();
<a class="jxr_linenumber" name="L294" href="#L294">294</a> <strong class="jxr_keyword">return</strong> !ringBuffer.hasAvailableCapacity(ringBuffer.getBufferSize());
<a class="jxr_linenumber" name="L295" href="#L295">295</a> }
<a class="jxr_linenumber" name="L296" href="#L296">296</a>
<a class="jxr_linenumber" name="L297" href="#L297">297</a> @Override
<a class="jxr_linenumber" name="L298" href="#L298">298</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../org/apache/logging/log4j/core/async/EventRoute.html">EventRoute</a> getEventRoute(<strong class="jxr_keyword">final</strong> Level logLevel) {
<a class="jxr_linenumber" name="L299" href="#L299">299</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> remainingCapacity = remainingDisruptorCapacity();
<a class="jxr_linenumber" name="L300" href="#L300">300</a> <strong class="jxr_keyword">if</strong> (remainingCapacity &lt; 0) {
<a class="jxr_linenumber" name="L301" href="#L301">301</a> <strong class="jxr_keyword">return</strong> EventRoute.DISCARD;
<a class="jxr_linenumber" name="L302" href="#L302">302</a> }
<a class="jxr_linenumber" name="L303" href="#L303">303</a> <strong class="jxr_keyword">return</strong> asyncQueueFullPolicy.getRoute(backgroundThreadId, logLevel);
<a class="jxr_linenumber" name="L304" href="#L304">304</a> }
<a class="jxr_linenumber" name="L305" href="#L305">305</a>
<a class="jxr_linenumber" name="L306" href="#L306">306</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">int</strong> remainingDisruptorCapacity() {
<a class="jxr_linenumber" name="L307" href="#L307">307</a> <strong class="jxr_keyword">final</strong> Disruptor&lt;Log4jEventWrapper&gt; temp = disruptor;
<a class="jxr_linenumber" name="L308" href="#L308">308</a> <strong class="jxr_keyword">if</strong> (hasLog4jBeenShutDown(temp)) {
<a class="jxr_linenumber" name="L309" href="#L309">309</a> <strong class="jxr_keyword">return</strong> -1;
<a class="jxr_linenumber" name="L310" href="#L310">310</a> }
<a class="jxr_linenumber" name="L311" href="#L311">311</a> <strong class="jxr_keyword">return</strong> (<strong class="jxr_keyword">int</strong>) temp.getRingBuffer().remainingCapacity();
<a class="jxr_linenumber" name="L312" href="#L312">312</a> }
<a class="jxr_linenumber" name="L313" href="#L313">313</a>
<a class="jxr_linenumber" name="L314" href="#L314">314</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L315" href="#L315">315</a> <em class="jxr_javadoccomment"> * Returns {@code true} if the specified disruptor is null.</em>
<a class="jxr_linenumber" name="L316" href="#L316">316</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L317" href="#L317">317</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> hasLog4jBeenShutDown(<strong class="jxr_keyword">final</strong> Disruptor&lt;Log4jEventWrapper&gt; aDisruptor) {
<a class="jxr_linenumber" name="L318" href="#L318">318</a> <strong class="jxr_keyword">if</strong> (aDisruptor == <strong class="jxr_keyword">null</strong>) { <em class="jxr_comment">// LOG4J2-639</em>
<a class="jxr_linenumber" name="L319" href="#L319">319</a> LOGGER.warn(<span class="jxr_string">"Ignoring log event after log4j was shut down"</span>);
<a class="jxr_linenumber" name="L320" href="#L320">320</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
<a class="jxr_linenumber" name="L321" href="#L321">321</a> }
<a class="jxr_linenumber" name="L322" href="#L322">322</a> <strong class="jxr_keyword">return</strong> false;
<a class="jxr_linenumber" name="L323" href="#L323">323</a> }
<a class="jxr_linenumber" name="L324" href="#L324">324</a>
<a class="jxr_linenumber" name="L325" href="#L325">325</a> @Override
<a class="jxr_linenumber" name="L326" href="#L326">326</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> enqueueEvent(<strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/logging/log4j/core/LogEvent.html">LogEvent</a> event, <strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/logging/log4j/core/async/AsyncLoggerConfig.html">AsyncLoggerConfig</a> asyncLoggerConfig) {
<a class="jxr_linenumber" name="L327" href="#L327">327</a> <em class="jxr_comment">// LOG4J2-639: catch NPE if disruptor field was set to null after our check above</em>
<a class="jxr_linenumber" name="L328" href="#L328">328</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L329" href="#L329">329</a> <strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/logging/log4j/core/LogEvent.html">LogEvent</a> logEvent = prepareEvent(event);
<a class="jxr_linenumber" name="L330" href="#L330">330</a> enqueue(logEvent, asyncLoggerConfig);
<a class="jxr_linenumber" name="L331" href="#L331">331</a> } <strong class="jxr_keyword">catch</strong> (<strong class="jxr_keyword">final</strong> NullPointerException npe) {
<a class="jxr_linenumber" name="L332" href="#L332">332</a> <em class="jxr_comment">// Note: NPE prevents us from adding a log event to the disruptor after it was shut down,</em>
<a class="jxr_linenumber" name="L333" href="#L333">333</a> <em class="jxr_comment">// which could cause the publishEvent method to hang and never return.</em>
<a class="jxr_linenumber" name="L334" href="#L334">334</a> LOGGER.warn(<span class="jxr_string">"Ignoring log event after log4j was shut down: {} [{}] {}"</span>, event.getLevel(),
<a class="jxr_linenumber" name="L335" href="#L335">335</a> event.getLoggerName(), event.getMessage().getFormattedMessage()
<a class="jxr_linenumber" name="L336" href="#L336">336</a> + (event.getThrown() == <strong class="jxr_keyword">null</strong> ? <span class="jxr_string">""</span> : Throwables.toStringList(event.getThrown())));
<a class="jxr_linenumber" name="L337" href="#L337">337</a> }
<a class="jxr_linenumber" name="L338" href="#L338">338</a> }
<a class="jxr_linenumber" name="L339" href="#L339">339</a>
<a class="jxr_linenumber" name="L340" href="#L340">340</a> <strong class="jxr_keyword">private</strong> <a href="../../../../../../org/apache/logging/log4j/core/LogEvent.html">LogEvent</a> prepareEvent(<strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/logging/log4j/core/LogEvent.html">LogEvent</a> event) {
<a class="jxr_linenumber" name="L341" href="#L341">341</a> <a href="../../../../../../org/apache/logging/log4j/core/LogEvent.html">LogEvent</a> logEvent = ensureImmutable(event);
<a class="jxr_linenumber" name="L342" href="#L342">342</a> <strong class="jxr_keyword">if</strong> (logEvent.getMessage() instanceof ReusableMessage) {
<a class="jxr_linenumber" name="L343" href="#L343">343</a> <strong class="jxr_keyword">if</strong> (logEvent instanceof Log4jLogEvent) {
<a class="jxr_linenumber" name="L344" href="#L344">344</a> ((<a href="../../../../../../org/apache/logging/log4j/core/impl/Log4jLogEvent.html">Log4jLogEvent</a>) logEvent).makeMessageImmutable();
<a class="jxr_linenumber" name="L345" href="#L345">345</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (logEvent instanceof MutableLogEvent) {
<a class="jxr_linenumber" name="L346" href="#L346">346</a> <em class="jxr_comment">// MutableLogEvents need to be translated into the RingBuffer by the MUTABLE_TRANSLATOR.</em>
<a class="jxr_linenumber" name="L347" href="#L347">347</a> <em class="jxr_comment">// That translator calls MutableLogEvent.initFrom to copy the event, which will makeMessageImmutable the message.</em>
<a class="jxr_linenumber" name="L348" href="#L348">348</a> <strong class="jxr_keyword">if</strong> (translator != MUTABLE_TRANSLATOR) { <em class="jxr_comment">// should not happen...</em>
<a class="jxr_linenumber" name="L349" href="#L349">349</a> <em class="jxr_comment">// TRANSLATOR expects an immutable LogEvent</em>
<a class="jxr_linenumber" name="L350" href="#L350">350</a> logEvent = ((MutableLogEvent) logEvent).createMemento();
<a class="jxr_linenumber" name="L351" href="#L351">351</a> }
<a class="jxr_linenumber" name="L352" href="#L352">352</a> } <strong class="jxr_keyword">else</strong> { <em class="jxr_comment">// custom log event, with a ReusableMessage</em>
<a class="jxr_linenumber" name="L353" href="#L353">353</a> showWarningAboutCustomLogEventWithReusableMessage(logEvent);
<a class="jxr_linenumber" name="L354" href="#L354">354</a> }
<a class="jxr_linenumber" name="L355" href="#L355">355</a> } <strong class="jxr_keyword">else</strong> { <em class="jxr_comment">// message is not a ReusableMessage; makeMessageImmutable it to prevent ConcurrentModificationExceptions</em>
<a class="jxr_linenumber" name="L356" href="#L356">356</a> InternalAsyncUtil.makeMessageImmutable(logEvent.getMessage()); <em class="jxr_comment">// LOG4J2-1988, LOG4J2-1914</em>
<a class="jxr_linenumber" name="L357" href="#L357">357</a> }
<a class="jxr_linenumber" name="L358" href="#L358">358</a> <strong class="jxr_keyword">return</strong> logEvent;
<a class="jxr_linenumber" name="L359" href="#L359">359</a> }
<a class="jxr_linenumber" name="L360" href="#L360">360</a>
<a class="jxr_linenumber" name="L361" href="#L361">361</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> showWarningAboutCustomLogEventWithReusableMessage(<strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/logging/log4j/core/LogEvent.html">LogEvent</a> logEvent) {
<a class="jxr_linenumber" name="L362" href="#L362">362</a> <strong class="jxr_keyword">if</strong> (!alreadyLoggedWarning) {
<a class="jxr_linenumber" name="L363" href="#L363">363</a> LOGGER.warn(<span class="jxr_string">"Custom log event of type {} contains a mutable message of type {}."</span> +
<a class="jxr_linenumber" name="L364" href="#L364">364</a> <span class="jxr_string">" AsyncLoggerConfig does not know how to make an immutable copy of this message."</span> +
<a class="jxr_linenumber" name="L365" href="#L365">365</a> <span class="jxr_string">" This may result in ConcurrentModificationExceptions or incorrect log messages"</span> +
<a class="jxr_linenumber" name="L366" href="#L366">366</a> <span class="jxr_string">" if the application modifies objects in the message while"</span> +
<a class="jxr_linenumber" name="L367" href="#L367">367</a> <span class="jxr_string">" the background thread is writing it to the appenders."</span>,
<a class="jxr_linenumber" name="L368" href="#L368">368</a> logEvent.getClass().getName(), logEvent.getMessage().getClass().getName());
<a class="jxr_linenumber" name="L369" href="#L369">369</a> alreadyLoggedWarning = <strong class="jxr_keyword">true</strong>;
<a class="jxr_linenumber" name="L370" href="#L370">370</a> }
<a class="jxr_linenumber" name="L371" href="#L371">371</a> }
<a class="jxr_linenumber" name="L372" href="#L372">372</a>
<a class="jxr_linenumber" name="L373" href="#L373">373</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> enqueue(<strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/logging/log4j/core/LogEvent.html">LogEvent</a> logEvent, <strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/logging/log4j/core/async/AsyncLoggerConfig.html">AsyncLoggerConfig</a> asyncLoggerConfig) {
<a class="jxr_linenumber" name="L374" href="#L374">374</a> <strong class="jxr_keyword">if</strong> (synchronizeEnqueueWhenQueueFull()) {
<a class="jxr_linenumber" name="L375" href="#L375">375</a> <strong class="jxr_keyword">synchronized</strong> (queueFullEnqueueLock) {
<a class="jxr_linenumber" name="L376" href="#L376">376</a> disruptor.getRingBuffer().publishEvent(translator, logEvent, asyncLoggerConfig);
<a class="jxr_linenumber" name="L377" href="#L377">377</a> }
<a class="jxr_linenumber" name="L378" href="#L378">378</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L379" href="#L379">379</a> disruptor.getRingBuffer().publishEvent(translator, logEvent, asyncLoggerConfig);
<a class="jxr_linenumber" name="L380" href="#L380">380</a> }
<a class="jxr_linenumber" name="L381" href="#L381">381</a> }
<a class="jxr_linenumber" name="L382" href="#L382">382</a>
<a class="jxr_linenumber" name="L383" href="#L383">383</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> synchronizeEnqueueWhenQueueFull() {
<a class="jxr_linenumber" name="L384" href="#L384">384</a> <strong class="jxr_keyword">return</strong> DisruptorUtil.ASYNC_CONFIG_SYNCHRONIZE_ENQUEUE_WHEN_QUEUE_FULL
<a class="jxr_linenumber" name="L385" href="#L385">385</a> <em class="jxr_comment">// Background thread must never block</em>
<a class="jxr_linenumber" name="L386" href="#L386">386</a> &amp;&amp; backgroundThreadId != Thread.currentThread().getId();
<a class="jxr_linenumber" name="L387" href="#L387">387</a> }
<a class="jxr_linenumber" name="L388" href="#L388">388</a>
<a class="jxr_linenumber" name="L389" href="#L389">389</a> @Override
<a class="jxr_linenumber" name="L390" href="#L390">390</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> tryEnqueue(<strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/logging/log4j/core/LogEvent.html">LogEvent</a> event, <strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/logging/log4j/core/async/AsyncLoggerConfig.html">AsyncLoggerConfig</a> asyncLoggerConfig) {
<a class="jxr_linenumber" name="L391" href="#L391">391</a> <strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/logging/log4j/core/LogEvent.html">LogEvent</a> logEvent = prepareEvent(event);
<a class="jxr_linenumber" name="L392" href="#L392">392</a> <strong class="jxr_keyword">return</strong> disruptor.getRingBuffer().tryPublishEvent(translator, logEvent, asyncLoggerConfig);
<a class="jxr_linenumber" name="L393" href="#L393">393</a> }
<a class="jxr_linenumber" name="L394" href="#L394">394</a>
<a class="jxr_linenumber" name="L395" href="#L395">395</a> <strong class="jxr_keyword">private</strong> <a href="../../../../../../org/apache/logging/log4j/core/LogEvent.html">LogEvent</a> ensureImmutable(<strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/logging/log4j/core/LogEvent.html">LogEvent</a> event) {
<a class="jxr_linenumber" name="L396" href="#L396">396</a> <a href="../../../../../../org/apache/logging/log4j/core/LogEvent.html">LogEvent</a> result = event;
<a class="jxr_linenumber" name="L397" href="#L397">397</a> <strong class="jxr_keyword">if</strong> (event instanceof RingBufferLogEvent) {
<a class="jxr_linenumber" name="L398" href="#L398">398</a> <em class="jxr_comment">// Deal with special case where both types of Async Loggers are used together:</em>
<a class="jxr_linenumber" name="L399" href="#L399">399</a> <em class="jxr_comment">// RingBufferLogEvents are created by the all-loggers-async type, but</em>
<a class="jxr_linenumber" name="L400" href="#L400">400</a> <em class="jxr_comment">// this event is also consumed by the some-loggers-async type (this class).</em>
<a class="jxr_linenumber" name="L401" href="#L401">401</a> <em class="jxr_comment">// The original event will be re-used and modified in an application thread later,</em>
<a class="jxr_linenumber" name="L402" href="#L402">402</a> <em class="jxr_comment">// so take a snapshot of it, which can be safely processed in the</em>
<a class="jxr_linenumber" name="L403" href="#L403">403</a> <em class="jxr_comment">// some-loggers-async background thread.</em>
<a class="jxr_linenumber" name="L404" href="#L404">404</a> result = ((RingBufferLogEvent) event).createMemento();
<a class="jxr_linenumber" name="L405" href="#L405">405</a> }
<a class="jxr_linenumber" name="L406" href="#L406">406</a> <strong class="jxr_keyword">return</strong> result;
<a class="jxr_linenumber" name="L407" href="#L407">407</a> }
<a class="jxr_linenumber" name="L408" href="#L408">408</a>
<a class="jxr_linenumber" name="L409" href="#L409">409</a> <em class="jxr_comment">/*</em>
<a class="jxr_linenumber" name="L410" href="#L410">410</a> <em class="jxr_comment"> * (non-Javadoc)</em>
<a class="jxr_linenumber" name="L411" href="#L411">411</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="L412" href="#L412">412</a> <em class="jxr_comment"> * @see org.apache.logging.log4j.core.async.AsyncLoggerConfigDelegate#createRingBufferAdmin(java.lang.String,</em>
<a class="jxr_linenumber" name="L413" href="#L413">413</a> <em class="jxr_comment"> * java.lang.String)</em>
<a class="jxr_linenumber" name="L414" href="#L414">414</a> <em class="jxr_comment"> */</em>
<a class="jxr_linenumber" name="L415" href="#L415">415</a> @Override
<a class="jxr_linenumber" name="L416" href="#L416">416</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../org/apache/logging/log4j/core/jmx/RingBufferAdmin.html">RingBufferAdmin</a> createRingBufferAdmin(<strong class="jxr_keyword">final</strong> String contextName, <strong class="jxr_keyword">final</strong> String loggerConfigName) {
<a class="jxr_linenumber" name="L417" href="#L417">417</a> <strong class="jxr_keyword">return</strong> RingBufferAdmin.forAsyncLoggerConfig(disruptor.getRingBuffer(), contextName, loggerConfigName);
<a class="jxr_linenumber" name="L418" href="#L418">418</a> }
<a class="jxr_linenumber" name="L419" href="#L419">419</a> }
</pre>
<hr/>
<div id="footer">Copyright &#169; 1999&#x2013;2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</div>
</body>
</html>