PingDS 7.5.1

Graphite Monitor Reporter Plugin

The Graphite Monitor Reporter Plugin contains information needed to push server monitoring metrics into a Graphite server.

The Graphite server host/port must be configured as well as the metric name prefix (e.g. "opendj.example.com"). Zero or more white or black list regexp based metric filters can be configured as well as the reporting interval.

Parent

The Graphite Monitor Reporter Plugin object inherits from Plugin.

Graphite Monitor Reporter Plugin properties

You can use configuration expressions to set property values at startup time. For details, see Property value substitution.

Basic Properties Advanced Properties

enabled
excluded-metric-pattern
graphite-server
included-metric-pattern
metric-name-prefix
reporting-interval

invoke-for-internal-operations
java-class
plugin-type

Basic properties

Use the --advanced option to access advanced properties.

enabled

Synopsis

Indicates whether the plug-in is enabled for use.

Default value

None

Allowed values

true

false

Multi-valued

No

Required

Yes

Admin action required

None

Advanced

No

Read-only

No

excluded-metric-pattern

Synopsis

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

None

Allowed values

Any valid regular expression pattern which is supported by the java.util.regex.Pattern class (see https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/regex/Pattern.html for documentation about this class for Java 17).

Multi-valued

Yes

Required

No

Admin action required

None

Advanced

No

Read-only

No

graphite-server

Synopsis

The Graphite server address.

Description

When using an IPv6 address as the hostname, put brackets around the address as in "[IPv6Address]:port".

Default value

None

Allowed values

A host name or an IP address followed by a ":" and a port number.

Port number must be greater than 1 and less than 65535.

Multi-valued

No

Required

Yes

Admin action required

None

Advanced

No

Read-only

No

included-metric-pattern

Synopsis

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

None

Allowed values

Any valid regular expression pattern which is supported by the java.util.regex.Pattern class (see https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/regex/Pattern.html for documentation about this class for Java 17).

Multi-valued

Yes

Required

No

Admin action required

None

Advanced

No

Read-only

No

metric-name-prefix

Synopsis

The prefix that will be added to all metric names reported to Graphite.

Description

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

Allowed values

A string.

Multi-valued

No

Required

No

Admin action required

None

Advanced

No

Read-only

No

reporting-interval

Synopsis

The interval between successive publications of server metrics to Graphite.

Description

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

Allowed values

Uses duration syntax.

Lower limit: 1 seconds.

Multi-valued

No

Required

No

Admin action required

None

Advanced

No

Read-only

No

Advanced properties

Use the --advanced option to access advanced properties.

invoke-for-internal-operations

Synopsis

Indicates whether the plug-in should be invoked for internal operations.

Description

Any plug-in that can be invoked for internal operations must ensure that it does not create any new internal operations that can cause the same plug-in to be re-invoked.

Default value

true

Allowed values

true

false

Multi-valued

No

Required

No

Admin action required

None

Advanced

Yes

Read-only

No

java-class

Synopsis

Specifies the fully-qualified name of the Java class that provides the plug-in implementation.

Default value

org.opends.server.plugins.GraphiteMonitorReporterPlugin

Allowed values

A Java class that extends or implements:

  • org.opends.server.api.plugin.DirectoryServerPlugin

Multi-valued

No

Required

Yes

Admin action required

None

Advanced

Yes

Read-only

No

plugin-type

Synopsis

Specifies the set of plug-in types for the plug-in, which specifies the times at which the plug-in is invoked.

Default value

startup

shutdown

Allowed values

  • initialization: Invoked at the initialization of the directory server.

  • intermediateresponse: Invoked before sending an intermediate response message to the client.

  • ldifimport: Invoked for each entry read during an LDIF import.

  • ldifimportbegin: Invoked at the beginning of an LDIF import session.

  • ldifimportend: Invoked at the end of an LDIF import session.

  • postcommitadd: Invoked after completing post-commit processing for an add operation.

  • postcommitdelete: Invoked after completing post-commit processing for a delete operation.

  • postcommitmodify: Invoked after completing post-commit processing for a modify operation.

  • postcommitmodifydn: Invoked after completing post-commit processing for a modify DN operation.

  • postconnect: Invoked whenever a new connection is established to the server.

  • postdisconnect: Invoked whenever an existing connection is terminated (by either the client or the server).

  • postoperationabandon: Invoked after completing the abandon processing.

  • postoperationadd: Invoked after completing the core add processing but before sending the response to the client.

  • postoperationbind: Invoked after completing the core bind processing but before sending the response to the client.

  • postoperationcompare: Invoked after completing the core compare processing but before sending the response to the client.

  • postoperationdelete: Invoked after completing the core delete processing but before sending the response to the client.

  • postoperationextended: Invoked after completing the core extended processing but before sending the response to the client.

  • postoperationmodify: Invoked after completing the core modify processing but before sending the response to the client.

  • postoperationmodifydn: Invoked after completing the core modify DN processing but before sending the response to the client.

  • postoperationsearch: Invoked after completing the core search processing but before sending the response to the client.

  • postoperationunbind: Invoked after completing the unbind processing.

  • postresponseadd: Invoked after sending the add response to the client.

  • postresponsebind: Invoked after sending the bind response to the client.

  • postresponsecompare: Invoked after sending the compare response to the client.

  • postresponsedelete: Invoked after sending the delete response to the client.

  • postresponseextended: Invoked after sending the extended response to the client.

  • postresponsemodify: Invoked after sending the modify response to the client.

  • postresponsemodifydn: Invoked after sending the modify DN response to the client.

  • postresponsesearch: Invoked after sending the search result done message to the client.

  • postsynchronizationadd: Invoked after completing post-synchronization processing for an add operation.

  • postsynchronizationdelete: Invoked after completing post-synchronization processing for a delete operation.

  • postsynchronizationmodify: Invoked after completing post-synchronization processing for a modify operation.

  • postsynchronizationmodifydn: Invoked after completing post-synchronization processing for a modify DN operation.

  • preoperationadd: Invoked prior to performing the core add processing.

  • preoperationbind: Invoked prior to performing the core bind processing.

  • preoperationcompare: Invoked prior to performing the core compare processing.

  • preoperationdelete: Invoked prior to performing the core delete processing.

  • preoperationextended: Invoked prior to performing the core extended processing.

  • preoperationmodify: Invoked prior to performing the core modify processing.

  • preoperationmodifydn: Invoked prior to performing the core modify DN processing.

  • preoperationsearch: Invoked prior to performing the core search processing.

  • preparseabandon: Invoked prior to parsing an abandon request.

  • preparseadd: Invoked prior to parsing an add request.

  • preparsebind: Invoked prior to parsing a bind request.

  • preparsecompare: Invoked prior to parsing a compare request.

  • preparsedelete: Invoked prior to parsing a delete request.

  • preparseextended: Invoked prior to parsing an extended request.

  • preparsemodify: Invoked prior to parsing a modify request.

  • preparsemodifydn: Invoked prior to parsing a modify DN request.

  • preparsesearch: Invoked prior to parsing a search request.

  • preparseunbind: Invoked prior to parsing an unbind request.

  • searchresultentry: Invoked before sending a search result entry to the client.

  • searchresultreference: Invoked before sending a search result reference to the client.

  • shutdown: Invoked during a graceful directory server shutdown.

  • startup: Invoked during the directory server startup process.

  • subordinatedelete: Invoked in the course of deleting a subordinate entry of a delete operation.

  • subordinatemodifydn: Invoked in the course of moving or renaming an entry subordinate to the target of a modify DN operation.

Multi-valued

Yes

Required

Yes

Admin action required

The object must be disabled and re-enabled for changes to take effect.

Advanced

Yes

Read-only

No
Copyright © 2010-2024 ForgeRock, all rights reserved.