io.prometheus.client.spring.web

Annotation Type PrometheusTimeMethod

@Retention(value=RUNTIME)
 @Target(value=METHOD)
public @interface PrometheusTimeMethod

Enable Spring-AOP-based automated method timing for the annotated method. The timings will be recorded in a Summary with a name specified by the required name parameter, and help specified by the help parameter. To properly work, EnablePrometheusTiming must be specified somewhere in your application configuration.

  @Controller
  public class MyController {
     @RequestMapping("/")
     @ResponseBody
     @PrometheusTimeMethod(name = "my_method_seconds", help = "The number of seconds taken by the main handler")
    public Object handleRequest() {
      // Each invocation will be timed and recorded.
      return database.withCache().get("some_data");
    }
  }
 

Author:

Andrew Stuart

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	help The help message to show in prometheus metrics
String	name The metric name to use for recording latencies

Element Detail

name

public abstract String name

The metric name to use for recording latencies

Returns:

A metric name specific to your use case.

help

public abstract String help

The help message to show in prometheus metrics

Returns:

A help string