Logging and tracing - Intergraph Smart API Manager - 5.0 - Help

Intergraph Smart API Manager Help

Language
English
Product
Intergraph Smart API Manager
Search by Category
Help
Smart API Manager Version
5.0

The underlying technology used by Smart APIs for logging and tracing is NLog, a free logging platform for .NET.

NLog configuration file

All configuration of NLog-based logging is done with a single XML configuration file. The file is typically called NLog.config and resides in the same folder as the configuration file for the Smart API on the web server.

Your access to the NLog configuration file is determined by your Smart API deployment. If deployed on-premises where you or a system administrator have access, you are able to modify the file. If you are using a Smart API deployed in the cloud, you might not be able to control the configuration.

The NLog configuration file defines targets to specify where messages are written and rules to control which target is used, based on the NLog level for the message.

Each rule is associated with a level describing its severity.

The NLog levels of severity are:

  • Trace - Very detailed log messages, potentially of a high frequency and volume.

  • Debug - Less detailed and/or less frequent debugging messages.

  • Info - Informational messages.

  • Warn - Warnings that do not appear to the user.

  • Error - Error messages.

  • Fatal - Fatal error messages, meaning that the application terminates.

For more information, see Log levels in the NLog documentation.

Out of the box, you can expect most Smart APIs to write files to a log folder, relative to the Smart API base folder on the web server.