Codahale指标：在普通Java中使用@Timed指标注释

Question

我正在尝试使用codahale指标将指标添加到普通Java应用程序。 我想使用@Timed注释，但我不清楚它使用哪个MetricRegistry，或者如何告诉它使用哪个MetricRegistry。 该应用程序是一个普通的Java 8应用程序，使用Maven 3构建，没有Spring，没有Hibernate。

我在dropwizard文档中找不到有关如何实现@Timed的任何文档： https ：//dropwizard.github.io/metrics/3.1.0/manual/

我添加了这些依赖项：

<dependency>
  <groupId>io.dropwizard.metrics</groupId>
  <artifactId>metrics-core</artifactId>
  <version>3.1.0</version>
</dependency>
<dependency>
  <groupId>com.codahale.metrics</groupId>
  <artifactId>metrics-annotation</artifactId>
  <version>3.0.2</version>
</dependency>

当我使用对Timer的编程调用时，我可以获得报告，因为我知道使用了哪些MetricsRegistry：

static final MetricRegistry metrics = new MetricRegistry();
private void update() throws SQLException {
  Timer.Context time = metrics.timer("domainobject.update").time();
  try {
    [...]
  } finally {
    time.stop();
  }
}

但是当我使用更优雅的@Timed注释时，我不知道使用了哪个注册表，因此我无法创建一个记者，这意味着我无法报告指标（我甚至不确定这是否确实任何东西）：

@Timed(name = "domainobject.update")
private void update() throws SQLException {
    [...]
}

请告知如何使@Timed和其他Metrics注释在常规Java应用程序中工作。

附加信息：我发现这个奇怪的原因是我添加了Lombok框架和@ Slf4j注释确实有效。 我在maven pom.xml中添加了Lombok作为依赖项：

<dependency>
  <groupId>org.projectlombok</groupId>
  <artifactId>lombok</artifactId>
  <version>1.14.8</version>
</dependency>

我可以使用@ Sl4fj类注释向类中添加一个记录器，而不会使成员变量混乱：

@Slf4j
public class App {
  public void logsome(){
    log.info("Hello there");
  }
}

因此，如果只通过添加依赖项就可以实现，我认为我只是缺少一个依赖项或配置来获取codahale @Timed注释工作，如上所述。

（顺便说一句，看看龙目岛，它会让你的生活更轻松： http ： //projectlombok.org/ ）

Answer 1

长话短说，如果没有某种AOP（无论是Spring AOP还是AspectJ），都不能使用@Timed 。

一两个星期前，我还决定为我们的项目添加指标，并选择AspectJ来完成这项任务（主要是因为我过去使用它来达到类似的目的，因为它允许编译时编织，而Spring只允许通过代理运行时） 。

您应该能够在此处找到所有必要的信息和说明： https ： //github.com/astefanutti/metrics-aspectj 。

至于Lombok，我猜他们使用内置的javac注释处理器：

另一个争论点是实现支持IDE集成的代码以及javac注释处理器。 这两个项目Lombok都利用非公共API来完成他们的巫术。 这意味着使用后续IDE或JDK版本可能会破坏Project Lombok的风险。

Answer 2

如果您在容器内并使用Dropwizard的一个检测库，那么使用@Timed实际上并不需要使用AOP，就像之前在评价最高的答案中所声称的那样。 例如，请参阅Jersey 2.x模块，如果您阅读了源代码 ，您可以看到它使用反射（就像我看到的其他人一样）。

您可以在相应的“ Instrumenting ____ ”项目符号下的Dropwizard文档中阅读所有这些模块。

我理解OP明确地不在这样的容器中工作，但是我想提供这个信息，因为我们许多寻找这个答案的人可能正在研究一种可以在其运行时环境中注册这些资源的现代Web服务。

Answer 3

使用从应用程序类的initialize方法中的bootstrap参数访问的内置MetricRegistry。

@Override
public void initialize(final Bootstrap<Configuration> bootstrap) {
    final JmxReporter reporter = JmxReporter.forRegistry(bootstrap.getMetricRegistry()).build();
    reporter.start();
}

Answer 4

正如另一个答案所述，你必须在应用程序中有一些东西来监听你的实例化类并检查它们的@Timed注释。

如果您使用的是Guice，可以使用： https ： //github.com/palominolabs/metrics-guice

Answer 5

一般而言，AOP过度使用并不适合使用@timed。

默认度量标准注册表将@timed指标写入ConcurrentHashMap，并且不附加任何有意义的侦听器。

DropWizard Bootstrap构造函数：

/**
 * Creates a new {@link Bootstrap} for the given application.
 * @param application a Dropwizard {@link Application}
 */
public Bootstrap(Application<T> application) {
    this.application = application;
    this.objectMapper = Jackson.newObjectMapper();
    this.bundles = Lists.newArrayList();
    this.configuredBundles = Lists.newArrayList();
    this.commands = Lists.newArrayList();
    this.validatorFactory = Validators.newValidatorFactory();


    // returns new ConcurrentHashMap<String, Metric>(); 
    this.metricRegistry = new MetricRegistry(); 


    this.configurationSourceProvider = new FileConfigurationSourceProvider();
    this.classLoader = Thread.currentThread().getContextClassLoader();
    this.configurationFactoryFactory = new DefaultConfigurationFactoryFactory<T>();
}

因此，您需要构建/启动/注册相应的度量标准注册表才能查看结果。

在这里我使用JMX：

@Override
public void initialize(Bootstrap<PayloadStorageConfiguration> bootstrap) {
    JmxReporter.forRegistry(bootstrap.getMetricRegistry()).build().start();
}

这就是你需要做的。

以下是输出示例（针对Java应用程序/服务器运行jconsole以查看JMX结果）：

Answer 6

在较新的版本Dropwizard（我使用0.9.2），你可以访问默认MetricRegistry通过设置环境io.dropwizard.setup.Environment 。 此默认MetricRegistry已经有一个与之关联的InstrumentedResourceMethodApplicationListener ，它会侦听您资源的所有指标。

如果您已将JerseyEnvironment注册为资源，

environment.jersey().register(resource);

您只需要使用@Timed ， @Metered或@ExceptionMetered注释您的资源方法（或类）以注册相应的指标。

@POST
@Timed
public String show() {
    return "yay";
}

您可以将Reporter （如Slf4jReporter或JmxReporter ）分配给默认的MetricRegistry如下所示

Slf4jReporter.forRegistry(environment.metrics()).build();

作为快速测试以查看您的指标是否实际已注册，您可以在测试环境中对URL http://localhost:8081/metrics或相应的管理指标URL进行GET调用。

其他一些版本要求您显式注册InstrumentedResourceMethodApplicationListener ，如本Doc所示

Answer 7

你也可以使用stagemonitor-core。 请参阅此处和此处的文档。 优点是stagemonitor（免费和开源btw）不依赖于任何基于容器的AOP，如Spring AOP或EJB拦截器。 它通过运行时附件使用字节码操作，这意味着您甚至不必向应用程序启动添加-javaagent标志 - 普通依赖就足够了。

如果要在Web应用程序或远程EJB应用程序中测量执行时间，则甚至不必手动注释代码。 此外，stagemonitor还提供预配置的Grafana和Kibana仪表板。

免责声明：我是stagemonitor的开发者之一

Answer 8

这个简单/正确的示例https://karollotkowski.wordpress.com/2015/10/19/api-endpoint-in-one-minute-with-dropwizard/只是显示它只需要注释