io.dropwizard.metrics5.health.annotation.Async Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of metrics-healthchecks Show documentation

An addition to Metrics which provides the ability to run application-specific health checks, allowing you to check your application's heath in production.

There is a newer version: 5.0.0

Show newest version

package io.dropwizard.metrics5.health.annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import java.util.concurrent.TimeUnit;

/**
 * An annotation for marking asynchronous health check execution.
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface Async {
    /**
     * Enum representing the initial health states.
     */
    enum InitialState {
        HEALTHY, UNHEALTHY
    }

    /**
     * Enum representing the possible schedule types.
     */
    enum ScheduleType {
        FIXED_RATE, FIXED_DELAY
    }

    /**
     * Period between executions.
     *
     * @return period
     */
    long period();

    /**
     * Scheduling type of asynchronous executions.
     *
     * @return schedule type
     */
    ScheduleType scheduleType() default ScheduleType.FIXED_RATE;

    /**
     * Initial delay of first execution.
     *
     * @return initial delay
     */
    long initialDelay() default 0;

    /**
     * Time unit of initial delay, period and healthyTtl.
     *
     * @return time unit
     */
    TimeUnit unit() default TimeUnit.SECONDS;

    /**
     * Initial health state until first asynchronous execution completes.
     *
     * @return initial health state
     */
    InitialState initialState() default InitialState.HEALTHY;

    /**
     * How long a healthy result is considered valid before being ignored.
     *
     * Handles cases where the asynchronous healthcheck did not run (for example thread starvation).
     *
     * Defaults to 2 * period
     *
     * @return healthy result time to live
     */
    long healthyTtl() default -1;

}