Browse Source
Includes upgrade to Tomcat 10.0.14, Undertow 2.2.14, Apache HttpClient 5.1.2, Hibernate ORM 5.6.2, Mockito 4.1. Closes gh-27786pull/27818/head
8 changed files with 18 additions and 248 deletions
@ -1,144 +0,0 @@
@@ -1,144 +0,0 @@
|
||||
/* |
||||
* Copyright 2002-2017 the original author or authors. |
||||
* |
||||
* Licensed 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 |
||||
* |
||||
* https://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.springframework.aop.interceptor; |
||||
|
||||
import com.jamonapi.MonKey; |
||||
import com.jamonapi.MonKeyImp; |
||||
import com.jamonapi.Monitor; |
||||
import com.jamonapi.MonitorFactory; |
||||
import com.jamonapi.utils.Misc; |
||||
import org.aopalliance.intercept.MethodInvocation; |
||||
import org.apache.commons.logging.Log; |
||||
|
||||
/** |
||||
* Performance monitor interceptor that uses <b>JAMon</b> library to perform the |
||||
* performance measurement on the intercepted method and output the stats. |
||||
* In addition, it tracks/counts exceptions thrown by the intercepted method. |
||||
* The stack traces can be viewed in the JAMon web application. |
||||
* |
||||
* <p>This code is inspired by Thierry Templier's blog. |
||||
* |
||||
* @author Dmitriy Kopylenko |
||||
* @author Juergen Hoeller |
||||
* @author Rob Harrop |
||||
* @author Steve Souza |
||||
* @since 1.1.3 |
||||
* @see com.jamonapi.MonitorFactory |
||||
* @see PerformanceMonitorInterceptor |
||||
*/ |
||||
@SuppressWarnings("serial") |
||||
public class JamonPerformanceMonitorInterceptor extends AbstractMonitoringInterceptor { |
||||
|
||||
private boolean trackAllInvocations = false; |
||||
|
||||
|
||||
/** |
||||
* Create a new JamonPerformanceMonitorInterceptor with a static logger. |
||||
*/ |
||||
public JamonPerformanceMonitorInterceptor() { |
||||
} |
||||
|
||||
/** |
||||
* Create a new JamonPerformanceMonitorInterceptor with a dynamic or static logger, |
||||
* according to the given flag. |
||||
* @param useDynamicLogger whether to use a dynamic logger or a static logger |
||||
* @see #setUseDynamicLogger |
||||
*/ |
||||
public JamonPerformanceMonitorInterceptor(boolean useDynamicLogger) { |
||||
setUseDynamicLogger(useDynamicLogger); |
||||
} |
||||
|
||||
/** |
||||
* Create a new JamonPerformanceMonitorInterceptor with a dynamic or static logger, |
||||
* according to the given flag. |
||||
* @param useDynamicLogger whether to use a dynamic logger or a static logger |
||||
* @param trackAllInvocations whether to track all invocations that go through |
||||
* this interceptor, or just invocations with trace logging enabled |
||||
* @see #setUseDynamicLogger |
||||
*/ |
||||
public JamonPerformanceMonitorInterceptor(boolean useDynamicLogger, boolean trackAllInvocations) { |
||||
setUseDynamicLogger(useDynamicLogger); |
||||
setTrackAllInvocations(trackAllInvocations); |
||||
} |
||||
|
||||
|
||||
/** |
||||
* Set whether to track all invocations that go through this interceptor, |
||||
* or just invocations with trace logging enabled. |
||||
* <p>Default is "false": Only invocations with trace logging enabled will |
||||
* be monitored. Specify "true" to let JAMon track all invocations, |
||||
* gathering statistics even when trace logging is disabled. |
||||
*/ |
||||
public void setTrackAllInvocations(boolean trackAllInvocations) { |
||||
this.trackAllInvocations = trackAllInvocations; |
||||
} |
||||
|
||||
|
||||
/** |
||||
* Always applies the interceptor if the "trackAllInvocations" flag has been set; |
||||
* else just kicks in if the log is enabled. |
||||
* @see #setTrackAllInvocations |
||||
* @see #isLogEnabled |
||||
*/ |
||||
@Override |
||||
protected boolean isInterceptorEnabled(MethodInvocation invocation, Log logger) { |
||||
return (this.trackAllInvocations || isLogEnabled(logger)); |
||||
} |
||||
|
||||
/** |
||||
* Wraps the invocation with a JAMon Monitor and writes the current |
||||
* performance statistics to the log (if enabled). |
||||
* @see com.jamonapi.MonitorFactory#start |
||||
* @see com.jamonapi.Monitor#stop |
||||
*/ |
||||
@Override |
||||
protected Object invokeUnderTrace(MethodInvocation invocation, Log logger) throws Throwable { |
||||
String name = createInvocationTraceName(invocation); |
||||
MonKey key = new MonKeyImp(name, name, "ms."); |
||||
|
||||
Monitor monitor = MonitorFactory.start(key); |
||||
try { |
||||
return invocation.proceed(); |
||||
} |
||||
catch (Throwable ex) { |
||||
trackException(key, ex); |
||||
throw ex; |
||||
} |
||||
finally { |
||||
monitor.stop(); |
||||
if (!this.trackAllInvocations || isLogEnabled(logger)) { |
||||
writeToLog(logger, "JAMon performance statistics for method [" + name + "]:\n" + monitor); |
||||
} |
||||
} |
||||
} |
||||
|
||||
/** |
||||
* Count the thrown exception and put the stack trace in the details portion of the key. |
||||
* This will allow the stack trace to be viewed in the JAMon web application. |
||||
*/ |
||||
protected void trackException(MonKey key, Throwable ex) { |
||||
String stackTrace = "stackTrace=" + Misc.getExceptionTrace(ex); |
||||
key.setDetails(stackTrace); |
||||
|
||||
// Specific exception counter. Example: java.lang.RuntimeException
|
||||
MonitorFactory.add(new MonKeyImp(ex.getClass().getName(), stackTrace, "Exception"), 1); |
||||
|
||||
// General exception counter which is a total for all exceptions thrown
|
||||
MonitorFactory.add(new MonKeyImp(MonitorFactory.EXCEPTIONS_LABEL, stackTrace, "Exception"), 1); |
||||
} |
||||
|
||||
} |
||||
@ -1,79 +0,0 @@
@@ -1,79 +0,0 @@
|
||||
/* |
||||
* Copyright 2002-2019 the original author or authors. |
||||
* |
||||
* Licensed 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 |
||||
* |
||||
* https://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.springframework.aop.interceptor; |
||||
|
||||
import com.jamonapi.MonitorFactory; |
||||
import org.aopalliance.intercept.MethodInvocation; |
||||
import org.apache.commons.logging.Log; |
||||
import org.junit.jupiter.api.AfterEach; |
||||
import org.junit.jupiter.api.BeforeEach; |
||||
import org.junit.jupiter.api.Test; |
||||
|
||||
import static org.assertj.core.api.Assertions.assertThat; |
||||
import static org.assertj.core.api.Assertions.assertThatIllegalArgumentException; |
||||
import static org.mockito.BDDMockito.given; |
||||
import static org.mockito.Mockito.mock; |
||||
|
||||
/** |
||||
* @author Steve Souza |
||||
* @since 4.1 |
||||
*/ |
||||
public class JamonPerformanceMonitorInterceptorTests { |
||||
|
||||
private final JamonPerformanceMonitorInterceptor interceptor = new JamonPerformanceMonitorInterceptor(); |
||||
|
||||
private final MethodInvocation mi = mock(MethodInvocation.class); |
||||
|
||||
private final Log log = mock(Log.class); |
||||
|
||||
|
||||
@BeforeEach |
||||
public void setUp() { |
||||
MonitorFactory.reset(); |
||||
} |
||||
|
||||
@AfterEach |
||||
public void tearDown() { |
||||
MonitorFactory.reset(); |
||||
} |
||||
|
||||
|
||||
@Test |
||||
public void testInvokeUnderTraceWithNormalProcessing() throws Throwable { |
||||
given(mi.getMethod()).willReturn(String.class.getMethod("toString")); |
||||
|
||||
interceptor.invokeUnderTrace(mi, log); |
||||
|
||||
assertThat(MonitorFactory.getNumRows() > 0).as("jamon must track the method being invoked").isTrue(); |
||||
assertThat(MonitorFactory.getReport().contains("toString")).as("The jamon report must contain the toString method that was invoked").isTrue(); |
||||
} |
||||
|
||||
@Test |
||||
public void testInvokeUnderTraceWithExceptionTracking() throws Throwable { |
||||
given(mi.getMethod()).willReturn(String.class.getMethod("toString")); |
||||
given(mi.proceed()).willThrow(new IllegalArgumentException()); |
||||
|
||||
assertThatIllegalArgumentException().isThrownBy(() -> |
||||
interceptor.invokeUnderTrace(mi, log)); |
||||
|
||||
assertThat(MonitorFactory.getNumRows()).as("Monitors must exist for the method invocation and 2 exceptions").isEqualTo(3); |
||||
assertThat(MonitorFactory.getReport().contains("toString")).as("The jamon report must contain the toString method that was invoked").isTrue(); |
||||
assertThat(MonitorFactory.getReport().contains(MonitorFactory.EXCEPTIONS_LABEL)).as("The jamon report must contain the generic exception: " + MonitorFactory.EXCEPTIONS_LABEL).isTrue(); |
||||
assertThat(MonitorFactory.getReport().contains("IllegalArgumentException")).as("The jamon report must contain the specific exception: IllegalArgumentException'").isTrue(); |
||||
} |
||||
|
||||
} |
||||
Loading…
Reference in new issue