diff options
Diffstat (limited to 'kamon-annotation/src/main/java/kamon/annotation')
8 files changed, 577 insertions, 0 deletions
diff --git a/kamon-annotation/src/main/java/kamon/annotation/Count.java b/kamon-annotation/src/main/java/kamon/annotation/Count.java new file mode 100644 index 00000000..09bea4ec --- /dev/null +++ b/kamon-annotation/src/main/java/kamon/annotation/Count.java @@ -0,0 +1,69 @@ +/* + * ========================================================================================= + * 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 Counter. + * <p> + * <p> + * Given a method like this: + * <pre><code> + * {@literal @}Count(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.Counter Counter} for the defining method with the name {@code coolName} will be created and each time the + * {@code #coolName(String)} method is invoked, the counter will be incremented. + */ +@Documented +@Target(ElementType.METHOD) +@Retention(RetentionPolicy.RUNTIME) +public @interface Count { + + /** + * @return The counter's name. + * <p> + * Also, the Metric name can be resolved with an EL expression that evaluates to a String: + * <p> + * <pre> + * {@code + * class Counted { + * private long id; + * + * public long getId() { return id; } + * + * {@literal @}Count (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 ""; +} diff --git a/kamon-annotation/src/main/java/kamon/annotation/EnableKamon.java b/kamon-annotation/src/main/java/kamon/annotation/EnableKamon.java new file mode 100644 index 00000000..97ed9375 --- /dev/null +++ b/kamon-annotation/src/main/java/kamon/annotation/EnableKamon.java @@ -0,0 +1,27 @@ +/* + * ========================================================================================= + * 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 for enable the Kamon instrumentation. + */ +@Documented +@Retention(RetentionPolicy.RUNTIME) +@Target({ElementType.TYPE}) +public @interface EnableKamon {} diff --git a/kamon-annotation/src/main/java/kamon/annotation/Histogram.java b/kamon-annotation/src/main/java/kamon/annotation/Histogram.java new file mode 100644 index 00000000..7c163104 --- /dev/null +++ b/kamon-annotation/src/main/java/kamon/annotation/Histogram.java @@ -0,0 +1,89 @@ +/* + * ========================================================================================= + * 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 Histogram. + * <p> + * <p> + * Given a method like this: + * <pre><code> + * {@literal @}0Histogram(name = "coolName", tags="${'my-cool-tag':'my-cool-value'}") + * public (Long|Double|Float|Integer) coolName() { + * return someComputation(); + * } + * </code></pre> + * <p> + * <p> + * A {@link kamon.metric.instrument.Histogram Histogram} for the defining method with the name {@code coolName} will be created which uses the + * annotated method's return as its value. + */ +@Documented +@Target(ElementType.METHOD) +@Retention(RetentionPolicy.RUNTIME) +public @interface Histogram { + + /** + * @return The histogram's name. + * <p> + * Also, the Metric name can be resolved with an EL expression that evaluates to a String: + * <p> + * <pre> + * {@code + * class ClassWithHistogram { + * private long id; + * + * public long getId() { return id; } + * + * {@literal @}Histogram (name = "${'histoID:' += this.id}") + * void countedMethod() {} // create a histogram with name => histoID:[id] + * } + * } + * </pre> + */ + String name(); + + /** + * The lowest value that can be discerned (distinguished from 0) by the histogram.Must be a positive integer that + * is >= 1. May be internally rounded down to nearest power of 2. + */ + long lowestDiscernibleValue() default 1; + + + /** + * The highest value to be tracked by the histogram. Must be a positive integer that is >= (2 * lowestDiscernibleValue). + * Must not be larger than (Long.MAX_VALUE/2). + */ + long highestTrackableValue() default 3600000000000L; + + /** + * The number of significant decimal digits to which the histogram will maintain value resolution and separation. + * Must be a non-negative integer between 1 and 3. + */ + int precision() default 2; + + + /** + * 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 histogram + */ + String tags() default ""; +}
\ No newline at end of file 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 ""; +} diff --git a/kamon-annotation/src/main/java/kamon/annotation/Segment.java b/kamon-annotation/src/main/java/kamon/annotation/Segment.java new file mode 100644 index 00000000..8d69e84a --- /dev/null +++ b/kamon-annotation/src/main/java/kamon/annotation/Segment.java @@ -0,0 +1,78 @@ +/* + * ========================================================================================= + * 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 start a new Segment. + * <p> + * <p> + * Given a method like this: + * <pre><code> + * {@literal @}Segment("coolSegmentName", tags="${'my-cool-tag':'my-cool-value'}") + * public String coolName(String name) { + * return "Hello " + name; + * } + * </code></pre> + * <p> + * <p> + * A new Segment will be created only if in the moment of the method execution exist a TraceContext. + */ +@Documented +@Target(ElementType.METHOD) +@Retention(RetentionPolicy.RUNTIME) +public @interface Segment { + + /** + * @return The Segment's name. + * <p> + * Also, the Segment name can be resolved with an EL expression that evaluates to a String: + * <p> + * <pre> + * {@code + * class Segment { + * private long id; + * + * public long getId() { return id; } + * + * {@literal @}Segment (name = "${'segmentID:' += this.id}") + * void segment() {} // create a Segment with name => segmentID:[id] + * } + * } + * </pre> + */ + String name(); + + /** + * @return The Segment's category. + */ + String category(); + + /** + * @return The Segment's library. + */ + String library(); + + /** + * 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 segment + */ + String tags() default ""; +} diff --git a/kamon-annotation/src/main/java/kamon/annotation/Time.java b/kamon-annotation/src/main/java/kamon/annotation/Time.java new file mode 100644 index 00000000..a8e3a62c --- /dev/null +++ b/kamon-annotation/src/main/java/kamon/annotation/Time.java @@ -0,0 +1,57 @@ +/* + * ========================================================================================= + * 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.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; + + +/** + * A marker annotation to define a method as a timed. + * <p> + * <p> + * Given a method like this: + * <pre><code> + * {@literal @}Timed(name = "coolName", tags="""${{'my-cool-tag':'my-cool-value'}}""") + * public String coolName(String name) { + * return "Hello " + name; + * } + * </code></pre> + * <p> + * <p> + * A histogram for the defining method with the name {@code coolName} will be created and each time the + * {@code #coolName(String)} method is invoked, the latency of execution will be recorded. + */ +@Target(ElementType.METHOD) +@Retention(RetentionPolicy.RUNTIME) +public @interface Time { + /** + * @return The histogram's name. + */ + 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 histogram + */ + String tags() default ""; +} diff --git a/kamon-annotation/src/main/java/kamon/annotation/Trace.java b/kamon-annotation/src/main/java/kamon/annotation/Trace.java new file mode 100644 index 00000000..1f373fa2 --- /dev/null +++ b/kamon-annotation/src/main/java/kamon/annotation/Trace.java @@ -0,0 +1,69 @@ +/* + * ========================================================================================= + * 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 start a new Trace. + * <p> + * <p> + * Given a method like this: + * <pre><code> + * {@literal @}Trace("coolTraceName", tags="${'my-cool-tag':'my-cool-value'}") + * public String coolName(String name) { + * return "Hello " + name; + * } + * </code></pre> + * <p> + * <p> + * A new Trace will be created for the defining method with the name each time the + * {@code #coolName(String)} method is invoked. + */ + +@Documented +@Target(ElementType.METHOD) +@Retention(RetentionPolicy.RUNTIME) +public @interface Trace { + /** + * @return The Trace's name. + * <p> + * Also, the Trace name can be resolved with an EL expression that evaluates to a String: + * <p> + * <pre> + * {@code + * class Traced { + * private long id; + * + * public long getId() { return id; } + * + * {@literal @}Trace (name = "${'traceID:' += this.id}") + * void countedMethod() {} // create a Trace with name => traceID:[id] + * } + * } + * </pre> + */ + String value(); + + /** + * 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 trace + */ + String tags() default ""; +} diff --git a/kamon-annotation/src/main/java/kamon/annotation/el/resolver/PrivateFieldELResolver.java b/kamon-annotation/src/main/java/kamon/annotation/el/resolver/PrivateFieldELResolver.java new file mode 100644 index 00000000..df646942 --- /dev/null +++ b/kamon-annotation/src/main/java/kamon/annotation/el/resolver/PrivateFieldELResolver.java @@ -0,0 +1,117 @@ +/* + * ========================================================================================= + * 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.el.resolver; + +import java.beans.FeatureDescriptor; +import java.lang.reflect.Field; +import java.util.Iterator; +import javax.el.ELContext; +import javax.el.ELException; +import javax.el.ELResolver; + +/** + * A custom {@link ELResolver} for mapping properties to public/private fields of the base object. + */ +public class PrivateFieldELResolver extends ELResolver { + + @Override + public Object getValue(ELContext context, Object base, Object property) { + if (base == null) { + return null; + } + try { + Field field = getField(base, (String) property); + context.setPropertyResolved(true); + field.setAccessible(true); + return field.get(base); + } catch (NoSuchFieldException exc) { + context.setPropertyResolved(false); + return null; + } catch (Exception exc) { + throw new ELException(exc); + } + } + + private Field getField(Object base, String property) throws NoSuchFieldException { + try { + return base.getClass().getDeclaredField(property); + } catch (SecurityException exc) { + throw new ELException(exc); + } + } + + @Override + public Class<?> getType(ELContext context, Object base, Object property) { + if (base == null) { + return null; + } + try { + Field field = getField(base, (String) property); + if (field != null) { + context.setPropertyResolved(true); + return field.getType(); + } else { + return null; + } + } catch (NoSuchFieldException exc) { + context.setPropertyResolved(false); + return null; + } + } + + @Override + public void setValue(ELContext context, Object base, Object property, Object value) { + if (base == null) { + return; + } + try { + context.setPropertyResolved(true); + getField(base, (String) property).set(base, value); + } catch (NoSuchFieldException exc) { + context.setPropertyResolved(false); + } catch (Exception exc) { + throw new ELException(exc); + } + } + + @Override + public boolean isReadOnly(ELContext context, Object base, Object property) { + if (base == null) { + return true; + } + try { + Field field = getField(base, (String) property); + if (field != null) { + context.setPropertyResolved(true); + return !field.isAccessible(); + } + } catch (NoSuchFieldException exc) { + context.setPropertyResolved(false); + } + return false; + } + + @Override + public Iterator<FeatureDescriptor> getFeatureDescriptors(ELContext context, Object base) { + return null; + } + + @Override + public Class<?> getCommonPropertyType(ELContext context, Object base) { + return String.class; + } +}
\ No newline at end of file |