Event Logging for Errors

When running a cache, error messages can be very helpful. These messages can be saved to a log file if required. Each time user enables error logging a new trace file is created in %NCHOME%\log-files (Windows) or /opt/ncache/log-files (Linux) by default, with the current time stamp.

Enabling error logging generates FATAL and NORMAL logs while enabling detailed error logging generates a log file containing INFO, DEBUG, and WARNING logs. By default, logging is disabled. Enabling "Detailed Error Logging" generates logs very frequently, which may affect the performance of the cache/cluster. In case of an error, it is reported in the application's Event Log in system.

Note

This feature is also available in NCache Professional.

Enable Event Logging for .NET

Using the NCache Management Center

  • Launch the NCache Management Center by browsing to http://localhost:8251 or <server-ip>:8251 on Windows and Linux.

  • In the left navigation bar, click on Clustered Caches or Local Caches, based on the cache to configure.

  • Against the cache name, click on View Details.

View Cache Details NCache

  • This opens up the detailed configuration page for the cache. Go to the Advanced Settings tab and click on Options in the left bar.

  • Check the Enable error logging checkbox.

  • If you want to enable detailed error logging, check the Enable detailed error logging checkbox. Specify the Log file path if you want to save these logs to a different path.

Error Logging NCache Management Center

  • Click on Save Changes to apply this configuration to the cache.

Manually Editing NCache Configuration

Important

Ensure the cache stops before making any configuration changes.

  • Enable/disable the logs through the config.ncconf by specifying the <logging> tag under the <cache-settings> tag:
 <cache-settings ...>
   <logging enable-logs="True" trace-errors="True" trace-notices="False" trace-warnings="False" trace-debug="False" log-path=""/>
</cache-settings>
  • For Client Logging, modify the values in client.ncconf of the client node:
<cache id="myreplicatedcache" load-balance="True" enable-client-logs="False" log-level="error">
      <server name="20.200.20.38"/>
</cache>
  • Once the changes are made, start the cache and restart the NCache service.

Enable Event Logging for Java Client

Logging in the NCache Java client can be controlled by setting the enableNCLogs property before initializing the cache.

System.setProperty("enableNCLogs", Level.INFO.toString());

The log file is generated in the application home directory. The above property will enable the logging of all INFO messages. It will also enable logging of SEVERE and WARNING messages.

The Level class (Java.util.logging) defines a set of standard logging levels that can be used to control logging output. The logging Level objects are ordered and are specified by ordered integers. Enabling logging at a given level also enables logging at all higher levels. Clients should use the predefined Level constants such as Level.SEVERE. The levels in descending order are as follows:

  • SEVERE (highest value)
  • WARNING
  • INFO
  • CONFIG
  • FINE
  • FINER
  • FINEST (lowest value)

In addition, there is a level OFF that can be used to turn off logging, and a level ALL that can be used to enable logging of all messages.

See Also

General Cache Settings
Cache Cluster Settings
Cache Level Events
Eviction Policy