Module io.helidon.metrics.api
Package io.helidon.metrics.api

Interface HelidonMetric

All Superinterfaces:
Metric
All Known Implementing Classes:
AbstractMetric
public interface HelidonMetric extends Metric
Helidon-required behavior for each type (e.g., full-featured or no-op) of metric implementation.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    isDeleted()
     
    static boolean
    isMarkedAsDeleted(Metric metric)
    Indicates if the specified metric is known to have been marked as deleted.
    void
    markAsDeleted()
    Record that a previously-registered metric has been removed from the registry.
    Metadata
    metadata()
     
    String
    registryType()
     

  • Method Details

    • isMarkedAsDeleted

      static boolean isMarkedAsDeleted(Metric metric)
      Indicates if the specified metric is known to have been marked as deleted.

      This check makes sense only for metrics which implement HelidonMetric, which all Helidon-provided metrics do.

      Parameters:
      metric - the metric to check
      Returns:
      true if the metrics implements HelidonMetric and also has been marked as deleted; false otherwise

    • metadata

      Metadata metadata()
      Returns:
      the metadata for the metric

    • markAsDeleted

      void markAsDeleted()
      Record that a previously-registered metric has been removed from the registry.

    • isDeleted

      boolean isDeleted()
      Returns:
      true if the metric has been removed from its registry; false if it is still registered

    • registryType

      String registryType()
      Returns:
      the name of the registry type in which the metric was registered