Pushing metrics to external monitoring tools - EnginFrame Administrator Guide
Supported monitoring toolsPrerequisitesConfigurationTroubleshooting

End of support notice: On September 25, 2025, AWS will discontinue support for NICE EnginFrame. After September 25, 2025, you will no longer be able to access the NICE EnginFrame console or NICE EnginFrame resources. For more information, visit this blog post.

Pushing metrics to external monitoring tools

EnginFrame can push its metrics to external monitoring tools through StatsD. StatsD is a network daemon that runs on the Node.js platform and listens for statistics that are provided by tools such as counters and timers. StatsD sends aggregates to one or more pluggable backend services, such as Amazon™ CloudWatch.

Supported monitoring tools

We support every monitoring tool that implements the StatsD backend service to forward metrics. For more information about available StatsD backend services, see Supported Backends in the StatsD README on the GitHub website.

Prerequisites

The following are required to configure EnginFrame to use StatsD to push metrics to an external monitoring tool.

  • A monitoring tool that StatsD supports.

  • A running StatsD instance that's configured to forward metrics to the monitoring tools in use. StatsD must be configured to use User Datagram Protocol (UDP). This is the default option. For more information about configuring StatsD, see Installation and Configuration in the StatsD README on the GitHub website.

Configuration

To configure EnginFrame to push metrics to a StatsD instance, you must configure the STATSD_ADDR and STATSD_PORT variables. These are located in the following configuration file: $EF_ROOT/plugins/admin/conf/admin.statistics.efconf.

In the following example configuration, StatsD is run locally on port 8125.

##########################################################################
# StatsD Server Configuration
##########################################################################

STATSD_ADDR=localhost
STATSD_PORT=8125

Troubleshooting

EnginFrame provides the $EF_LOGDIR/admin.log log file. You can use it to troubleshoot and diagnose errors.