Site Admin 25.2
Site Admin Installation Guide

# Configure Site Admin Logs

You can configure Site Admin to generate an `idol-access.log` file. This log stores information about all the actions Site Admin makes to Knowledge Discovery component ACI and service ports. It includes the following information:

- the user that sent the query.
- the IP address the user connected from.
- the component that the query was sent to (for example, QMS or Content)
- the host and port of the component.
- the full query that was sent to the component.
- the status code that the component returned.
- the time taken to complete the request.

The log also shows requests that failed without returning a HTTP status code (for example, because the component was turned off or blocked by a firewall).

You can turn on logging by setting the `idol.log.enabled` system property.

When you turn on logging, you can optionally turn off the information about time taken to complete requests by setting the `idol.log.timing.enabled` system property.

To turn on logging

- At the command line, send the java run command with the `idol.log.enabled` argument set to true. For example:

      java -Didol.log.enabled=true -Didol.idolsiteadmin.home=[home directory] -Dserver.port=[port] -jar siteadmin.jar

To turn off timing information in the logs

- At the command line, set the `idol.log.timing.enabled` property to false. For example:

      java -Didol.log.enabled=true -Didol.log.timing.enabled=false -Didol.idolsiteadmin.home=[home directory]  -Dserver.port=[port] -jar siteadmin.jar

If you run Site Admin as a service on Windows, you can also add the `idol.log.enabled` and `idol.log.timing.enabled` properties to the `siteadmin.xml` file.

If you run Site Admin as a service on Linux, you can add the argument to the existing arguments variable in `siteadmin.sh` for SysV, `siteadmin.conf` for Upstart, or `siteadmin.service` for systemd.

When you modify the Site Admin configuration by modifying the XML file or start scripts, you must restart Site Admin to apply your configuration changes.

On Upstart, you must also run `initctl reload-configuration` before you restart, to apply the init file changes. You can then run `service siteadmin restart` to restart the service.

## Use an Action ID

You can optionally configure Site Admin to include an action ID with each request it sends, which can help with tracking and troubleshooting.

When you enable action IDs, Site Admin generates the action ID with a UUID and a prefix, which you can configure. The default prefix is SiteAdmin-. For example, `SiteAdmin-b17a4a79-b3ed-4706-80a6-06404140e815`.

To use an action ID in requests

- At the command line, send the java run command with the `idol.log.actionid.enabled` argument set to true.

  Optionally set the `idol.log.actionid.prefix` argument to the prefix that you want to use for your action IDs. For example:

      java -Didol.log.actionid.enabled=true -Didol.log.actionid.prefix=SiteAdmin- -Didol.idolsiteadmin.home=[home directory]  -Dserver.port=[port] -jar siteadmin.jar

  TIP: This example turns on the action ID without turning on logging, which means that the action ID is displayed in Knowledge Discovery component request logs. To store the action ID in the Site Admin logs, you can also turn on logging, by adding the `idol.log.enabled` argument.

If you run Site Admin as a service on Windows, you can also add the `idol.log.actionid.enabled` and `idol.log.actionid.prefix` properties to the `siteadmin.xml` file.

If you run Site Admin as a service on Linux, you can add the argument to the existing arguments variable in `siteadmin.sh` for SysV, `siteadmin.conf` for Upstart, or `siteadmin.service` for systemd.

When you modify the Site Admin configuration by modifying the XML file or start scripts, you must restart Site Admin to apply your configuration changes.

On Upstart, you must also run `initctl reload-configuration` before you restart, to apply the init file changes. You can then run `service siteadmin restart` to restart the service.

Copyright 2015-2025 Open Text
Version 25.2 | Last updated April 2025

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to MFI-swpdl.idoldocsfeedback@opentext.com.

We appreciate your feedback!

Product: Site Admin 25.2

Topic Title: Configure Site Admin Logs