Why Debug Logs Are Important
- 09 Nov 2022
-
DarkLight
-
PDF
Why Debug Logs Are Important
- Updated on 09 Nov 2022
-
DarkLight
-
PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
When the adapter is run with debug level logging, some very important logs come into the log files. These logs help you know exactly what is going on when communicating with the other system. This is true when the adapter is integrated with IAP but is also true when testing is run.
- OPTIONS – Provides all the call options; authentication information is missing as we intentionally do not want to log any credentials. This is one of the most helpful logs when determining why things are not working as expected.
- REQUEST – Provides the payload that will be sent to the other system.
- CALL RETURN – The raw response that is returned.
- RESPONSE – The response being returned (only first element if an array).
Example: Console Logs From Test
debug: Test-eai-connectorRest-performRequest: OPTIONS: {"hostname":"replace.hostorip.here","port":80,"path":"/oss-core-ws/rest/oci/site/1/cascadeDelete?fs=dynAttrs%2CderivedAttrs","method":"POST","headers":{"GS-Database-Host-Name":"localhost","GS-Database-Name":"db_0834e8bc13d2b3d7a","interactive":false,"Content-Type":"application/json","Accept":"application/json"}}
debug: Test-eai-connectorRest-performRequest:REQUEST: {"name":"BERKELE1.updated","type":"oci/site"}
If debugging authentication issues, you can also set auth_logging in the IAP Service Instance Configuration for the adapter to true. This will add two additional logs:
- FULL_REQUEST – Provides all the call options including any authentication headers and information on the url. This is one of the most helpful logs when determining why authentication is not working as expected.
- FULL_BODY – Provides the payload that will be sent to the other system. This includes the payload right before the request is made so it will include any authentication information added to the payload.
Note: Only set auth_logging true when debugging authentication issues and set it back to false once resolved so that credentials do not continue to appear in the logs.
Was this article helpful?