Dropwizard 0.9.1：在自定义AppenderFactory实现中使用应用程序配置值

Question

我正在基于Dropwizard v0.9.1构建一个web堆栈。堆栈中的所有日志都通过AppenderFactory接口的自定义实现发送到Loggly:

@JsonTypeName("loggly")
public class LogglyAppenderFactory extends AbstractAppenderFactory {
    @JsonProperty
    private String token;

    @JsonProperty
    private final Optional<String> tag = Optional.absent();

    @Override
    public Appender<ILoggingEvent> build(LoggerContext context, String applicationName, Layout<ILoggingEvent> layout) {
        ...
    }

    protected Layout<ILoggingEvent> buildLayout(LoggerContext context) {
        ...
    }
}

此类未在我的应用程序类中的环境中注册。相反，它似乎是Dropwizard基于@JsonTypeName注释自动连接的。尽管如此，token和tag字段由出现在我的配置yaml文件中的值填充：

logging:
    level: INFO
    appenders:
        # send logs to loggly
        - type: loggly
          threshold: INFO
          token: "my-secret-loggly-token"
          tag: "webservice-ci"

问题是，这些配置值不会出现在应用程序的配置类中，这意味着在构建其他资源或运行状况检查时，我无法重用它们。

理想情况下，我希望手动注册＜code＞LogglyAppenderFactory

 public class WebServiceApplication extends Application<WebServiceAppConfiguration> {
    @Override
    public void run(WebServiceAppConfiguration configuration, Environment environment) throws Exception {
        final HttpClient httpClient = new HttpClientBuilder(environment).using(configuration.getHttpClientConfiguration()).build("httpClient");

        // to be clear, environment.logAppenders() doesn't exist, and this doesn't work
        final LogglyAppenderFactory logglyAppenderFactory = new LogglyAppenderFactoryBuilder(configuration).build();
        environment.logAppenders().register(logglyAppenderFactory)

        // when we make this HealthCheck, it would be cool to reference the same config values that the AppenderFactory used
        final LogglyHealthCheck logglyHealthCheck = new LogglyHealthCheck(httpClient, configuration);
        environment.healthChecks().register("Loggly", logglyHealthCheck);
    }
}

以便LoggleAppenderFactory和LoggleHealthCheck都可以使用相同的配置值来指示它们如何与外部服务通信。

我怀疑，如果我引入一个依赖注入框架，如Google Guice，并使用它将应用程序配置注入到两个对象中，这可能是可能的，但另一方面，由于logback appender通常是在应用程序生命周期的早期创建的，我不知道Guice是否会在创建AppenderFactory时准备就绪。

有人知道怎么做吗？如果不是，我是否要将令牌放入配置文件两次？在＜code＞日志记录中执行一次。附录部分，以及LogglyHealthCheck可以访问的其他部分？

Answer 1

事实证明，配置类公开了一个包含日志配置的LoggingFactory。我将这个助手方法添加到我的配置类中，该类从自定义AppenderFactory中提取我关心的字段：

/**
 * Extracts the Loggly token from the logging.appenders section of the configuration file.
 * If a {@link LogglyAppenderFactory} is not specified as one of the log appenders, this method returns null.
 * @return the Loggly token or null if no token is specified
 */
public String getLogglyToken() {
    final DefaultLoggingFactory loggingFactory = (DefaultLoggingFactory) getLoggingFactory();
    for (final AppenderFactory appenderFactory : loggingFactory.getAppenders()) {
        if (appenderFactory instanceof LogglyAppenderFactory) {
            final LogglyAppenderFactory logglyAppenderFactory = (LogglyAppenderFactory) appenderFactory;
            return logglyAppenderFactory.getToken();
        }
    }
    return null;
}

它不漂亮，但它有效！

Answer 2

我想你在找

configuration.getLoggingFactory();

此API为您提供配置文件中的所有日志配置。

如。

configuration.getLoggingFactory().getLevel();

configuration.getLoggingFactory().getAppenders()

((ConsoleAppenderFactory)configuration.getLoggingFactory().getAppenders().get(0)).getLogFormat();

不是最漂亮的API，但它应该工作