public class MetricDefinition extends CloneableDataObject
Title: Service Event Fabric Core
Description: The Metric
object holds all critical settings for a service metric.
Metrics record critical information about a component's performance or some other vital statistics. A Metric
is
a Structured Data Object
and will appear in the catalog of system objects as a Semantic Type
. However
this a system object used by the fabric to represent metric updates that are typically sent to advisory listeners or query
mechanisms. The actual engine for emitting metrics is an implementation of MetricsFactory
. The storage of run-time
metrics is likewise handled by the specific implementation of a given MetricsFactory
.
Metric names typically follow a hirarchical naming convention that uses a dotted notation to separate the elements. For example
Container.System.Memory
is an example of a container-level system metric that contains memory related information.
While any number of hirarchies may be specificed in this fashion, node levels deeper then 4 levels are usually impractical. To
specify leaf-level details about memory related metrics a developer may specify something similar to the following:
Container.System.Memory.CurrentUsage
Container.System.Memory.High
Container.System.Memory.Low
Copyright: Copyright (c) 2010
Company: StreamScape Technologies
DEFAULT_SERIAL_VERSION_ID
Constructor and Description |
---|
MetricDefinition() |
MetricDefinition(java.lang.String metricName) |
Modifier and Type | Method and Description |
---|---|
MetricDefinition |
clone()
Clones the object.
|
java.lang.String |
getDescription() |
long |
getIncrementUnits() |
long |
getMaxThreshold() |
java.lang.Long |
getMinThreshold() |
java.lang.String |
getName() |
long |
getResetInterval() |
Unit |
getUnits() |
boolean |
hasNotification() |
void |
setDescription(java.lang.String description) |
void |
setIncrementUnits(long units) |
void |
setMaxThreshold(long threshold) |
void |
setMinThreshold(long threshold) |
void |
setName(java.lang.String metricName) |
void |
setNotificationEnabled(boolean notify) |
void |
setResetInterval(long resetInterval) |
void |
setUnits(Unit unit) |
getSerialVersionUID
public MetricDefinition()
public MetricDefinition(java.lang.String metricName) throws FabricComponentConfigurationException
public java.lang.String getName()
public void setName(java.lang.String metricName) throws FabricComponentConfigurationException
public void setDescription(java.lang.String description)
public java.lang.String getDescription()
public void setMinThreshold(long threshold)
public java.lang.Long getMinThreshold()
public void setMaxThreshold(long threshold)
public long getMaxThreshold()
public void setUnits(Unit unit)
public Unit getUnits()
public void setIncrementUnits(long units)
public long getIncrementUnits()
public void setNotificationEnabled(boolean notify)
public boolean hasNotification()
public void setResetInterval(long resetInterval)
public long getResetInterval()
public MetricDefinition clone()
CloneableDataObject
clone
in interface CloneableObject
clone
in class CloneableDataObject
Copyright © 2015-2024 StreamScape Technologies. All rights reserved.