Understanding Visibility API Logging

If a working setup of Visibility API suddenly stops sending data from ACR to Insight, additional information on reasons for this may be located within the "api.log".

Configuring the API log

To configure the API log we will need to look at the "log4j.properties" located within the following directory :

<install_home>/VisAPI/config

This Visibility API property file details how the logging will behave. This includes the max file size of the log, how many times the log will "roll over", and what directory the log will be written to.

Reviewing the API log

The API log is formatted very similar to our Assure, Insight, ER and Perceive "igx.log". Troubleshooting may be performed in the same fashion.

1 ) Verify when the ACR job ran. Once a time has been determined, reviewing the "api.log" around the same timestamp details additional data on what may have caused the execution to not reach its endpoint within Insight.

2 ) Many ERROR's are self explanatory, though if a "#INS..." message is located, this may be cross referenced against ACR's "messages and codes" PDF.

ACR Messages and Codes Documentation

The "#INS..." message is similar to ACR's "#U..." message codes, though specifically defined for Visibility API. Utilizing this PDF when these messages are discovered provides additional information and steps that may be taken to resolve.