This simple library provides a way to annotate your functions and get success, failure and call metrics for them.
- JDK - Oracle/Sun JDK 1.8+/OpenJDK 8+
- Dropwizard Metrics (Formerly called Yammer Metrics) - 3.2.2+
- Guava - 21.0+
To use this library the following need to be added to your Maven pom file.
Put this into the dependencies section of your pom file:
<dependency>
<groupId>org.aspectj</groupId>
<artifactId>aspectjrt</artifactId>
<version>1.8.13</version>
</dependency>
<dependency>
<groupId>io.appform.functionmetrics</groupId>
<artifactId>function-metrics</artifactId>
<version>1.0.5</version>
</dependency>
If you are not using guava and metrics already, then add the following as well:
<dependency>
<groupId>io.dropwizard.metrics</groupId>
<artifactId>metrics-core</artifactId>
<version>3.2.2</version>
</dependency>
<dependency>
<groupId>com.google.guava</groupId>
<artifactId>guava</artifactId>
<version>28.0-jre</version>
</dependency>
This library uses an aspect to introspect and instrument your code during compile time to inject metrics collection code.
Therefore, configuration needs to be put into your pom file in the build/plugins section to enabje aspectj weaving.
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>aspectj-maven-plugin</artifactId>
<version>1.11</version>
<dependencies>
<dependency>
<groupId>org.aspectj</groupId>
<artifactId>aspectjrt</artifactId>
<version>1.8.13</version>
</dependency>
<dependency>
<groupId>org.aspectj</groupId>
<artifactId>aspectjtools</artifactId>
<version>1.8.13</version>
</dependency>
</dependencies>
<configuration>
<complianceLevel>1.8</complianceLevel>
<source>1.8</source>
<target>1.8</target>
<showWeaveInfo>true</showWeaveInfo>
<forceAjcCompile>true</forceAjcCompile>
<sources/>
<weaveDirectories>
<weaveDirectory>${project.build.directory}/classes</weaveDirectory>
</weaveDirectories>
<verbose>true</verbose>
<Xlint>ignore</Xlint>
<aspectLibraries>
<aspectLibrary>
<groupId>io.appform.functionmetrics</groupId>
<artifactId>function-metrics</artifactId>
</aspectLibrary>
</aspectLibraries>
</configuration>
<executions>
<execution>
<phase>process-classes</phase>
<goals>
<goal>compile</goal>
</goals>
</execution>
</executions>
</plugin>
NOTE: This config uses in-place weaving of the compiled classes. Weaving can also be done during compilation, however in this mode libraries like Lombok etc will stop working.
The following information must be provided for the system to initialize.
- Prefix of the metrics: This will be prepended to the metrics being generated.
- Registry: The metrics registry to which the metrics will be pushed.
FunctionMetricsManager.initialize(<prefix>, <metricsRegistry>);
For example
FunctionMetricsManager.initialize("test", SharedMetricRegistries.getOrCreate("test-metrics"));
This is simple. Just annotate the method with @MonitoredFunction.
For example:
@MonitoredFunction
private void myFunction(int val) {
//Demo function
}
You can override the name of the class/method that will be populated in the metric.
@MonitoredFunction(className="Blah", method="randomFunction")
private void myFunction(int val) {
//Demo function
}
_NOTE: This is handy in case you want to differentiate between overloaded methods. _
To add method parameter value in metric name add @MetricTerm annotation to parameter.
This can be useful for eg - while adding tenant level metrics
@MonitoredFunction(className="Blah", method="randomFunction")
private void myFunction(@MetricTerm String tenant) {
//Demo function
}
_NOTE: You have to initialize the manager with Options to do parameter capturing. _
FunctionMetricsManager.initialize("functions", new MetricRegistry(), new Options.OptionsBuilder()
.enableParameterCapture(true)
.caseFormat(CaseFormat.UPPER_CAMEL)
.build());
Let's assume the following:
- Metric prefix: test
- Function being tested: MyClass.myFunction()
- <prefix>.<className>.<methodName>.all
- mean rate
- 1-minute rate
- 5-minute rate
- 15-minute rate
- min
- max
- mean
- stddev
- median
- 75%
- 95%
- 98%
- 99%
- 99.9%
NOTE: We consider it to be a failure if the method throws an exception
- <prefix>.<className>.<methodName>.failure
- mean rate
- 1-minute rate
- 5-minute rate
- 15-minute rate
- min
- max
- mean
- stddev
- median
- 75%
- 95%
- 98%
- 99%
- 99.9%
- <prefix>.<className>.<methodName>.success
- mean rate
- 1-minute rate
- 5-minute rate
- 15-minute rate
- min
- max
- mean
- stddev
- median
- 75%
- 95%
- 98%
- 99%
- 99.9%
test.MyClass.myFunction.all
count = 3
mean rate = 1.00 calls/second
1-minute rate = 0.00 calls/second
5-minute rate = 0.00 calls/second
15-minute rate = 0.00 calls/second
min = 0.00 milliseconds
max = 0.00 milliseconds
mean = 0.00 milliseconds
stddev = 0.00 milliseconds
median = 0.00 milliseconds
75% <= 0.00 milliseconds
95% <= 0.00 milliseconds
98% <= 0.00 milliseconds
99% <= 0.00 milliseconds
99.9% <= 0.00 milliseconds
test.MyClass.myFunction.failure
count = 1
mean rate = 0.33 calls/second
1-minute rate = 0.00 calls/second
5-minute rate = 0.00 calls/second
15-minute rate = 0.00 calls/second
min = 0.00 milliseconds
max = 0.00 milliseconds
mean = 0.00 milliseconds
stddev = 0.00 milliseconds
median = 0.00 milliseconds
75% <= 0.00 milliseconds
95% <= 0.00 milliseconds
98% <= 0.00 milliseconds
99% <= 0.00 milliseconds
99.9% <= 0.00 milliseconds
test.MyClass.myFunction.success
count = 2
mean rate = 0.65 calls/second
1-minute rate = 0.00 calls/second
5-minute rate = 0.00 calls/second
15-minute rate = 0.00 calls/second
min = 0.00 milliseconds
max = 0.00 milliseconds
mean = 0.00 milliseconds
stddev = 0.00 milliseconds
median = 0.00 milliseconds
75% <= 0.00 milliseconds
95% <= 0.00 milliseconds
98% <= 0.00 milliseconds
99% <= 0.00 milliseconds
99.9% <= 0.00 milliseconds
NOTE: This is output from Dropwizard metrics console reporter.
Apache 2
1.0.1