https://jira.opendaylight.org This file is an XML representation of an issue en-us 8.20.10 820010 22-06-2022 https://jira.opendaylight.org/browse/GENIUS-236 genius <p>I'm looking at a Java Flight Recording obtained from (internal) scale lab testing, and see extensive "TLAB Allocations" due to what appears to be a clear mistake causing excessive toString() usage in ITM's OvsdbNodeListener.getOvsdbTepInfo():</p> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <pre class="code-java"><span class="code-object">char</span>[] java.util.Arrays.copyOf(<span class="code-object">char</span>[], <span class="code-object">int</span>) 321 void java.lang.AbstractStringBuilder.ensureCapacityInternal(<span class="code-object">int</span>) 321 AbstractStringBuilder java.lang.AbstractStringBuilder.append(<span class="code-object">boolean</span>) 243 StringBuilder java.lang.StringBuilder.append(<span class="code-object">boolean</span>) 243 <span class="code-object">String</span> org.opendaylight.genius.itm.commons.OvsdbTepInfo.toString() 243 OvsdbTepInfo org.opendaylight.genius.itm.listeners.OvsdbNodeListener.getOvsdbTepInfo(OvsdbNodeAugmentation) 243 void org.opendaylight.genius.itm.listeners.OvsdbNodeListener.update(Node, Node) 243 void org.opendaylight.genius.itm.listeners.OvsdbNodeListener.update(DataObject, DataObject) 243 void org.opendaylight.serviceutils.tools.mdsal.listener.DataTreeChangeListenerActions.update(InstanceIdentifier, DataObject, DataObject) 243 void org.opendaylight.serviceutils.tools.mdsal.listener.DataTreeChangeListenerActions.onDataTreeChanged(Collection, DataStoreMetrics) 243 void org.opendaylight.serviceutils.tools.mdsal.listener.AbstractSyncDataTreeChangeListener.onDataTreeChanged(Collection) 243 void org.opendaylight.controller.md.sal.binding.impl.BindingDOMDataTreeChangeListenerAdapter.onDataTreeChanged(Collection) 243 void org.opendaylight.controller.cluster.datastore.DataTreeChangeListenerActor.dataChanged(DataTreeChanged) 243 void org.opendaylight.controller.cluster.datastore.DataTreeChangeListenerActor.handleReceive(<span class="code-object">Object</span>) 243 void org.opendaylight.controller.cluster.common.actor.AbstractUntypedActor.onReceive(<span class="code-object">Object</span>) 243 <span class="code-object">Object</span> akka.actor.UntypedActor$$anonfun$receive$1.applyOrElse(<span class="code-object">Object</span>, Function1) 243 void akka.actor.Actor.aroundReceive(PartialFunction, <span class="code-object">Object</span>) 243 void akka.actor.Actor.aroundReceive$(Actor, PartialFunction, <span class="code-object">Object</span>) 243 void akka.actor.UntypedActor.aroundReceive(PartialFunction, <span class="code-object">Object</span>) 243 void akka.actor.ActorCell.receiveMessage(<span class="code-object">Object</span>) 243 void akka.actor.ActorCell.invoke(Envelope) 243 void akka.dispatch.Mailbox.processMailbox(<span class="code-object">int</span>, <span class="code-object">long</span>) 243 void akka.dispatch.Mailbox.run() 243 <span class="code-object">boolean</span> akka.dispatch.Mailbox.exec() 243 <span class="code-object">int</span> akka.dispatch.forkjoin.ForkJoinTask.doExec() 243 void akka.dispatch.forkjoin.ForkJoinPool$WorkQueue.runTask(ForkJoinTask) 243 void akka.dispatch.forkjoin.ForkJoinPool.runWorker(ForkJoinPool$WorkQueue) 243 void akka.dispatch.forkjoin.ForkJoinWorkerThread.run() 243</pre> </div></div> GENIUS-236

Excessive toString in OvsdbNodeListener.getOvsdbTepInfo()

Bug Medium Resolved Done TARUN THAKUR Michael Vorburger Mon, 12 Nov 2018 17:39:45 +0000 Thu, 15 Nov 2018 12:31:24 +0000 Thu, 15 Nov 2018 12:31:24 +0000 Oxygen-SR3 Oxygen-SR4 ITM 0 2 <p>Michael,</p> <p>I hope above issue is pointing to line "<font color="#660e7a">LOG</font>.trace(<font color="#008000">"ovsdbTepInfo retrieved {}"</font>, ovsdbTepInfoObj);" in OvsdbNodeListener.getOvsdbTepInfo()</p> <p>This is right that above method will be invoked every few seconds via update() method of OvsdbNodeListener that is why it may cause frequent TLAB allocation due to toString() calling on the object ovsdbTepInfoObj in the log message.</p> <p>As a solution, we may remove this log message because required paramters of ovsdbTepInfoObj are being printed at places where they are being used for performing TEP operations like add/remove in the ITM config DS.</p> <p>Please share your suggestion if it seems fine to you.</p> <p> </p> <p>Even, log message can be covered under if condition like below:</p> <p><b>if</b> (<b><em>LOG</em></b>.isTraceEnabled()) {<br/>     <b><em>LOG</em></b>.trace(<b>"ovsdbTepInfo retrieved {}"</b>, ovsdbTepInfoObj);<br/> }</p> <p>This can also solve problem as it is done at many places in Genius code.</p> <p>But, I feel that trace log message can be removed.</p> <p>Tarun, if we look carefully at the exact stack trace above, we note:</p> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <pre class="code-java"> <span class="code-object">String</span> org.opendaylight.genius.itm.commons.OvsdbTepInfo.toString() 243 OvsdbTepInfo org.opendaylight.genius.itm.listeners.OvsdbNodeListener.getOvsdbTepInfo(OvsdbNodeAugmentation) 243</pre> </div></div> <p>This has Affects Version Oxygen, and indeed <a href="https://github.com/opendaylight/genius/blob/stable/oxygen/itm/itm-impl/src/main/java/org/opendaylight/genius/itm/listeners/OvsdbNodeListener.java#L330" class="external-link" target="_blank" rel="nofollow noopener">in Oxygen (only; already fixed in Fluorine &amp; Neon) we had</a>:</p> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <pre class="code-java"> LOG.trace(<span class="code-quote">"{}"</span>, ovsdbTepInfoObj.toString());</pre> </div></div> <p>which is very bad and what caused this; I've just fixed it in <a href="https://git.opendaylight.org/gerrit/#/c/77850/" class="external-link" target="_blank" rel="nofollow noopener">c/77850</a>.</p> <p>FYI there is <a href="https://wiki.opendaylight.org/view/BestPractices/Logging_Best_Practices#Do_NOT.2C_in_general.2C_use_isTrace.2F.2FDebug.2FInfo.2FWarn.2FErrorEnabled.28.29" class="external-link" target="_blank" rel="nofollow noopener">normally no need to use isTraceEnabled</a>(), because LOG.trace() is already fast enough, and only does the toString() on arguments if that level is emabled. That is unless in the LOG statement you do something that has some cost to calculate (i.e. don't just pass an object reference), then you need isXXXEnabled. The linked Wiki page explains this more; hope that helps.</p> Development Rank 0|i03kc7: