Find 24.3

# Configure IDOL Logs

By default, Find generates an `idol-access.log` file, and uses it to log all the actions it makes to IDOL component ACI and service ports. The log information includes:

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

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

You can turn off IDOL logging by setting the `idol.log.enabled` system property. You can also turn off just the information about time taken to complete requests by setting the `idol.log.timing.enabled` system property.

To turn off IDOL logging

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

      java -Didol.log.enabled=false -Didol.find.home=[home directory] -Dserver.port=[port] -jar find.war

To turn off timing information in the IDOL logs

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

      java -Didol.log.timing.enabled=false -Didol.find.home=[home directory]  -Dserver.port=[port] -jar find.war

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

If you run Find as a service on Linux, you can add the argument to the existing arguments variable in `find.sh` for SystemV, `find.conf` for Upstart, or `find.service` for systemd.

When you modify the Find configuration by modifying the XML file or start scripts, you must restart Find 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 find restart` to restart the service.

## Use an Action ID

You can optionally configure Find to send an action ID to IDOL with each request, which can help with tracking and troubleshooting.

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

To use an action ID in IDOL 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=Find- -Didol.find.home=[home directory]  -Dserver.port=[port] -jar find.war

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

If you run Find as a service on Linux, you can add the argument to the existing arguments variable in `find.sh` for SystemV, `find.conf` for Upstart, or `find.service` for systemd.

When you modify the Find configuration by modifying the XML file or start scripts, you must restart Find 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 find restart` to restart the service.

Copyright 2015-2024 Open Text
Version 24.3 | Last updated June 2024

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: IDOL Find 24.3

Topic Title: Configure IDOL Logs