You can configure IDOL Data Admin to generate an idol-access.log
file. This log stores information about all the actions it makes to IDOL component ACI and service ports. It includes the following information:
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 on IDOL 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 IDOL 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.dataadmin.home=[home directory] -Dserver.port=[port] -jar dataadmin.jar
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. To enable general IDOL logging, you must also set the idol.log.enabled
argument to true. For example:
java -Didol.log.enabled=true -Didol.log.timing.enabled=false -Didol.dataadmin.home=[home directory] -Dserver.port=[port] -jar dataadmin.jar
If you run IDOL Data Admin as a service on Windows, you can also add the idol.log.enabled
and idol.log.timing.enabled
properties to the dataadmin.xml
file.
If you run IDOL Data Admin as a service on Linux, you can add the argument to the existing arguments variable in the start scripts (dataadmin.sh
for SysV, dataadmin.conf
for Upstart, or dataadmin.service
for systemd).
When you modify the IDOL Data Admin configuration by modifying the XML file or start scripts, you must restart IDOL Data 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 dataadmin restart
to restart the service.
You can optionally configure IDOL Data Admin to send an action ID to IDOL with each request, which can help with tracking and troubleshooting.
When you enable action IDs, IDOL Data Admin generates the action ID with a UUID and a prefix, which you can configure. The default prefix is DataAdmin-. For example, DataAdmin-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=DataAdmin- -Didol.dataadmin.home=[home directory] -Dserver.port=[port] -jar dataadmin.jar
TIP: This example turns on the action ID without turning on logging, which means that the action ID is displayed in IDOL component GRL requests. To store the action ID in the logs, you can also turn on logging, by adding the idol.log.enabled
argument.
If you run IDOL Data Admin as a service on Windows, you can also add the idol.log.actionid.enabled
and idol.log.actionid.prefix
properties to the dataadmin.xml
file.
If you run IDOL Data Admin as a service on Linux, you can add the argument to the existing arguments variable in the start scripts (dataadmin.sh
for SysV, dataadmin.conf
for Upstart, or dataadmind.service
for systemd).
When you modify the IDOL Data Admin configuration by modifying the XML file or start scripts, you must restart IDOL Data 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 dataadmin restart
to restart the service.
|