Monitoring

This page covers various monitoring capabilities provided by NCache, allowing you to track the performance and health of your cache clusters and their nodes. It includes support for third-party monitoring tools like Prometheus, SNMP, as well as built-in performance logging controls.

Prometheus Monitoring [Deprecated]

This section discusses the mechanisms through which you can monitor NCache clusters for the Prometheus third-party tool.

Promotheus Metrics Publishing

To start publishing metrics to the NCache Service, set the EnableMetricsPublishing tag to true. By default, the counters information is not uploaded to the NCache Service, but you can change this behavior, by setting the following tag in the Alachisoft.NCache.Service.dll.config to true:

<add key="NCacheServer.EnableMetricsPublishing" value="false" />

Prometheus Counter Monitoring

By default, the Prometheus agent is disabled, meaning you cannot monitor your cache clusters using Prometheus because it doesn't pull any metrics from the NCache Service. To allow the Prometheus agent to access metrics information from the NCache Service and monitor your cache cluster using its counters, set the following tag as true.

<add key="NCacheServer.EnablePrometheusMonitoring" value="false" />

Metric Server Port

NCache allows you to configure the port where you want to host the Prometheus agent to collect and view the metrics published by the NCache Service. The MetricServerPort tag can be used to configure this port. By default, the Prometheus agent is hosted on port 8255.

<add key="NCacheServer.MetricServerPort" value="8255" />

System Counter Monitoring

By default, System Counters Monitoring is disabled to reduce extra load when counter publishing is enabled. To monitor the System Counters, set the following tag to true.

<add key="NCacheServer.EnableSystemCountersMonitoring" value="false" />

Enable SNMP Monitoring

This tag allows you to enable and disable cache counter monitoring via SNMP through configurable tags.

<add key="NCacheServer.EnableSnmpMonitoring" value="true"/>

Set the NCacheServer.EnableSnmpMonitoring tag as true. It specifies whether the metrics collected from the NCache service should be published to the SNMP sub-agent or not. Its default value is false.

Performance Monitoring Settings

NCache provides configuration settings to manage the collection, logging, and archiving of performance counter data for running caches. These settings control how often data is collected, whether performance monitoring is enabled, and where logs are stored.

Perfmon Enable

The PerfmonEnable specifies whether to enable or disable performance monitoring. Set the value to true to enable logging.

<add key="NCacheServer.PerfmonEnable" value="True"/>

Perfmon Interval

The PerfmonInterval specifies the duration for each data collector set. After this interval, a new collector set is automatically created. The minimum value is 5.

<add key="NCacheServer.PerfmonInterval" value="30"/>

Perfmon Archive

The PerfmonArchive setting controls whether completed collector sets are archived for later viewing. Set this to true to enable archiving.

<add key="NCacheServer.PerfmonArchive" value="False"/>

Perfmon Log Path

The PerfmonLogPath specifies the optional path where the performance counter log files are saved. If this value is left empty, the default path is used for saving the logs.

<add key="NCacheServer.PerfmonLogPath" value=""/>

See Also

Monitor NCache using Prometheus
Logging