The Monitoring Endpoint configuration type provides the StatsD Endpoint type that you can use to transfer metrics data in the StatsD format.

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.

You configure the monitoring endpoint using the dsconfig command. When you configure the monitoring endpoint, you include:

  • The endpoint's hostname

  • The endpoint's port

  • A toggle to use TCP or UDP

  • A toggle to use SSL if you use TCP

The following example shows how to configure a new StatsD monitoring endpoint to send UDP data to localhost port 8125 using dsconfig.
dsconfig create-monitoring-endpoint \
    --type statsd \
    --endpoint-name StatsDEndpoint \
    --set enabled:true \
    --set hostname:localhost \
    --set server-port:8125 \
    --set connection-type:unencrypted-udp
If you are using the administrative console, perform the following steps.
  1. Click Show Advanced Configuration.
  2. In the Logging, Monitoring, and Notifications section, click Monitoring Endpoints.
  3. Click New Monitoring Endpoint.

You can send data to any number of monitoring endpoints.

The Stats Collector plugin controls the metrics used by the StatsD monitoring endpoint. To send metrics with the StatsD monitoring endpoint, you must enable the Stats Collector plugin. Also, you must configure the Stats Collector plugin to indicate the metrics to send.

To enable the Stats Collector plugin or to configure the type of data sent, use the dsconfig command or the administrative console. This example shows how to enable 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.

If you are using the administrative console, perform the following steps.
  1. Click Show Advanced Configuration.
  2. In the LDAP (Administration and Monitoring) section, click Plugin Root
  3. Edit the Stats Collector plugin.
After you enable the Stats Collector and create the StatsD monitoring endpoint, you can:
  • Use the data with Splunk as explained in Sending StatsD metrics to Splunk.
  • 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. Configure the PingAuthorize StatsD monitoring endpoint to use the correct host and port. The dsconfig create-monitoring-endpoint example above uses a host of localhost and a port of 8125. You can also set these values in the administrative console.