Interface GraphiteMonitorReporterPluginCfgClient
-
- All Superinterfaces:
ConfigurationClient
,PluginCfgClient
public interface GraphiteMonitorReporterPluginCfgClient extends PluginCfgClient
A client-side interface for reading and modifying 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 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<com.forgerock.opendj.util.HostPort>
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<com.forgerock.opendj.util.HostPort> 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.-
Methods inherited from interface org.forgerock.opendj.config.ConfigurationClient
commit, properties
-
Methods inherited from interface org.forgerock.opendj.server.config.client.PluginCfgClient
isEnabled, isInvokeForInternalOperations, setEnabled, setInvokeForInternalOperations
-
-
-
-
Method Detail
-
definition
ManagedObjectDefinition<? extends GraphiteMonitorReporterPluginCfgClient,? extends GraphiteMonitorReporterPluginCfg> definition()
Get the configuration definition associated with this Graphite Monitor Reporter Plugin.- Specified by:
definition
in interfaceConfigurationClient
- Specified by:
definition
in interfacePluginCfgClient
- Returns:
- Returns the configuration definition associated with this Graphite Monitor Reporter Plugin.
-
getExcludedMetricPattern
SortedSet<ValueOrExpression<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 the values of the "excluded-metric-pattern" property.
-
setExcludedMetricPattern
void setExcludedMetricPattern(Collection<ValueOrExpression<String>> values) throws PropertyException
Sets 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.
- Parameters:
values
- The values of the "excluded-metric-pattern" property.- Throws:
PropertyException
- If one or more of the new values are invalid.
-
getGraphiteServer
@MandatoryProperty ValueOrExpression<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.
-
setGraphiteServer
@MandatoryProperty void setGraphiteServer(ValueOrExpression<com.forgerock.opendj.util.HostPort> value) throws PropertyException
Sets 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".
- Parameters:
value
- The value of the "graphite-server" property.- Throws:
PropertyException
- If the new value is invalid.
-
getIncludedMetricPattern
SortedSet<ValueOrExpression<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 the values of the "included-metric-pattern" property.
-
setIncludedMetricPattern
void setIncludedMetricPattern(Collection<ValueOrExpression<String>> values) throws PropertyException
Sets 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.
- Parameters:
values
- The values of the "included-metric-pattern" property.- Throws:
PropertyException
- If one or more of the new values are invalid.
-
getJavaClass
@MandatoryProperty ValueOrExpression<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 interfacePluginCfgClient
- Returns:
- Returns the value of the "java-class" property.
-
setJavaClass
@MandatoryProperty void setJavaClass(ValueOrExpression<String> value) throws PropertyException
Sets the "java-class" property.Specifies the fully-qualified name of the Java class that provides the plug-in implementation.
- Specified by:
setJavaClass
in interfacePluginCfgClient
- Parameters:
value
- The value of the "java-class" property.- Throws:
PropertyException
- If the new value is invalid.
-
getMetricNamePrefix
ValueOrExpression<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.
-
setMetricNamePrefix
void setMetricNamePrefix(ValueOrExpression<String> value) throws PropertyException
Sets 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.
- Parameters:
value
- The value of the "metric-name-prefix" property.- Throws:
PropertyException
- If the new value is invalid.
-
getPluginType
@MandatoryProperty SortedSet<ValueOrExpression<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 interfacePluginCfgClient
- Returns:
- Returns the values of the "plugin-type" property.
-
setPluginType
@MandatoryProperty void setPluginType(Collection<ValueOrExpression<PluginCfgDefn.PluginType>> values) throws PropertyException
Sets 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.
- Specified by:
setPluginType
in interfacePluginCfgClient
- Parameters:
values
- The values of the "plugin-type" property.- Throws:
PropertyException
- If one or more of the new values are invalid.
-
getReportingInterval
ValueOrExpression<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.
-
setReportingInterval
void setReportingInterval(ValueOrExpression<Long> value) throws PropertyException
Sets 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.
- Parameters:
value
- The value of the "reporting-interval" property.- Throws:
PropertyException
- If the new value is invalid.
-
-