diff options
author | Diego <diegolparra@gmail.com> | 2015-02-07 14:26:26 -0300 |
---|---|---|
committer | Diego <diegolparra@gmail.com> | 2015-03-01 18:44:04 -0300 |
commit | 2cc7eeee6fe31a4dfd479f3c0abf1085c7bbf879 (patch) | |
tree | ba75d454858f4d020e79b084c5166e300962a437 /kamon-annotation/src/main/java/kamon/annotation/MinMaxCount.java | |
parent | 0f2f2be4e4fc44a512ed79ab09f0d83d3fd0e871 (diff) | |
download | Kamon-2cc7eeee6fe31a4dfd479f3c0abf1085c7bbf879.tar.gz Kamon-2cc7eeee6fe31a4dfd479f3c0abf1085c7bbf879.tar.bz2 Kamon-2cc7eeee6fe31a4dfd479f3c0abf1085c7bbf879.zip |
! kamon-annotation: defined instruments @Trace @Segment @Gauge @Timed @Counted @Histogram and full implemetation
Diffstat (limited to 'kamon-annotation/src/main/java/kamon/annotation/MinMaxCount.java')
-rw-r--r-- | kamon-annotation/src/main/java/kamon/annotation/MinMaxCount.java | 71 |
1 files changed, 71 insertions, 0 deletions
diff --git a/kamon-annotation/src/main/java/kamon/annotation/MinMaxCount.java b/kamon-annotation/src/main/java/kamon/annotation/MinMaxCount.java new file mode 100644 index 00000000..ed2a6f6e --- /dev/null +++ b/kamon-annotation/src/main/java/kamon/annotation/MinMaxCount.java @@ -0,0 +1,71 @@ +/* + * ========================================================================================= + * Copyright © 2013-2015 the kamon project <http://kamon.io/> + * + * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software distributed under the + * License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, + * either express or implied. See the License for the specific language governing permissions + * and limitations under the License. + * ========================================================================================= + */ + +package kamon.annotation; + +import java.lang.annotation.*; + +/** + * A marker annotation to define a method as a MinMaxCounter. + * <p> + * <p> + * Given a method like this: + * <pre><code> + * {@literal @}MinMaxCount(name = "coolName", tags="${'my-cool-tag':'my-cool-value'}") + * public String coolName(String name) { + * return "Hello " + name; + * } + * </code></pre> + * <p> + * <p> + * A {@link kamon.metric.instrument.MinMaxCounter MinMaxCounter} for the defining method with the name {@code coolName} will be created and each time the + * {@code #coolName(String)} method is invoked the counter is decremented when the method returns, + * counting current invocations of the annotated method. + */ +@Documented +@Target(ElementType.METHOD) +@Retention(RetentionPolicy.RUNTIME) +public @interface MinMaxCount { + + /** + * @return The MinMaxCounter's name. + * <p> + * Also, the Metric name can be resolved with an EL expression that evaluates to a String: + * <p> + * <pre> + * {@code + * class MinMaxCounted { + * private long id; + * + * public long getId() { return id; } + * + * {@literal @}MinMaxCount (name = "${'counterID:' += this.id}") + * void countedMethod() {} // create a counter with name => counterID:[id] + * } + * } + * </pre> + */ + + String name(); + + /** + * Tags are a way of adding dimensions to metrics, + * these are constructed using EL syntax e.g. "${'algorithm':'1','env':'production'}" + * + * @return the tags associated to the counter + */ + String tags() default ""; +} |