【问题标题】:How do I update the "to" addresses on an SMTPAppender in Logback?如何在 Logback 中更新 SMTPAppender 上的“to”地址?
【发布时间】:2012-07-24 18:02:59
【问题描述】:

我正在创建一个管理页面,其中有几个我想即时设置的 logback 属性,其中一个是我发送系统警报的管理电子邮件。 SMTPAppender 的 api 具有添加到“to”地址列表或将它们作为列表获取的方法,但我没有找到任何要清除、删除或更新它们的方法。我该怎么做?

我目前看到两个选项:

  1. 一种选择是删除附加程序并使用新属性创建一个新附加程序(糟糕)。
  2. 弄清楚如何直接通过 Joran 进行配置(可能是恶心?)。

我正在推进(2),但如果有更好的方法,请发布。

【问题讨论】:

    标签: java logging logback smtpappender


    【解决方案1】:

    也许你已经完成了这个,但我只需要找到一种方法来设置动态“到”地址,这个主题引导我找到方法(感谢@gresdiplitude 关于系统属性和 MDC 值的想法),所以我正在分享我的解决方案。

    我正在使用SMTPAppender 发送小的执行报告,但这些需要发送到不同的邮箱。解决方案看起来很糟糕,或者至少我对结果非常满意。

    我的 logback.xml:

    <!-- this is the trick: a converter to use on the "to" field pattern -->
    <conversionRule conversionWord="smtpTo" converterClass="com.example.logback.MyConverter" />
    <appender name="SMTP" class="ch.qos.logback.classic.net.SMTPAppender">
        <!-- a filter to select just the log entries that will be sent by mail -->
        <filter class="com.example.logback.MyFilter" />
        <!-- an evaluator, mine is like CounterBasedEvaluator from the manual:
            http://logback.qos.ch/xref/chapters/appenders/mail/CounterBasedEvaluator.html
        -->
        <evaluator class="com.example.logback.MyEvaluator">
            <limit>25</limit>
        </evaluator>
        <!-- a discriminator to create a cyclic buffer for each mailing group I need -->
        <discriminator class="com.example.logback.MyDiscriminator" />
        <!-- just matching buffer size to evaluator limit -->
        <cyclicBufferTracker class="ch.qos.logback.core.spi.CyclicBufferTrackerImpl">
            <bufferSize>25</bufferSize>
        </cyclicBufferTracker>
        <smtpHost>${smtp.host}</smtpHost>
        <smtpPort>${smtp.port}</smtpPort>
        <SSL>${smtp.ssl}</SSL>
        <username>${smtp.username}</username>
        <password>${smtp.password}</password>
        <from>${smtp.from}</from>
    
        <!-- here you use the converter: in this case will get data
            from marker containing the destination addresses
        -->
        <to>%smtpTo</to>
        <subject>my subject</subject>
        <layout class="ch.qos.logback.classic.PatternLayout">
            <pattern>%date: %message%n%xThrowable{full}</pattern>
        </layout>
    </appender>
    

    MyFilter.java:

    public FilterReply decide(ILoggingEvent event) {
        return event.getMarker() != null
                && event.getMarker().contains("REPORT") ? FilterReply.ACCEPT
                : FilterReply.DENY;
    }
    

    MyDiscriminator.java:

    public String getDiscriminatingValue(ILoggingEvent e) {
        Marker marker = e.getMarker();
        if (marker == null || !(marker instanceof MyMarker)) {
            return null;
        }
        return ((MyMarker) marker).getDiscriminatingValue();
    }
    

    MyConverter.java:

    public class MyConverter extends ClassicConverter {
    
        @Override
        public String convert(ILoggingEvent event) {
            Marker marker = event.getMarker();
            if (marker == null || !(marker instanceof MyMarker)) {
                return null;
            }
            return ((MyMarker) marker).getSmtpTo();
        }
    }
    

    MyMarker.java:

    public interface MyMarker extends Marker {
        // a list of destination addresses, like "a@c.com, x@y.net"
        String getSmtpTo();
        // an "id" to tell the buffers apart, could be "smtpTo" itself
        // but in my case it would mix different reports that goes to the same addresses
        String getDiscriminatingValue();
    }
    

    我刚刚为 MyMarker 创建了一个实现,并在每个应该报告的日志语句中使用了它的几个实例:

    // suggestion: make the marker immutable, then you can store and reuse them instead of recreating them every time
    Marker marker1 = new MyMarkerImpl(
        "REPORT", // marker name
        "me@company.com, joe@company.com", // smtpTo
        "alertGroup"); // discriminatingValue
    logger.warn(marker1, "SNAFU");
    Marker marker2 = new MyMarkerImpl(
        "REPORT", "boss@company.com, ceo@company.com", "phbGroup");
    logger.info(marker2, "Everything is fine");
    // here we have same smtpTo as above but different discriminatingValues, so this will be sent in another email/report
    Marker marker3 = new MyMarkerImpl(
        "REPORT", "me@company.com, joe@company.com", "bugFixingGroup");
    logger.error(marker3, "Why things gone bad", exception);
    

    希望对你有用。

    【讨论】:

    • 这很棒。此功能的实施已被推迟,认为最终会实施更好的方法,或者发布解决方法。目前,我认为这是最好的方法。但是,我有一个枚举,它与存储在其中的应用程序中的所有“活动”标记一起使用。我会让标记可变,但只有一个实例。
    • @Noremac 这是一种简单的方法,但是我不喜欢任何类型的可变枚举。如果您的应用程序是多线程的、Web 应用程序根据用户请求触发 SMTP 日志记录或集群环境,它也可能导致您出现竞争条件问题。我的方法通常是创建不可变的标记来包装分离的简单标记,并在需要时存储它们。很高兴知道这可能对您有用 =)
    【解决方案2】:

    我能想到的另外两个选择:

    1/ 将更新的地址设置为系统属性,并配置SMTPAppender 以使用系统属性评估 smtpTo 地址,如下所示

    <to>%property{smtpTo}</to> 
    

    或者 2/在数据库/系统属性的某处设置更新的地址。将每个线程的 smtpTo 地址放入 MDC,并配置 SMTPAppender 以像这样从 MDC 获取它

    <to>%X{smtpTo}</to>
    

    【讨论】:

      【解决方案3】:

      我是这样做的:

      smtpappender.getToList().clear();
      

      【讨论】:

      • 谢谢,我试图清除 getToAsListOfString 但没有用。
      猜你喜欢
      • 2014-09-03
      • 1970-01-01
      • 2010-12-31
      • 1970-01-01
      • 2012-06-11
      • 2016-12-28
      • 2012-04-20
      • 1970-01-01
      • 1970-01-01
      相关资源
      最近更新 更多