kamon.annotation.Count Maven / Gradle / Ivy

Go to download
/*
 * =========================================================================================
 * Copyright © 2013-2015 the kamon project 
 *
 * 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.
 * 
 * 

 * Given a method like this:
 * 

 *     {@literal @}Count(name = "coolName", tags="${'my-cool-tag':'my-cool-value'}")
 *     public String coolName(String name) {
 *         return "Hello " + name;
 *     }
 * 
 * 
 * 

 * 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.
     * 

     * Also, the Metric name can be resolved with an EL expression that evaluates to a String:
     * 

     * 
     * {@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]
     *    }
     * }
     * 
     */
    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 "";
}