パッケージ org.terasoluna.gfw.web.logging

クラス TraceLoggingInterceptor

java.lang.Object

org.terasoluna.gfw.web.logging.TraceLoggingInterceptor

すべての実装されたインタフェース:

org.springframework.web.servlet.HandlerInterceptor

public class TraceLoggingInterceptor
extends Object
implements org.springframework.web.servlet.HandlerInterceptor

Interceptor for log output of performance measurement

Interceptor which performs log output for the purpose of measurement of logic execution performance.
Displays logic execution time from start to end in nano seconds.

If end time is more than nano-seconds defined in warnHandlingNanos (default is 3000000000), then warning log is output.

Below is usage example

Example of bean definition which should be loaded by org.springframework.web.servlet.DispatcherServlet

  <mvc:interceptors>
      ....
      <mvc:interceptor>
          <mvc:mapping path="/**" />
              <bean class="org.terasoluna.gfw.web.logging.TraceLoggingInterceptor">
              <property name="warnHandlingNanos" value="5000000000" />
          </bean>
      </mvc:interceptor>
      ....
  </mvc:interceptors>
 

Set TraceLoggingInterceptor as definition of interceptor class.
By specifying nano-seconds in value of warnHandlingNanos, timing of warning log output can be changed.

コンストラクタの概要

コンストラクタ

コンストラクタ	説明
TraceLoggingInterceptor()

メソッドの概要

修飾子とタイプ	メソッド	説明
protected static String	buildMethodParams(org.springframework.web.method.HandlerMethod handlerMethod)	convert parameter names of the method into a String value
void	postHandle(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, Object handler, org.springframework.web.servlet.ModelAndView modelAndView)	Logic to output end log
boolean	preHandle(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, Object handler)	Logic to output start log
void	setWarnHandlingNanos(long warnHandlingNanos)	Set warnHandlingNanos Setter method for the value of warning log output timing in nano-seconds

クラスから継承されたメソッド java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

インタフェースから継承されたメソッド org.springframework.web.servlet.HandlerInterceptor

afterCompletion

コンストラクタの詳細

TraceLoggingInterceptor

public TraceLoggingInterceptor()

メソッドの詳細

preHandle

public boolean preHandle(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response,
 Object handler)

Logic to output start log

Outputs the start log and sets start time (in nano-seconds) in HttpServletRequest

定義:

preHandle インタフェース内 org.springframework.web.servlet.HandlerInterceptor

関連項目:

• org.springframework.web.servlet.handler.HandlerInterceptorAdapter#preHandle(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, java.lang.Object)

postHandle

public void postHandle(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response,
 Object handler,
 org.springframework.web.servlet.ModelAndView modelAndView)

Logic to output end log

Outputs the end log.
Outputs warning log if difference of time between start time and end time is more than the nano-seconds value
set as warning log output timing.

定義:

postHandle インタフェース内 org.springframework.web.servlet.HandlerInterceptor

関連項目:

• org.springframework.web.servlet.handler.HandlerInterceptorAdapter#postHandle(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, java.lang.Object, org.springframework.web.servlet.ModelAndView)

buildMethodParams

protected static String buildMethodParams(org.springframework.web.method.HandlerMethod handlerMethod)

convert parameter names of the method into a String value

パラメータ:

handlerMethod - Target methods of interceptor

戻り値:

String parameter string

setWarnHandlingNanos

public void setWarnHandlingNanos(long warnHandlingNanos)

Set warnHandlingNanos
Setter method for the value of warning log output timing in nano-seconds

パラメータ:

warnHandlingNanos - the value of warning log output timing in nano-seconds