com.github.strengthened.prometheus.healthchecks.Async Maven / Gradle / Ivy

Go to download

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

Metrics collector for Healthcheck system.

The newest version!

package com.github.strengthened.prometheus.healthchecks;

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 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 and period.
   *
   * @return time unit
   */
  TimeUnit unit() default TimeUnit.SECONDS;

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

}