Enabling and configuring the Stats Collector Plugin

The Stats Collector Plugin controls the metrics used by the StatsD monitoring endpoint.

About this task

This topic applies only to the PingDirectory server.

To send metrics with the StatsD monitoring endpoint, enable the Stats Collector Plugin and configure the plugin to indicate which metrics to send.

Examples of metrics you can send are:

Busy worker thread count
Garbage collection statistics
Host system metrics such as CPU and memory

For a list of available metrics, use the interactive dsconfig menu for the Stats Collector Plugin or in the Administrative Console, edit the Stats Collector plugin, as explained in the second example.

Steps

To enable and configure the Stats Collector Plugin, use either of the following:

Choose from:

To use the command-line, run dsconfig with the set-plugin-prop option.

This example enables the Stats Collector Plugin to send host CPU metric, memory metrics, and server status metrics using dsconfig.

dsconfig set-plugin-prop \
    --plugin-name "Stats Collector" \
    --set enabled:true \
    --set host-info:cpu \
    --set host-info:disk \
    --set status-summary-info:basic

If you are not using Data Metrics Server to monitor your server, you can disable the generation of some metrics files that are not necessary for the StatsD Monitoring Endpoint. To do this, set the generate-collector-files property on the Stats Collector Plugin to false.

To use the Administrative Console:
1. From the Administrative Console, click Show Advanced Configuration.
2. In the LDAP (Administration and Monitoring) section, click Plugin Root.
3. Edit the Stats Collector plugin and select the configuration options to indicate which metrics to send.

Next steps

After you enable the Stats Collector and create the StatsD monitoring endpoint, you can:

Use the data with Splunk, as explained in Sending Metrics to Splunk with StatsD.
Configure other tools that support StatsD, such as CloudWatch or a Prometheus StatsD exporter, to use the data. For more information about this configuration, see your tool’s StatsD documentation.