Skip Navigation
  1. BlackBerry Docs
  2. BlackBerry AtHoc
  3. BlackBerry AtHoc SDKs and APIs 7.9
  4. SDK Specification
  5. Diagnostic log
  6. Log diagnostic information

Log diagnostic information

This API allows a remote SDK client to log information useful for application and system diagnostic purposes. See SDK envelope request for more information.
The payload type is DIAGNOSTIC-LOG. The payload XML definition is: 
<diagnosticLog>
<type>Error</type>
<server>localhost</server>
<process>YourProcess</process>
<assembly>YourAssembly.exe</assembly>
<module>YourModule.cs</module>
<member>YourModuleMember</member>
<message>Your error message.</message>
<thread>ThreadName</thread>
<threadId>Thread ID</threadId>
<stackTrace/>
<exception/>
<customContext/>
<operationStack/>
<processId/>
</diagnosticLog>
Mandatory nodes
Node
Definition
<type>
Diagnostic log type. Possible values for the type field are:
  • Error
  • Warning
  • Information
  • Verbose
<message>
Diagnostic message the client application wants to log.
Optional nodes
Node
Definition
<server>
Client application’s host machine name or IP.
<process>
Client application’s process name.
<assembly>
Client application’s assembly name.
<module>
Client application’s module name.
<member>
Client application’s member method name.
<thread>
Name of the thread running in the client application.
<threadId>
ID of the thread running in the client application. Validated as 32-bit integer if provided, otherwise ignored.
<stackTrace>
Set the stack trace if available.
<exception>
Exception information if an exception occurred.
<customContext>
Client custom context.
<operationStack>
Client operation stack.
<processId>
Client’s process ID. Validated as 32-bit integer if provided, otherwise ignored.