Difference between revisions of "Log Files"

From Hornbill
Jump to navigation Jump to search
(Created page with "__NOTOC__Home > Administration > System > Monitor > Log Files == Introduction ==")
 
 
(22 intermediate revisions by the same user not shown)
Line 1: Line 1:
__NOTOC__[[Main Page|Home]] > [[Administration]] > [[System Administration | System]] > Monitor > Log Files
+
This document can now be found at its new location in the [https://docs.hornbill.com/esp-config/monitor/log-files/ Hornbill Document Library].
== Introduction ==
+
 
 +
[[file:hornbill-document-library.png|Hornbill Cloud|link=https://docs.hornbill.com/esp-config/monitor/log-files/]]
 +
<!--
 +
<div style="border:1px solid #90C0FF; background:#D0E0FF; width:99%; padding:4px; margin-bottom:10px;">
 +
__NOTOC__
 +
{| style="width:100%"
 +
|[[Main Page|Home]] > [[Administration]] > [[System Administration | System]] > Monitor > Log Files
 +
|style="text-align:right;"|[[:Category:Administration|Index]]
 +
|}
 +
</div>
 +
 
 +
{|style="width: 100%"
 +
|- valign="top"
 +
|style="width:73%"|
 +
==Introduction==
 +
For all the activity that takes place on Hornbill, including interaction by the users and the processing done by the platform on your instance.  This is the perfect place to go to when investigating either the success of an action taking place or for troubleshooting when things don't go right.
 +
|style="width:5%"|
 +
|
 +
 
 +
|}
 +
 
 +
== Log Files ==
 +
There are a number of different log files that are available for different aspects or areas of Hornbill.
 +
:* '''api.log'''
 +
:: View this log to see the different APIs that are being used and see how fast they are responding
 +
:* '''EspCrawler.log'''
 +
::
 +
:* '''EspDbTool.log'''
 +
::
 +
:* '''EspEventService.log'''
 +
::
 +
:* '''EspFileService.log'''
 +
::
 +
:* '''EspIndexerService.log'''
 +
:: View this log to see events and activities with the Indexes that are on your instance.
 +
:* '''EspInsightService.log'''
 +
::
 +
:* '''EspMailImporter.log'''
 +
:: View this log to monitor events related to connecting to your email server and the importing of emails from this service into Hornbill
 +
:* '''EspMailService.log'''
 +
:: View this log to monitor events related to your mailboxes and the processing of incoming and outgoing emails
 +
:* '''EspServerService.log'''
 +
:: View this log to monitor the main activity and events performed by users in the Hornbill Client
 +
 
 +
== View Log Files ==
 +
Clicking on any of the available log files will give you access to all the transactions being recorded for that particular log file.
 +
 
 +
=== Filters ===
 +
The log files can be filled with important information that includes both successful transactions as well as errors. 
 +
 
 +
:* '''Severity'''
 +
::A number of ''Severity Levels'' are provide to allow you to filter down on the type of transactions that are important to you.
 +
:::* '''''Emergency'''''
 +
:::* '''''Alert'''''
 +
:::* '''''Critical'''''
 +
:::* '''''Error'''''
 +
:::* '''''Warning'''''
 +
:::* '''''Notice'''''
 +
:::* '''''Information'''''
 +
:::* '''''Debug'''''
 +
 
 +
== Settings ==
 +
 
 +
:* '''Archiving'''
 +
:: There are a number of settings that will archive the log files when the associated Service is restarted on the instance.  These settings are accessible in Administration under System->Settings->Advanced
 +
 
 +
:::* '''''logging.EspEventService.archiveOnStart'''''
 +
:::: Set this to 'true' if you want the EspEventService log file to be archived when the service is started
 +
:::* '''''logging.EspFileService.archiveOnStart'''''
 +
:::: Set this to 'true' if you want the EspFileService log file to be archived when the service is started
 +
:::* '''''logging.EspIndexerService.archiveOnStart'''''
 +
:::: Set this to 'true' if you want the EspIndexerService log file to be archived when the service is started
 +
:::* '''''logging.EspInsightService.archiveOnStart'''''
 +
:::: Set this to 'true' if you want the EspInsightService log file to be archived when the service is started
 +
:::* '''''logging.EspMailService.archiveOnStart'''''
 +
:::: Set this to 'true' if you want the EspMailService log file to be archived when the service is started
 +
:::* '''''logging.EspServerService.archiveOnStart'''''
 +
:::: Set this to 'true' if you want the EspServerService log file to be archived when the service is started
 +
 
 +
[[Category:Administration]]
 +
-->
 +
[[Category:HDOC]]

Latest revision as of 20:03, 11 April 2024

This document can now be found at its new location in the Hornbill Document Library.

Hornbill Cloud