public final class GraphiteMonitorReporterPluginCfgDefn extends ManagedObjectDefinition<GraphiteMonitorReporterPluginCfgClient,GraphiteMonitorReporterPluginCfg>
The Graphite Monitor Reporter Plugin contains information needed to push server monitoring metrics into a Graphite server.
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
public static GraphiteMonitorReporterPluginCfgDefn getInstance()
public GraphiteMonitorReporterPluginCfgClient createClientConfiguration(ManagedObject<? extends GraphiteMonitorReporterPluginCfgClient> impl)
ManagedObjectDefinition
createClientConfiguration
in class ManagedObjectDefinition<GraphiteMonitorReporterPluginCfgClient,GraphiteMonitorReporterPluginCfg>
impl
- The managed object.public GraphiteMonitorReporterPluginCfg createServerConfiguration(ServerManagedObject<? extends GraphiteMonitorReporterPluginCfg> impl)
ManagedObjectDefinition
createServerConfiguration
in class ManagedObjectDefinition<GraphiteMonitorReporterPluginCfgClient,GraphiteMonitorReporterPluginCfg>
impl
- The server managed object.public Class<GraphiteMonitorReporterPluginCfg> getServerConfigurationClass()
ManagedObjectDefinition
getServerConfigurationClass
in class ManagedObjectDefinition<GraphiteMonitorReporterPluginCfgClient,GraphiteMonitorReporterPluginCfg>
public BooleanPropertyDefinition getEnabledPropertyDefinition()
Indicates whether the plug-in is enabled for use.
public StringPropertyDefinition getExcludedMetricPatternPropertyDefinition()
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.
public StringPropertyDefinition getGraphiteServerPropertyDefinition()
The host/port of the Graphite server.
public StringPropertyDefinition getIncludedMetricPatternPropertyDefinition()
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.
public BooleanPropertyDefinition getInvokeForInternalOperationsPropertyDefinition()
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.
public ClassPropertyDefinition getJavaClassPropertyDefinition()
Specifies the fully-qualified name of the Java class that provides the plug-in implementation.
public StringPropertyDefinition getMetricNamePrefixPropertyDefinition()
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.
public EnumPropertyDefinition<PluginCfgDefn.PluginType> getPluginTypePropertyDefinition()
Specifies the set of plug-in types for the plug-in, which specifies the times at which the plug-in is invoked.
public DurationPropertyDefinition getReportingIntervalPropertyDefinition()
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.