The CMS has a central repository for all Log information, including the Players which send back Log information with each collection from the CMS.
The Log is split into Channels, Functions and Pages for easy searching. Each unique request has a runNo to group messages together.
The Log page is located under the Advanced section of the Menu.
Fields
| Field | Explanation |
|---|---|
| ID | A sequential ID of log messages |
| Run | The run identifier used to group messages generated by a single request |
| Date | The CMS date of the message |
| Channel | The Channel that the message relates to. |
| Function | The HTTP verb used in the request the generated the message, GET, POST, PUT, DELETE, HEAD. |
| Level | The severity of log message |
| Display | The display name, if the log message came from a Player |
| Page | The page requested - usually the route |
| Message | The log message |
Channels
| Channel | Explanation |
|---|---|
| WEB | The CMS Web Portal |
| API | The CMS API |
| XMDS | The CMS/Player API (Media Distribution) |
| AUTH | The oauth authorization server for the API |
| CONSOLE | XTR task running |
Finding your message
Understanding the log can be complicated in a busy system and it can often be hard to find messages related to your interest. The log can be filtered for this purpose, it is usually best to start with the Channel, then the Function and finally (if necessary) the Page.
Tip: For example, if an API call to the statistics search function is not working as expected the log can be searched for API, GET and
/stats.
Log location
The default log location is the database which can be viewed from the CMS log page. It may be desirable to log to a different location, depending on your use case.
The CMS supports adding new log handlers that confirm to the PSR log handler format - we recommend Monolog. To add log handlers simply append to the $logHandlers array in settings.php.
For example to add a file log handler:
$logHandlers = [new \Monolog\Handler\StreamHandler(PROJECT_ROOT . '/log.txt')];