public interface GraphiteMonitorReporterPluginCfgClient extends PluginCfgClient
The Graphite Monitor Reporter Plugin contains information needed to push server monitoring metrics into a Graphite server.
Modifier and Type | Method and Description |
---|---|
ManagedObjectDefinition<? extends GraphiteMonitorReporterPluginCfgClient,? extends GraphiteMonitorReporterPluginCfg> |
definition()
Get the configuration definition associated with this Graphite Monitor Reporter Plugin.
|
SortedSet<ValueOrExpression<String>> |
getExcludedMetricPattern()
Gets the "excluded-metric-pattern" property.
|
ValueOrExpression<String> |
getGraphiteServer()
Gets the "graphite-server" property.
|
SortedSet<ValueOrExpression<String>> |
getIncludedMetricPattern()
Gets the "included-metric-pattern" property.
|
ValueOrExpression<String> |
getJavaClass()
Gets the "java-class" property.
|
ValueOrExpression<String> |
getMetricNamePrefix()
Gets the "metric-name-prefix" property.
|
SortedSet<ValueOrExpression<PluginCfgDefn.PluginType>> |
getPluginType()
Gets the "plugin-type" property.
|
ValueOrExpression<Long> |
getReportingInterval()
Gets the "reporting-interval" property.
|
void |
setExcludedMetricPattern(Collection<ValueOrExpression<String>> values)
Sets the "excluded-metric-pattern" property.
|
void |
setGraphiteServer(ValueOrExpression<String> value)
Sets the "graphite-server" property.
|
void |
setIncludedMetricPattern(Collection<ValueOrExpression<String>> values)
Sets the "included-metric-pattern" property.
|
void |
setJavaClass(ValueOrExpression<String> value)
Sets the "java-class" property.
|
void |
setMetricNamePrefix(ValueOrExpression<String> value)
Sets the "metric-name-prefix" property.
|
void |
setPluginType(Collection<ValueOrExpression<PluginCfgDefn.PluginType>> values)
Sets the "plugin-type" property.
|
void |
setReportingInterval(ValueOrExpression<Long> value)
Sets the "reporting-interval" property.
|
isEnabled, isInvokeForInternalOperations, setEnabled, setInvokeForInternalOperations
commit, properties
ManagedObjectDefinition<? extends GraphiteMonitorReporterPluginCfgClient,? extends GraphiteMonitorReporterPluginCfg> definition()
definition
in interface ConfigurationClient
definition
in interface PluginCfgClient
SortedSet<ValueOrExpression<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.
void setExcludedMetricPattern(Collection<ValueOrExpression<String>> values) throws PropertyException
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.
values
- The values of the "excluded-metric-pattern" property.PropertyException
- If one or more of the new values are invalid.ValueOrExpression<String> getGraphiteServer()
The host/port of the Graphite server.
void setGraphiteServer(ValueOrExpression<String> value) throws PropertyException
The host/port of the Graphite server.
value
- The value of the "graphite-server" property.PropertyException
- If the new value is invalid.SortedSet<ValueOrExpression<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.
void setIncludedMetricPattern(Collection<ValueOrExpression<String>> values) throws PropertyException
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.
values
- The values of the "included-metric-pattern" property.PropertyException
- If one or more of the new values are invalid.ValueOrExpression<String> getJavaClass()
Specifies the fully-qualified name of the Java class that provides the plug-in implementation.
getJavaClass
in interface PluginCfgClient
void setJavaClass(ValueOrExpression<String> value) throws PropertyException
Specifies the fully-qualified name of the Java class that provides the plug-in implementation.
setJavaClass
in interface PluginCfgClient
value
- The value of the "java-class" property.PropertyException
- If the new value is invalid.ValueOrExpression<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.
void setMetricNamePrefix(ValueOrExpression<String> value) throws PropertyException
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.
value
- The value of the "metric-name-prefix" property.PropertyException
- If the new value is invalid.SortedSet<ValueOrExpression<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 PluginCfgClient
void setPluginType(Collection<ValueOrExpression<PluginCfgDefn.PluginType>> values) throws PropertyException
Specifies the set of plug-in types for the plug-in, which specifies the times at which the plug-in is invoked.
setPluginType
in interface PluginCfgClient
values
- The values of the "plugin-type" property.PropertyException
- If one or more of the new values are invalid.ValueOrExpression<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.
void setReportingInterval(ValueOrExpression<Long> value) throws PropertyException
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.
value
- The value of the "reporting-interval" property.PropertyException
- If the new value is invalid.Copyright 2010-2018 ForgeRock AS.