spring-framework / org.springframework.jmx.export.metadata / ManagedMetric

ManagedMetric

open class ManagedMetric : AbstractJmxAttribute

Metadata that indicates to expose a given bean property as a JMX attribute, with additional descriptor properties that indicate that the attribute is a metric. Only valid when used on a JavaBean getter.

Author
Jennifer Hickey

Since
3.0

See Also
org.springframework.jmx.export.assembler.MetadataMBeanInfoAssembler

Constructors

<init>

ManagedMetric()

Metadata that indicates to expose a given bean property as a JMX attribute, with additional descriptor properties that indicate that the attribute is a metric. Only valid when used on a JavaBean getter.

Functions

getCategory

open fun getCategory(): String

The category of this metric (ex. throughput, performance, utilization).

getDisplayName

open fun getDisplayName(): String

A display name for this metric.

getMetricType

open fun getMetricType(): MetricType

A description of how this metric's values change over time.

getPersistPeriod

open fun getPersistPeriod(): Int

The persist period for this metric.

getPersistPolicy

open fun getPersistPolicy(): String

The persist policy for this metric.

getUnit

open fun getUnit(): String

The expected unit of measurement values.

setCategory

open fun setCategory(category: String): Unit

The category of this metric (ex. throughput, performance, utilization).

setDisplayName

open fun setDisplayName(displayName: String): Unit

A display name for this metric.

setMetricType

open fun setMetricType(metricType: MetricType): Unit

A description of how this metric's values change over time.

setPersistPeriod

open fun setPersistPeriod(persistPeriod: Int): Unit

The persist period for this metric.

setPersistPolicy

open fun setPersistPolicy(persistPolicy: String): Unit

The persist policy for this metric.

setUnit

open fun setUnit(unit: String): Unit

The expected unit of measurement values.