You are viewing a plain text version of this content. The canonical link for it is here.
Posted to oak-commits@jackrabbit.apache.org by th...@apache.org on 2015/08/26 14:57:09 UTC

svn commit: r1697915 - in /jackrabbit/oak/trunk/oak-jcr/src: main/java/org/apache/jackrabbit/oak/jcr/delegate/ main/java/org/apache/jackrabbit/oak/jcr/session/ test/java/org/apache/jackrabbit/oak/jcr/session/

Author: thomasm
Date: Wed Aug 26 12:57:09 2015
New Revision: 1697915

URL: http://svn.apache.org/r1697915
Log:
OAK-3153 Make it possible to disable recording of stack trace in SessionStats

Added:
    jackrabbit/oak/trunk/oak-jcr/src/test/java/org/apache/jackrabbit/oak/jcr/session/
    jackrabbit/oak/trunk/oak-jcr/src/test/java/org/apache/jackrabbit/oak/jcr/session/SessionStatsTest.java
Modified:
    jackrabbit/oak/trunk/oak-jcr/src/main/java/org/apache/jackrabbit/oak/jcr/delegate/SessionDelegate.java
    jackrabbit/oak/trunk/oak-jcr/src/main/java/org/apache/jackrabbit/oak/jcr/session/SessionStats.java

Modified: jackrabbit/oak/trunk/oak-jcr/src/main/java/org/apache/jackrabbit/oak/jcr/delegate/SessionDelegate.java
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-jcr/src/main/java/org/apache/jackrabbit/oak/jcr/delegate/SessionDelegate.java?rev=1697915&r1=1697914&r2=1697915&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-jcr/src/main/java/org/apache/jackrabbit/oak/jcr/delegate/SessionDelegate.java (original)
+++ jackrabbit/oak/trunk/oak-jcr/src/main/java/org/apache/jackrabbit/oak/jcr/delegate/SessionDelegate.java Wed Aug 26 12:57:09 2015
@@ -147,10 +147,10 @@ public class SessionDelegate {
                         namespaces));
         this.idManager = new IdentifierManager(root);
         this.clock = checkNotNull(clock);
+        checkNotNull(statisticManager);
         this.sessionStats = new SessionStats(contentSession.toString(),
-                contentSession.getAuthInfo(), clock, refreshStrategy, this);
+                contentSession.getAuthInfo(), clock, refreshStrategy, this, statisticManager);
         this.sessionCounters = sessionStats.getCounters();
-        checkNotNull(statisticManager);
         readCounter = statisticManager.getCounter(SESSION_READ_COUNTER);
         readDuration = statisticManager.getCounter(SESSION_READ_DURATION);
         writeCounter = statisticManager.getCounter(SESSION_WRITE_COUNTER);

Modified: jackrabbit/oak/trunk/oak-jcr/src/main/java/org/apache/jackrabbit/oak/jcr/session/SessionStats.java
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-jcr/src/main/java/org/apache/jackrabbit/oak/jcr/session/SessionStats.java?rev=1697915&r1=1697914&r2=1697915&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-jcr/src/main/java/org/apache/jackrabbit/oak/jcr/session/SessionStats.java (original)
+++ jackrabbit/oak/trunk/oak-jcr/src/main/java/org/apache/jackrabbit/oak/jcr/session/SessionStats.java Wed Aug 26 12:57:09 2015
@@ -32,14 +32,27 @@ import java.util.concurrent.atomic.Atomi
 
 import javax.jcr.RepositoryException;
 
+import org.apache.jackrabbit.api.stats.RepositoryStatistics.Type;
 import org.apache.jackrabbit.oak.api.AuthInfo;
 import org.apache.jackrabbit.oak.api.jmx.SessionMBean;
 import org.apache.jackrabbit.oak.jcr.delegate.SessionDelegate;
 import org.apache.jackrabbit.oak.jcr.session.operation.SessionOperation;
 import org.apache.jackrabbit.oak.stats.Clock;
+import org.apache.jackrabbit.oak.stats.StatisticManager;
 
 public class SessionStats implements SessionMBean {
-    private final Exception initStackTrace = new Exception("The session was opened here:");
+
+    /**
+     * The threshold of active sessions from where on it should record the stack trace for new sessions. The reason why
+     * this is not enabled by default is because recording stack traces is rather expensive and can significantly
+     * slow down the code if sessions are created and thrown away in a loop.
+     *
+     * Once this threshold is exceeded, we assume that there is a session leak which should be fixed and start recording
+     * the stack traces to make it easier to find the cause of it.
+     */
+    static final int INIT_STACK_TRACE_THRESHOLD = Integer.getInteger("oak.sessionStats.initStackTraceThreshold", 1000);
+
+    private final Exception initStackTrace;
 
     private final AtomicReference<RepositoryException> lastFailedSave =
             new AtomicReference<RepositoryException>();
@@ -55,13 +68,17 @@ public class SessionStats implements Ses
     private Map<String, Object> attributes = Collections.emptyMap();
 
     public SessionStats(String sessionId, AuthInfo authInfo, Clock clock,
-            RefreshStrategy refreshStrategy, SessionDelegate sessionDelegate) {
+            RefreshStrategy refreshStrategy, SessionDelegate sessionDelegate, StatisticManager statisticManager) {
         this.counters = new Counters(clock);
         this.sessionId = sessionId;
         this.authInfo = authInfo;
         this.clock = clock;
         this.refreshStrategy = refreshStrategy;
         this.sessionDelegate = sessionDelegate;
+
+        long activeSessionCount = statisticManager.getCounter(Type.SESSION_COUNT).get();
+        initStackTrace = (activeSessionCount > INIT_STACK_TRACE_THRESHOLD) ?
+                new Exception("The session was opened here:") : null;
     }
 
     public void close() {

Added: jackrabbit/oak/trunk/oak-jcr/src/test/java/org/apache/jackrabbit/oak/jcr/session/SessionStatsTest.java
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-jcr/src/test/java/org/apache/jackrabbit/oak/jcr/session/SessionStatsTest.java?rev=1697915&view=auto
==============================================================================
--- jackrabbit/oak/trunk/oak-jcr/src/test/java/org/apache/jackrabbit/oak/jcr/session/SessionStatsTest.java (added)
+++ jackrabbit/oak/trunk/oak-jcr/src/test/java/org/apache/jackrabbit/oak/jcr/session/SessionStatsTest.java Wed Aug 26 12:57:09 2015
@@ -0,0 +1,72 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.jackrabbit.oak.jcr.session;
+
+import org.apache.commons.lang3.reflect.FieldUtils;
+import org.apache.jackrabbit.oak.jcr.delegate.SessionDelegate;
+import org.apache.jackrabbit.test.AbstractJCRTest;
+
+import javax.jcr.RepositoryException;
+import javax.jcr.Session;
+import java.util.ArrayList;
+import java.util.List;
+
+public class SessionStatsTest extends AbstractJCRTest {
+
+    /**
+     * Tests if the init stack trace is not recorded by default.
+     */
+    public void testInitStackTraceDisabledByDefault() throws IllegalAccessException {
+        assertTrue("initStackTrace is not empty", getInitStackTrace(superuser).isEmpty());
+    }
+
+    /**
+     * Tests if the init stack trace is recorded after opening a lot of sessions.
+     */
+    public void testInitStackTraceEnabledAfterOpeningManySessions()
+            throws IllegalAccessException, RepositoryException {
+        final int sessionCount = SessionStats.INIT_STACK_TRACE_THRESHOLD + 1;
+        final List<Session> sessions = new ArrayList<Session>(sessionCount);
+        for (int i = 0; i < sessionCount; i++) {
+            sessions.add(createSession());
+        }
+
+        // Stack trace should be recorded by now
+        Session lastSession = sessions.get(sessionCount - 1);
+        assertFalse("initStackTrace is empty", getInitStackTrace(lastSession).isEmpty());
+
+        for (Session session : sessions) {
+            session.logout();
+        }
+
+        // Stack trace should not be recorded anymore
+        Session afterSession = createSession();
+        assertTrue("initStackTrace is not empty", getInitStackTrace(afterSession).isEmpty());
+        afterSession.logout();
+    }
+
+    private Session createSession() throws RepositoryException {
+        return getHelper().getReadWriteSession();
+    }
+
+    private String getInitStackTrace(Session session) throws IllegalAccessException {
+        SessionDelegate sessionDelegate = (SessionDelegate) FieldUtils.readDeclaredField(session, "sd", true);
+        SessionStats sessionStats = sessionDelegate.getSessionStats();
+        return sessionStats.getInitStackTrace();
+    }
+
+}
\ No newline at end of file