Configure Logging Options

Viewing and Exporting Logs

Orchid records a variety of diagnostic information to log files saved on the Orchid server's file system.  These logs are accessible via the Orchid user interface when logged in as a user who has the 'Administrator' role.


Configuring Log Locations

Orchid logs are saved to the following default locations depending on your server platform:

  • Windows: C:\Program Files\Orchid\bin
  • Linux: /var/log/orchid_server

You can modify this location by editing your Orchid properties file (instructions for Windows and Linux).  Add or modify an entry for "logger.dir" in your properties file.  For example:

logger.dir = C:\logs

To apply this change, restart Orchid (instructions for Windows and Linux).


Changing Logging Detail (Verbosity)

You can modify the amount of detail in Orchid's logs by editing your Orchid properties file (instructions for Windows and Linux).  Additionally, you can configure the amount of logs (in megabytes) that are retained before being deleted.  Increasing the amount of detail in your Orchid logs will reduce the total time span that your logs cover.  Add or modify the following properties to control these settings:

severity.file.default = debug
logs.total_size = 500

In the entries above, the value of severity.file.default may be one of the values listed below.  These levels are listed in ascending order, such that entries farther down in the list will result in increasingly more detailed logging.  For normal usage, a log level of "normal" is recommended:

  • critical
  • error
  • warning
  • notice
  • normal
  • debug
  • trace

The value of logs.total_size is specified in megabytes.  


Using syslog for Remote Logging

By default, Orchid records its logs to files located on the Orchid server.  Optionally, Orchid may also write logging information to either a local or remote syslog server.  To configure logging to a syslog server, you will need to add several lines to your Orchid properties file (instructions for Windows and Linux):

syslog.address =

This entry should contain the IP address or hostname of a remote syslog server, or the value "::local::" to write to the local syslog server on a Linux system.  If this entry is not present, syslog logging is disabled.

syslog.port = 514

This value specifies the UDP port to use when writing to a remote syslog server.  The default syslog port is 514.

severity.syslog.default = warning

This specifies the amount of detail to log via syslog.  See the list in the previous section for allowable options.

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request