Interface GraphiteMonitorReporterPluginCfg
-
- All Superinterfaces:
Configuration
,PluginCfg
public interface GraphiteMonitorReporterPluginCfg extends PluginCfg
A server-side interface for querying Graphite Monitor Reporter Plugin settings.The Graphite Monitor Reporter Plugin contains information needed to push server monitoring metrics into a Graphite server.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method 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.com.forgerock.opendj.util.HostPort
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.-
Methods inherited from interface org.forgerock.opendj.config.Configuration
dn, name
-
Methods inherited from interface org.forgerock.opendj.server.config.server.PluginCfg
addChangeListener, isEnabled, isInvokeForInternalOperations, removeChangeListener
-
-
-
-
Method Detail
-
configurationClass
Class<? extends GraphiteMonitorReporterPluginCfg> configurationClass()
Gets the configuration class associated with this Graphite Monitor Reporter Plugin.- Specified by:
configurationClass
in interfaceConfiguration
- Specified by:
configurationClass
in interfacePluginCfg
- Returns:
- Returns the configuration class associated with this Graphite Monitor Reporter Plugin.
-
addGraphiteMonitorReporterChangeListener
void addGraphiteMonitorReporterChangeListener(ConfigurationChangeListener<GraphiteMonitorReporterPluginCfg> listener)
Register to be notified when this Graphite Monitor Reporter Plugin is changed.- Parameters:
listener
- The Graphite Monitor Reporter Plugin configuration change listener.
-
removeGraphiteMonitorReporterChangeListener
void removeGraphiteMonitorReporterChangeListener(ConfigurationChangeListener<GraphiteMonitorReporterPluginCfg> listener)
Deregister an existing Graphite Monitor Reporter Plugin configuration change listener.- Parameters:
listener
- The Graphite Monitor Reporter Plugin configuration change listener.
-
getExcludedMetricPattern
SortedSet<String> getExcludedMetricPattern()
Gets the "excluded-metric-pattern" property.Zero or more regular expressions identifying metrics that should not be published. The metric name prefix must not be included in the filter. Exclusion patterns take precedence over inclusion patterns.
Default value is undefined
- Returns:
- Returns an unmodifiable set containing the values of the "excluded-metric-pattern" property.
-
getGraphiteServer
com.forgerock.opendj.util.HostPort getGraphiteServer()
Gets the "graphite-server" property.The Graphite server address.
When using an IPv6 address as the hostname, put brackets around the address as in "[IPv6Address]:port".
- Returns:
- Returns the value of the "graphite-server" property.
-
getIncludedMetricPattern
SortedSet<String> getIncludedMetricPattern()
Gets the "included-metric-pattern" property.Zero or more regular expressions identifying metrics that should be published. The metric name prefix must not be included in the filter. Exclusion patterns take precedence over inclusion patterns.
Default value is undefined
- Returns:
- Returns an unmodifiable set containing the values of the "included-metric-pattern" property.
-
getJavaClass
String getJavaClass()
Gets the "java-class" property.Specifies the fully-qualified name of the Java class that provides the plug-in implementation.
Default value:
org.opends.server.plugins.GraphiteMonitorReporterPlugin
- Specified by:
getJavaClass
in interfacePluginCfg
- Returns:
- Returns the value of the "java-class" property.
-
getMetricNamePrefix
String getMetricNamePrefix()
Gets the "metric-name-prefix" property.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.
Default value:
ds
- Returns:
- Returns the value of the "metric-name-prefix" property.
-
getPluginType
SortedSet<PluginCfgDefn.PluginType> getPluginType()
Gets the "plugin-type" property.Specifies the set of plug-in types for the plug-in, which specifies the times at which the plug-in is invoked.
Default values:
startup
,shutdown
- Specified by:
getPluginType
in interfacePluginCfg
- Returns:
- Returns an unmodifiable set containing the values of the "plugin-type" property.
-
getReportingInterval
long getReportingInterval()
Gets the "reporting-interval" property.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.
Default value:
10s
- Returns:
- Returns the value of the "reporting-interval" property.
-
-