环境
我正在运行许多使用Servlet的应用程序,包括那些基于JSF和JAX-WS的应用程序以及我自己的一些自定义servlet。我使用Tomcat7.x作为我的web容器。我使用java.util.logging来记录消息。
现状
对于记录异常,我一直在使用SMTPHandler,它运行得非常好。以下是我的logging.properties文件的相关摘录:
handlers = {... other handlers ...},08SMTP.smtphandler.SMTPHandler
08SMTP.smtphandler.SMTPHandler.level=SEVERE
08SMTP.smtphandler.SMTPHandler.smtpHost=smtp.somedomain.com
08SMTP.smtphandler.SMTPHandler.to=developers@somedomain.com
08SMTP.smtphandler.SMTPHandler.from=developers@somedomain.com
08SMTP.smtphandler.SMTPHandler.subject=MyApplication error message
08SMTP.smtphandler.SMTPHandler.bufferSize=512
08SMTP.smtphandler.SMTPHandler.formatter=java.util.logging.SimpleFormatter
此设置的唯一问题是电子邮件只包含一个异常。没有关于发生错误的上下文的其他信息。
我想看什么
我希望电子邮件包含来自ServletRequest
/HttpServletRequest
对象的其他上下文信息,例如:
- 登录的用户是谁
- 请求的queryString、URL、URI、ContextPath、Servlet路径和getMethod是什么
- 标头参数是什么
- 参数是什么
- 属性名称/值是什么
尝试的解决方案
由logging.properties
文件配置的日志Handler
除了通过静态变量之外,无法访问应用程序的其他部分,所以我想尝试用程序创建一个日志Handler
。我试图制作一个处理程序,但它无法了解异常发生时活动的HttpServletRequest
。
我尝试创建自己的类来实现ServletRequestListener
和ServletContextListener
,然后注册一个知道ThreadLocal<ServletRequest>
变量的自定义日志Handler
,然后在ServletRequestListener
中设置并清除该ThreadLocal
变量。在我的web.xml
文件中添加了一个正确调用contextInitialized
和requestInitialized
的<listener>
引用后,当异常发生时,我的日志处理程序的publish
方法永远不会被调用。
代码在这里。
public class LoggingWebListener
implements ServletRequestListener, ServletContextListener
{
public static class FtSmtpHandler
extends Handler
{
private final ServletContext sc;
private final ThreadLocal<ServletRequest> servletReqLocal;
public FtSmtpHandler(ServletContext servletContext, ThreadLocal<ServletRequest> servletReqLocal)
{
this.sc = servletContext;
this.servletReqLocal = servletReqLocal;
}
@Override public void publish(LogRecord record)
{
if (record.getLevel().intValue() < Level.WARNING.intValue())
return;
// Don't try to send email if the emailer fails and logs an exception
if (record.getLoggerName().equals(MyEmailHelper.class.getName()))
return;
// CODE TO SEND EMAIL GOES HERE
}
@Override public void flush()
{
}
@Override public void close()
throws SecurityException
{
}
}
public static final Logger glogger = Logger.getGlobal();
public static final Logger logger = Logger.getLogger(LoggingWebListener.class.getName());
private final ThreadLocal<ServletRequest> servletReqLocal = new ThreadLocal<>();
private FtSmtpHandler handler;
public LoggingWebListener()
{
}
@Override public void contextInitialized(ServletContextEvent evt)
{
logger.log(Level.INFO, "Initializing context for " + getClass().getName());
ServletContext servletContext = evt.getServletContext();
handler = new FtSmtpHandler(servletContext, servletReqLocal);
glogger.addHandler(handler);
}
@Override public void contextDestroyed(ServletContextEvent arg0)
{
glogger.removeHandler(handler);
handler = null;
}
@Override public void requestInitialized(ServletRequestEvent evt)
{
ServletRequest servletRequest = evt.getServletRequest();
// logger.log(Level.INFO, "Initializing request for request " + servletRequest);
servletReqLocal.set(servletRequest);
}
@Override public void requestDestroyed(ServletRequestEvent evt)
{
servletReqLocal.remove();
}
}
我做的事情有什么小错误吗?这是完全错误的做法吗?是否有一个现有的模块可以做我想做的事情,但我还没有找到?还有别的办法做我想做的事吗?
这篇文章提出了一种类似于我所采取的方法,但没有详细信息。
创建一个自定义servlet过滤器,该过滤器将为应用程序的所有调用触发。然后创建一个自定义格式化程序,它知道如何格式化请求的属性。在过滤器中,捕获当前请求并将其发送到SMTPHandler上安装的自定义格式化程序,以获得对请求对象的访问权限。
public class RequestContextFilter implements javax.servlet.Filter {
private static final String CLASS_NAME = MdcFilter.class.getName();
private static final Logger logger = Logger.getLogger("");
private volatile Handler emailer;
@Override
public void init(FilterConfig filterConfig) throws ServletException {
emailer = new SMTPHandler();
//etc...
emailer.setFormatter(new ContextFormatter());
logger.addHandler(emailer);
}
@Override
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
ContextFormatter.CTX.set(request);
try {
chain.doFilter(request, response);
} finally {
ContextFormatter.CTX.remove();
}
}
@Override
public void destroy() {
logger.removeHandler(emailer);
emailer.close();
}
private static class ContextFormatter extends Formatter {
static final ThreadLocal<ServletRequest> CTX = new ThreadLocal();
private final Formatter txt = new SimpleFormatter();
@Override
public String format(LogRecord record) {
HttpServletRequest req = (HttpServletRequest) CTX.get();
return req.getRequestURI() + " " + txt.format(record);
}
}
}
由于这是使用本地线程,因此如果记录器和筛选器之间存在线程切换,它将不起作用。