public interface GraphiteMonitorReporterPluginCfg extends PluginCfg
The Graphite Monitor Reporter Plugin contains information needed to push server monitoring metrics into a Graphite server.
Modifier and Type | Method and Description |
---|---|
void |
addGraphiteMonitorReporterChangeListener(ConfigurationChangeListener<GraphiteMonitorReporterPluginCfg> listener)
Register to be notified when this Graphite Monitor Reporter Plugin is changed.
|
Class<? extends GraphiteMonitorReporterPluginCfg> |
configurationClass()
Gets the configuration class associated with this Graphite Monitor Reporter Plugin.
|
SortedSet<String> |
getExcludedMetricPattern()
Gets the "excluded-metric-pattern" property.
|
String |
getGraphiteServer()
Gets the "graphite-server" property.
|
SortedSet<String> |
getIncludedMetricPattern()
Gets the "included-metric-pattern" property.
|
String |
getJavaClass()
Gets the "java-class" property.
|
String |
getMetricNamePrefix()
Gets the "metric-name-prefix" property.
|
SortedSet<PluginCfgDefn.PluginType> |
getPluginType()
Gets the "plugin-type" property.
|
long |
getReportingInterval()
Gets the "reporting-interval" property.
|
void |
removeGraphiteMonitorReporterChangeListener(ConfigurationChangeListener<GraphiteMonitorReporterPluginCfg> listener)
Deregister an existing Graphite Monitor Reporter Plugin configuration change listener.
|
addChangeListener, isEnabled, isInvokeForInternalOperations, removeChangeListener
dn, name
Class<? extends GraphiteMonitorReporterPluginCfg> configurationClass()
configurationClass
in interface Configuration
configurationClass
in interface PluginCfg
void addGraphiteMonitorReporterChangeListener(ConfigurationChangeListener<GraphiteMonitorReporterPluginCfg> listener)
listener
- The Graphite Monitor Reporter Plugin configuration change listener.void removeGraphiteMonitorReporterChangeListener(ConfigurationChangeListener<GraphiteMonitorReporterPluginCfg> listener)
listener
- The Graphite Monitor Reporter Plugin configuration change listener.SortedSet<String> getExcludedMetricPattern()
Zero or more regular expressions identifying metrics that should not be published to the Graphite server. The metric name prefix must not be included in the filter. Exclusion patterns take precedence over inclusion patterns.
String getGraphiteServer()
The host/port of the Graphite server.
SortedSet<String> getIncludedMetricPattern()
Zero or more regular expressions identifying metrics that should be published to the Graphite server. The metric name prefix must not be included in the filter. Exclusion patterns take precedence over inclusion patterns.
String getJavaClass()
Specifies the fully-qualified name of the Java class that provides the plug-in implementation.
getJavaClass
in interface PluginCfg
String getMetricNamePrefix()
The prefix that will be added to all metric names reported to Graphite.
The prefix helps distinguish between metrics arriving from different instances of the same application, thereby allowing monitoring applications to monitor the entire service as well as drill-down to specific application instances. Consider including an identifier for the data center, the application type, and a unique identifier for the application instance in the prefix using a dot-separated structure. For example, 'ny.opendj.ds1' identifies the OpenDJ instance "ds1" in the New York data center.
SortedSet<PluginCfgDefn.PluginType> getPluginType()
Specifies the set of plug-in types for the plug-in, which specifies the times at which the plug-in is invoked.
getPluginType
in interface PluginCfg
long getReportingInterval()
The interval between successive publications of server metrics to Graphite.
An interval in the range 10-60 seconds is recommended. Reducing the interval increases the accuracy of the metrics at the cost of network utilization.
Copyright 2010-2018 ForgeRock AS.