Package io.quarkus.smallrye.metrics.deployment.spi

Class MetricBuildItem

java.lang.Object
io.quarkus.builder.item.BuildItem
io.quarkus.builder.item.MultiBuildItem
io.quarkus.smallrye.metrics.deployment.spi.MetricBuildItem
@Deprecated public final class MetricBuildItem extends io.quarkus.builder.item.MultiBuildItem
Deprecated.
Build item that is picked up by the SmallRye Metrics extension to register metrics required by other extensions.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    MetricBuildItem.Builder
    Deprecated.
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    MetricBuildItem(org.eclipse.microprofile.metrics.Metadata metadata, boolean enabled, String configRootName, org.eclipse.microprofile.metrics.Tag... tags)
    Deprecated.
    Create a metric build item from the specified metadata and tags.
    MetricBuildItem(org.eclipse.microprofile.metrics.Metadata metadata, Object implementor, boolean enabled, String configRootName, org.eclipse.microprofile.metrics.MetricRegistry.Type registryType, org.eclipse.microprofile.metrics.Tag... tags)
    Deprecated.
    Create a metric build item from the specified metadata, tags, a callable, and scope.
    MetricBuildItem(org.eclipse.microprofile.metrics.Metadata metadata, Object implementor, boolean enabled, String configRootName, org.eclipse.microprofile.metrics.Tag... tags)
    Deprecated.
    Create a metric build item from the specified metadata, tags, and a callable.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getConfigRootName()
    Deprecated.
     
    Object
    getImplementor()
    Deprecated.
     
    org.eclipse.microprofile.metrics.Metadata
    getMetadata()
    Deprecated.
     
    org.eclipse.microprofile.metrics.MetricRegistry.Type
    getRegistryType()
    Deprecated.
     
    org.eclipse.microprofile.metrics.Tag[]
    getTags()
    Deprecated.
     
    boolean
    isEnabled()
    Deprecated.
     

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • MetricBuildItem

      public MetricBuildItem(org.eclipse.microprofile.metrics.Metadata metadata, boolean enabled, String configRootName, org.eclipse.microprofile.metrics.Tag... tags)
      Deprecated.
      Create a metric build item from the specified metadata and tags. Such metric will be picked up by the Metrics extension and registered in the VENDOR registry. This constructor is applicable to all metric types except gauges.
      Parameters:
      metadata - The metadata that should be applied to the registered metric
      enabled - Whether this metric is enabled
      tags - The tags that will be applied to this metric
      configRootName - the name of the root configuration of the extension as defined by the @ConfigRoot annotation.

    • MetricBuildItem

      public MetricBuildItem(org.eclipse.microprofile.metrics.Metadata metadata, Object implementor, boolean enabled, String configRootName, org.eclipse.microprofile.metrics.Tag... tags)
      Deprecated.
      Create a metric build item from the specified metadata, tags, and a callable. Such metric will be picked up by the Metrics extension and registered in the VENDOR registry.
      Parameters:
      metadata - The metadata that should be applied to the registered metric
      implementor - The object that implements the metric. It must be an instance of the appropriate metric class (from the org.eclipse.microprofile.metrics package). This is required for gauges and optional for all other metric types.
      enabled - Whether this metric is enabled
      tags - The tags that will be applied to this metric
      configRootName - the name of the root configuration of the extension as defined by the @ConfigRoot annotation.

    • MetricBuildItem

      public MetricBuildItem(org.eclipse.microprofile.metrics.Metadata metadata, Object implementor, boolean enabled, String configRootName, org.eclipse.microprofile.metrics.MetricRegistry.Type registryType, org.eclipse.microprofile.metrics.Tag... tags)
      Deprecated.
      Create a metric build item from the specified metadata, tags, a callable, and scope. Such metric will be picked up by the Metrics extension and registered in the registry for the desired scope.
      Parameters:
      metadata - The metadata that should be applied to the registered metric
      implementor - The object that implements the metric. It must be an instance of the appropriate metric class (from the org.eclipse.microprofile.metrics package). This is required for gauges and optional for all other metric types.
      enabled - Whether this metric is enabled
      tags - The tags that will be applied to this metric
      configRootName - the name of the root configuration of the extension as defined by the @ConfigRoot annotation.
      registryType - Registry where the metric should be placed

  • Method Details

    • getMetadata

      public org.eclipse.microprofile.metrics.Metadata getMetadata()
      Deprecated.

    • getTags

      public org.eclipse.microprofile.metrics.Tag[] getTags()
      Deprecated.

    • getImplementor

      public Object getImplementor()
      Deprecated.

    • isEnabled

      public boolean isEnabled()
      Deprecated.

    • getConfigRootName

      public String getConfigRootName()
      Deprecated.

    • getRegistryType

      public org.eclipse.microprofile.metrics.MetricRegistry.Type getRegistryType()
      Deprecated.