Skip to main content

InterSystems IRIS SOAP Log

InterSystems IRIS SOAP Log

To log the SOAP calls made to or from an InterSystems IRIS namespace, set the following nodes of the ^ISCSOAP global in that namespace:

Node Purpose
^ISCSOAP("Log") Specifies the type of data to include in the log. Use one of the following case-sensitive values:
  • "i" — Log inbound messages.
  • "o" — Log outbound messages.
  • "s" — Log security information. Note that this option provides more detail than is generally contained in the SOAP fault, which is intentionally vague to prevent follow-on security attacks.
  • "h" — Log only SOAP headers. You must combine “h” with "i" and/or "o". When you use "h" with "i", the log includes only the SOAP Envelope and Header elements for inbound messages. Similarly, when you use "h" with "o", the log includes only the SOAP Envelope and Header elements for outbound messages. The corresponding SOAP Body elements are not logged.
  • "H" — Log HTTP headers. You must combine “H” with "i" and/or "o". When you use "H" with "i", the log includes HTTP headers for inbound messages. Similarly, when you use "H" with "o", the log includes HTTP headers for outbound messages. HTTP headers are logged in addition to any SOAP data.
You can also use a string that contains any combination of these values, for example: "iosh"
^ISCSOAP("LogFile") Specifies the complete path and filename of the log file to create.

The log indicates the sender or the recipient as appropriate, so that you can see which web service or client participated in the exchange.

The following shows a partial example of a log file with line breaks added for readability:


01/05/2010 13:27:02 *********************
Output from web client with SOAP action = http://www.mysecureapp.org/GSOAP.AddComplexSecureWS.Add
<?xml version="1.0" encoding="UTF-8" ?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV='http://schemas.xmlsoap.org/soap/envelope/' 
...
  <SOAP-ENV:Header>
      <Security xmlns="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
   
  </SOAP-ENV:Header>
  <SOAP-ENV:Body>
...
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>


**** Output HTTP headers for Web Client
User-Agent: Mozilla/4.0 (compatible; InterSystems IRIS;)
Host: hostid
Accept-Encoding: gzip


**** Input HTTP headers for Web Client
HTTP/1.1 200 OK
CACHE-CONTROL: no-cache
CONTENT-ENCODING: gzip
CONTENT-LENGTH: 479
CONTENT-TYPE: application/soap+xml; charset=UTF-8
...


01/05/2010 13:27:33 *********************
Input to web client with SOAP action = http://www.mysecureapp.org/GSOAP.AddComplexSecureWS.Add

ERROR #6059: Unable to open TCP/IP socket to server localhost:8080
string

Note the following points:

  • With InterSystems IRIS XML tools, you can validate signatures of signed XML documents and decrypt encrypted XML documents. If you perform these tasks in this namespace, the log contains details for them as well. See Using XML Tools.

  • The InterSystems IRIS SOAP log captures SOAP calls even when no message is sent on the wire (that is, when the service and client are both on a single machine).

  • If a severe error occurs, the system stops writing to the SOAP log. See the messages log instead. For information, see Monitoring Log Files in the Monitoring Guide.

  • The Task Manager CheckLogging task will create an alert if SOAP logging is left on for too long (by default, 2 days).

FeedbackOpens in a new tab