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

  • Set the Java system property idol.log.enabled 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

  • Set the Java system property idol.log.timing.enabled 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

For more information about using Java system properties, see Using Java System Properties.

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

  • Set the Java system property idol.log.actionid.enabled to true. Optionally set idol.log.actionid.prefix 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.

For more information about using Java system properties, see Using Java System Properties.