(9.0+) Management API logging

Management API generates the following log files:

debug
error

Management API's site.config is used to configure the following:

Where the active files are located
What log level to write logs
Name of the active log file and folder
Size of the active log file
Number of active log files to keep in the directory

Management API site.config File Location

This can be located on each server in the registry

HKEY_LOCAL_MACHINE\SOFTWARE\Virtual Hold
- InstallationLocation

The folder InstallationLocation is appended with \Managment API

example = C:\Program Files (x86)\Virtual Hold Technology\Management API

Important

When troubleshooting an issue, be sure to set the log level to the appropriate level to capture all the necessary information.

Debug logs

Here you will see actions performed within the System Management UI, email alerts being sent based on system status changes in System Management UI, and the data to be displayed in and the actions performed in the Licensing UI.

Management API site.config Logging Settings

{lager,[{handlers,{lager_file_backend, [{file,"C:/Program Files (x86)/Virtual Hold Technology/VHLogs/Logs/Management API/debug.log"},

{level,debug} | {size,10485760} | {date,"$D0"} | {count,5}]},


Description	Setting	Values	Default
File path where active logs should be written	file	*Any valid directory path	N/A
Log level to write active logs	level	**See table	N/A
Size of the active Log	size	Number in bytes	10 MB
Name of the active log folder	file	Text	N/A
Name of active log file	file	Text	N/A
How many active files to keep in the active directory	count	***Number	5
When to start a new active log file	date	****See lager docs	Everyday at Midnight -or- File size exceeded. Which ever occurs first

*Should always be the root for ALL log files.

**Debug level is the highest log level. It should not be set lower than this. Refer to lager documentation on other valid options. https://github.com/basho/lager


Log level	Included in logs
emergency
alert
critical
error
warning
notice
info
debug	Default. Should not be set lower than this

***Will only allow 5 files in the active directory at a time. Will delete files if Archive service has not archived the file.

****Set to always start a new log file at midnight regardless of size. Different options are available. Refer to lager documentation on other valid options. https://github.com/basho/lager

Here you will see error level messages logged by Management API. This is normally just when email alerts are sent by System Management when application status changes occur.

Management API site.config Logging Settings

{lager,{lager_file_backend, [{file,"C:/Program Files (x86)/Virtual Hold Technology/VHLogs/Logs/Management API/error.log

{level,error} | {size,10485760} | {date,"$D0"} | {count,5}]},


Description	Setting	Values	Default
File path where active logs should be written	file	*Any valid directory path	N/A
Log level to write active logs	level	**See table	N/A
Size of the active Log	size	Number in bytes	10 MB
Name of the active log folder	file	Text	N/A
Name of active log file	file	Text	N/A
How many active files to keep in the active directory	count	***Number	5
When to start a new active log file	date	****See lager docs	Everyday at Midnight -or- File size exceeded. Which ever occurs first

*Should always be the root for ALL log files.

**Error level is the lowest level Management API should log. It should not be set lower than this. Refer to lager documentation on other valid options. https://github.com/basho/lager


Log level	Included in logs
emergency
alert
critical
error	Default. Should not be set lower than this
warning
notice
info
debug

***Will only allow 5 files in the active directory at a time. Will delete files if Archive service has not archived the file.

****Set to always start a new log file at midnight regardless of size. Different options are available. Refer to lager documentation on other valid options. https://github.com/basho/lager