Class GraphiteMonitorReporterPluginCfgDefn
- java.lang.Object
-
- org.forgerock.opendj.config.AbstractManagedObjectDefinition<C,S>
-
- org.forgerock.opendj.config.ManagedObjectDefinition<GraphiteMonitorReporterPluginCfgClient,GraphiteMonitorReporterPluginCfg>
-
- org.forgerock.opendj.server.config.meta.GraphiteMonitorReporterPluginCfgDefn
-
public final class GraphiteMonitorReporterPluginCfgDefn extends ManagedObjectDefinition<GraphiteMonitorReporterPluginCfgClient,GraphiteMonitorReporterPluginCfg>
An interface for querying the Graphite Monitor Reporter Plugin managed object definition meta information.The Graphite Monitor Reporter Plugin contains information needed to push server monitoring metrics into a Graphite server.
-
-
Method Summary
-
Methods inherited from class org.forgerock.opendj.config.AbstractManagedObjectDefinition
getAggregationPropertyDefinition, getAggregationPropertyDefinitions, getAllAggregationPropertyDefinitions, getAllChildren, getAllConstraints, getAllPropertyDefinitions, getAllRelationDefinitions, getAllReverseAggregationPropertyDefinitions, getAllReverseRelationDefinitions, getAllTags, getChild, getChildren, getConstraints, getDescription, getDescription, getName, getParent, getPropertyDefinition, getPropertyDefinitions, getRelationDefinition, getRelationDefinitions, getReverseAggregationPropertyDefinitions, getReverseRelationDefinitions, getSynopsis, getSynopsis, getUserFriendlyName, getUserFriendlyName, getUserFriendlyPluralName, getUserFriendlyPluralName, hasChildren, hasOption, hasTag, initialize, isChildOf, isParentOf, isTop, registerConstraint, registerOption, registerPropertyDefinition, registerRelationDefinition, registerTag, resolveManagedObjectDefinition, toString, toString
-
-
-
-
Method Detail
-
getInstance
public static GraphiteMonitorReporterPluginCfgDefn getInstance()
Get the Graphite Monitor Reporter Plugin configuration definition singleton.- Returns:
- Returns the Graphite Monitor Reporter Plugin configuration definition singleton.
-
createClientConfiguration
public GraphiteMonitorReporterPluginCfgClient createClientConfiguration(ManagedObject<? extends GraphiteMonitorReporterPluginCfgClient> impl)
Description copied from class:ManagedObjectDefinition
Creates a client configuration view of the provided managed object. Modifications made to the underlying managed object will be reflected in the client configuration view and vice versa.- Specified by:
createClientConfiguration
in classManagedObjectDefinition<GraphiteMonitorReporterPluginCfgClient,GraphiteMonitorReporterPluginCfg>
- Parameters:
impl
- The managed object.- Returns:
- Returns a client configuration view of the provided managed object.
-
createServerConfiguration
public GraphiteMonitorReporterPluginCfg createServerConfiguration(ServerManagedObject<? extends GraphiteMonitorReporterPluginCfg> impl)
Description copied from class:ManagedObjectDefinition
Creates a server configuration view of the provided server managed object.- Specified by:
createServerConfiguration
in classManagedObjectDefinition<GraphiteMonitorReporterPluginCfgClient,GraphiteMonitorReporterPluginCfg>
- Parameters:
impl
- The server managed object.- Returns:
- Returns a server configuration view of the provided server managed object.
-
getServerConfigurationClass
public Class<GraphiteMonitorReporterPluginCfg> getServerConfigurationClass()
Description copied from class:ManagedObjectDefinition
Gets the server configuration class instance associated with this managed object definition.- Specified by:
getServerConfigurationClass
in classManagedObjectDefinition<GraphiteMonitorReporterPluginCfgClient,GraphiteMonitorReporterPluginCfg>
- Returns:
- Returns the server configuration class instance associated with this managed object definition.
-
getEnabledPropertyDefinition
public BooleanPropertyDefinition getEnabledPropertyDefinition()
Get the "enabled" property definition.Indicates whether the plug-in is enabled for use.
- Returns:
- Returns the "enabled" property definition.
-
getExcludedMetricPatternPropertyDefinition
public StringPropertyDefinition getExcludedMetricPatternPropertyDefinition()
Get the "excluded-metric-pattern" property definition.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.
- Returns:
- Returns the "excluded-metric-pattern" property definition.
-
getGraphiteServerPropertyDefinition
public HostPortPropertyDefinition getGraphiteServerPropertyDefinition()
Get the "graphite-server" property definition.The Graphite server address.
When using an IPv6 address as the hostname, put brackets around the address as in "[IPv6Address]:port".
- Returns:
- Returns the "graphite-server" property definition.
-
getIncludedMetricPatternPropertyDefinition
public StringPropertyDefinition getIncludedMetricPatternPropertyDefinition()
Get the "included-metric-pattern" property definition.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.
- Returns:
- Returns the "included-metric-pattern" property definition.
-
getInvokeForInternalOperationsPropertyDefinition
public BooleanPropertyDefinition getInvokeForInternalOperationsPropertyDefinition()
Get the "invoke-for-internal-operations" property definition.Indicates whether the plug-in should be invoked for internal operations.
Any plug-in that can be invoked for internal operations must ensure that it does not create any new internal operatons that can cause the same plug-in to be re-invoked.
- Returns:
- Returns the "invoke-for-internal-operations" property definition.
-
getJavaClassPropertyDefinition
public ClassPropertyDefinition getJavaClassPropertyDefinition()
Get the "java-class" property definition.Specifies the fully-qualified name of the Java class that provides the plug-in implementation.
- Returns:
- Returns the "java-class" property definition.
-
getMetricNamePrefixPropertyDefinition
public StringPropertyDefinition getMetricNamePrefixPropertyDefinition()
Get the "metric-name-prefix" property definition.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.
- Returns:
- Returns the "metric-name-prefix" property definition.
-
getPluginTypePropertyDefinition
public EnumPropertyDefinition<PluginCfgDefn.PluginType> getPluginTypePropertyDefinition()
Get the "plugin-type" property definition.Specifies the set of plug-in types for the plug-in, which specifies the times at which the plug-in is invoked.
- Returns:
- Returns the "plugin-type" property definition.
-
getReportingIntervalPropertyDefinition
public DurationPropertyDefinition getReportingIntervalPropertyDefinition()
Get the "reporting-interval" property definition.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.
- Returns:
- Returns the "reporting-interval" property definition.
-
-