- Created by Kirstin Seidel-Gebert, last modified by Annegret Bernhardt on Jan 29, 2024
Structure of the Transaction Log
The transaction log contains the following information: Elapsed time, for each call (service calls, external or internal calls) in milliseconds. If the elapsed time is displayed as "0", the logged step has taken below 1 millisecond of time. The value of elapsed time does not contain: before reading the request data from the network parsing the request body (e.g. SOAP) after creating the response (e.g. SOAP) sending the response to the client Unique ID that relate an adapter call with the adapter response. The transaction log contains the first 40 characters of the correlation ID. A correlation ID is available for the following: For more information refer to the adapter pages.Field Description Example Date Date when request was received. Fields Date and Time are set automatically for system messages.
Custom log messages written with the Log Adapter or the report() Function can contain a custom timestamp. This may result in log messages that are not sequential.2018-06-06
Time Time when request was received. 08:02:45
Time Zone Time zone offset +0200
Transaction ID Unique ID of the transaction. It is used to trace service calls through the call stack (see Transaction ID). The transaction log contains the first 40 characters of the transaction ID. 00000002d3b0bdc0000069ce00ff9700ea65376f
Request ID Unique ID of request. 101
Component Name Name of component that has been requested (not the name of the xUML service). urn:Services.SupportCase.SupportAPI.supportcases.GET
Elapsed Time SERVICE_ENTER
SERVICE_EXIT
36
State State is either OK or ERROR. OK
Domain INTERFACE
Log Type SERVICE_EXIT
Parameter 1 and 2 anonymous 2.0.232.75
Correlation ID 00000011e33a4f8400004fc4000043ac9bc69bee
Log Levels
The following transaction log levels can be set for each selected xUML service. The higher the log level the more information will be written to the log files. The log levels in the table below are cumulative and are ordered from the lowest to the highest log level. For each log level, also the information of the lower levels is logged. How to view the log is described in xUML Service Transaction Log.
Log Level | Log Types Logged | Description |
---|---|---|
None | No logging executed. | |
Custom | CUSTOM | Logs everything that is written by the logger adapter (for more details, see Log Adapter). |
Service | CUSTOM SERVICE_ENTER SERVICE_EXIT TRANSITION_ENTER TRANSITION_EXIT DOACTION_ENTER DOACTION_EXIT | Additionally logs the start and the end of calls to a service operation (service interface). For example, calls to SOAP, SAPRFC, or HTTP operations. |
IOExternal | CUSTOM | Additionally logs calls of adapters that communicate with external systems like SAP, SQL, SOAP, etc. For instance, the SQL queries that are sent to the database will be logged as well. Calls via the file system and system adapter are excluded. |
IOInternal | CUSTOM | Additionally logs also calls of adapters to internal (local) resources (file system adapter and system adapter). |
Transaction Log Domains
Each adapter logs to a dedicated domain:
Transaction Log xUML Service Adapter Details
Conversations
Domain | State | Parameter 1 | Parameter 2 | Correlation ID | |||||
---|---|---|---|---|---|---|---|---|---|
Log Level: IOInternal | |||||||||
CONVERSATION | OK | Send | conversation ID | ||||||
Receive | conversation ID |
File System Adapter
Domain | Component | Parameter 1 | State | Parameter 2 |
---|---|---|---|---|
Log Level: IOInternal | ||||
FILE | name of the adapter action node | adapter action as defined on the adapter: Example: | OK
| path to file/directory Example: ./tmp/testFile_dyn.txt |
ERROR | error message Example: Failed stating entry "./tmp/testFile_dyn.txt". | |||
| OK
| path to old file Example: ./tmp/testFile_old.txt |
Java Adapter
Domain | Component | Parameter 1 | State | Parameter 2 | ||
---|---|---|---|---|---|---|
Log Level: IOInternal | IO_ENTER | IO_EXIT | ||||
JAVA | name of the adapter action node | JavaAddOn.execute | OK
|
start
| executed |
JMS Adapter
The JMS adapter is used in combination with the Java adapter. Possible errors are logged with the Java adapter.
Domain | Component | Transaction ID | Parameter 1 | State | Parameter 2 | Correlation ID |
---|---|---|---|---|---|---|
Log Level: IOInternal | ||||||
JAVA | name of the adapter action node | custom JMS header property xTransactionId if present (see JMS Adapter Reference for more information on custom JMS Adapter header fields) | SendMessageAction.execute | OK
| JMS connection Example:
tcp://localhost:61616
| JMSMessageID (for send and receive, not for listen) |
Log Adapter
Domain | Component | Adapter Action | State | Parameter 1 | Parameter 2 | ||||
---|---|---|---|---|---|---|---|---|---|
Log Level: Custom | |||||||||
as defined in tagged value domain | name of the adapter action node | report | OK | as defined in tagged value description | as defined in tagged value parameter |
POP3 Adapter
Domain | Component | Adapter Action | Parameter 1 | Parameter 2 | |
---|---|---|---|---|---|
State OK | State ERROR | ||||
Log Level: IOExternal | |||||
POP3 | name of the adapter action node | getMessage | GetMail | Mail host | Failed |
delete | DeleteMail | ||||
commit | commit | ||||
rollback | Rollback |
Persistent State Adapter
Log Level "Service"
The start of a transition/do activity (TRANSITION_ENTER
/DOACTION_ENTER
) is always logged with state OK
. If the transition/do activity fails, TRANSITION_EXIT
/DOACTION_EXIT
is logged with state ERROR
and the transition/do activity is rollbacked.
Domain | Component | Log Type | State | Parameter 1 | Parameter 2 |
---|---|---|---|---|---|
Log Level: Service | |||||
PSTATE | name of the persistent state class | TRANSITION_ENTER | OK | name of the transition | primary key of the persistent state object |
DOACTION_ENTER | OK | internal MagicDraw id of the do activity | primary key of the persistent state object |
Log Level "IOInternal" for Bridge Console Actions
Domain | Control Port Action | Component | Parameter 1 | Parameter 2 |
---|---|---|---|---|
Log Level: IOInternal | ||||
PSTATE | retry of completion transition | broadcastCompletionEvent | <name of persistent state class> | <console user> |
retry of completion transition | createCompletionEvent | <name of persistent state class>: <unique object ID> | ||
delete single PS object | deleteObject | <name of persistent state class>: <unique object ID> | ||
show pstate data as raw object | getObject | <name of persistent state class>: <unique object ID> | ||
show pstate data as raw object | getObjectByKey | <name of persistent state class>: <unique object ID> | ||
list all PS classes | listAllClasses | |||
list all PS classes | listClasses | |||
list all PS objects | listObjects | <name of persistent state class> | ||
show instances for owner | listOwners | |||
assign objects to own service instance | moveOwner | Move owner from <ID of old owner> to <ID of new owner> | ||
delete PS objects | reset | |||
delete PS objects | resetAll | |||
send signal to PS object | sendSignal | <unique object ID> |
Log Level "IOInternal" for xUML Service Actions
Domain | Component | Adapter Action | Parameter 1 | Parameter 2 | ||
---|---|---|---|---|---|---|
IO_ENTER State OK | IO_EXIT State OK | IO_EXIT State ERROR | ||||
Log Level: IOInternal | ||||||
PSTATE | name of the persistent state class | broadcast signal | Broadcast | signal name | ||
create | Create | undefined | primary key of the persistent state object | undefined | ||
getObjectHandle | Get handle | unknown | primary key of the persistent state object | unknown | ||
getObjectHandles | Search handles | name of the persistent state class | ||||
getObjectCopy | Get copy | primary key of the persistent state object | ||||
getStateInfo | Get state info | primary key of the persistent state object | ||||
commit | Commit | primary key of the persistent state object | ||||
rollback | Rollback | pimary key of the persistent state object | ||||
send signal | Send | signal name |
REST Adapter
Domain | Component | Parameter 1 | State | Parameter 2 |
---|---|---|---|---|
Log Level: IOExternal | ||||
REST | name of the adapter action node | REST method, e.g. GET | OK
| REST URL |
SAP Adapter
Domain | Component | Parameter 1 | State | Parameter 2 | Correlation ID | |
---|---|---|---|---|---|---|
Log Level: IOExternal | ||||||
SAPRFC | name of the adapter action node | adapter operation Example: RFC_SYSTEM_INFO | OK
| IP address of the SAP system Example: 80.241.97.227 | ||
| OpenConnection | Open connection to SAP system. | ||||
CloseConnection | Close connection to SAP system. | |||||
PoolExhausted | No connection available from the SAP connection pool. |
SMTP Adapter
Domain | Component | Parameter 1 | State | Parameter 2 | Correlation ID | |
---|---|---|---|---|---|---|
Log Level:IOExternal | ||||||
SMTP | name of the adapter action node | Send Mail | OK
| SMTP host and correlation ID Example: smtp.mail.net 00000002a28435030000387c00001adcd46ef793 | ||
ERROR | error message Example: <test3@e2e.ch>: Recipient address rejected: User unknown in local recipient table |
SOAP Adapter
Domain | Component Name | Parameter 1 | State | Parameter 2 | Correlation ID |
---|---|---|---|---|---|
Log Level:IOExternal | |||||
SOAP | name of the SOAP operation | "" | OK | URL | |
ERROR | error message |
SQL Adapter
Adapter Call | |||
Domain | Adapter Action | Parameter 1 | |
---|---|---|---|
Log Level:IOExternal | |||
SQL | execute | SQL action as defined in the SQL statement: select, insert, update, commit, rollback or stored procedure name Example: INSERT | |
fetch | fetch | ||
closeHandle | closeHandle | ||
Log Level: IOInternal | |||
SQL | implicit action | connect | Establish a connection to the database. |
PRAGMA | Apply a PRAGMA statment to the database connection. | ||
disable autocommit | Disable autocommit on this database connection. | ||
set transaction isolation level to | Set the database isolation level to the given value. | ||
commit (implicit) | Perform an implicit commit on the database transaction. | ||
rollback (implicit) | Perform an implicit rollback on the database transaction. | ||
isalive (implicit) | Test the database connection. | ||
disconnect | Disconnect from the database. | ||
States | |||
Domain | State | Parameter 2 | |
SQL | OK | name and path of the SQL database the action has been performed on Example:
| |
ERROR | error message Example: |
System Adapter
Domain | Component Name | Parameter 1 | State | Parameter 2 | |
---|---|---|---|---|---|
Log Level: IOInternal | |||||
SYSAD | name of the adapter action node | Execute | OK | component name |
URL Adapter
Domain | Parameter 1 | State | Parameter 2 | Correlation ID |
---|---|---|---|---|
Log Level: IOExternal | ||||
URL | URL method Example: GET | OK | URL Example: http://www.e2ebridge.com/BridgeFiles/bridging_in_a_nutshell.htm
| |
ERROR | - |
ZIP Adapter
Domain | Parameter 1 | State | Parameter 2 | |
---|---|---|---|---|
Log Level: IOInternal | ||||
ZIP | Zip | OK | name of the ZIP file | |
ERROR | - |
Transaction Log Service Implementation Details
HTTP Service
Domain | Component | Log Type | Transaction ID | State | Parameter 1 | Parameter 2 | Correlation ID |
---|---|---|---|---|---|---|---|
Log Level: Service | |||||||
INTERFACE | model path to the HTTP operation Example: urn:Services.SimpleHTTPService.SimpleHTTPPort.echo | SERVICE_ENTER | HTTP header X-Transaction-ID if present | OK | anonymous | IP address of the caller| HTTP header X-Sender-Host| HTTP header X-Sender-Service Example: 1700:e84e:|bridge2.scheer-acme.com|TestService | HTTP header X-Request-ID if present |
SERVICE_EXIT | HTTP header X-Transaction-ID or unique id if not present |
Java Callback Service
Domain | Component | Log Type | State | Parameter 1 | Parameter 2 |
---|---|---|---|---|---|
Log Level: Service | |||||
INTERFACE | model path to the callback operation Example: urn:Services.HelloBridgeService.HelloBridgePort.sendText | SERVICE_ENTER | OK | anonymous | IP address of the caller Example: 1700:e84e: |
REST Service
Domain | Component | Log Type | Transaction ID | State | Parameter 1 | Parameter 2 | Correlation ID |
---|---|---|---|---|---|---|---|
Log Level: Service | |||||||
INTERFACE | model path to the REST operation Example: urn:Services.SupportCase.SupportAPI.supportcases.POST | SERVICE_ENTER | HTTP header X-Transaction-ID if present | OK | anonymous | IP address of the caller| HTTP header X-Sender-Host| HTTP header X-Sender-Service Example: 1700:e84e:|bridge2.scheer-acme.com|TestService | HTTP header X-Request-ID if present |
SERVICE_EXIT | HTTP header X-Transaction-ID or unique id if not present |
SAP Service
Domain | Component | Log Type | State | Parameter 1 | Parameter 2 |
---|---|---|---|---|---|
Log Level: Service | |||||
INTERFACE | model path to the SAPRFC operation Example: urn:Services.RFCServerExample.CalculatorPort.Z_RFC_SERVICES.Z_RFC_ADD | SERVICE_ENTER | OK | anonymous | IP address of the caller Example: 1700:e84e: |
Scheduler Service
Domain | Component | Log Type | State | Parameter 1 | Parameter 2 |
---|---|---|---|---|---|
Log Level: Service | |||||
INTERFACE | model path to the scheuler.EXECUTE_SCHEDULER_DIAGRAM | SERVICE_ENTER | OK | default |
|
SOAP Service
Domain | Component | Log Type | Transaction ID | State | Parameter 1 | Parameter 2 | Correlation ID |
---|---|---|---|---|---|---|---|
Log Level: Service | |||||||
INTERFACE | model path to the SOAP operation Example: urn:HelloWorldService.HelloWorldPort.helloWorldCreate | SERVICE_ENTER | HTTP header X-Transaction-ID if present | OK | anonymous | IP address of the caller| HTTP header X-Sender-Host| HTTP header X-Sender-Service Example: 1700:e84e:|bridge2.scheer-acme.com|TestService | HTTP header X-Request-ID if present |
SERVICE_EXIT | HTTP header X-Transaction-ID or unique id if not present |
Timer and Event Observer Service
Domain | Component | Log Type | State | Parameter 1 | Parameter 2 |
---|---|---|---|---|---|
Log Level: Service | |||||
INTERFACE | model path to the timer.EXECUTE_TIMER_DIAGRAM | SERVICE_ENTER | OK | default |
|
Transaction Log System Log Details
Domain | Component | Log Type | State | Parameter 1 | Parameter 2 |
---|---|---|---|---|---|
Log Level: Service | |||||
INTERFACE | request service status
| SERVICE_ENTER | OK | anonymous | IP address of the caller Example: 1700:e84e:: |
request long running session threshold
| SERVICE_ENTER | OK | SYSTEM | ||
reload changed tab files (e.g. due to changes to service preferences) | SERVICE_ENTER | OK | anonymous | ||
request service shutdown | SERVICE_ENTER | OK | <user that has triggered the action> Example: admin |
Transaction Log xUML Runtime API Details
Domain | Component | Log Type | State | Parameter 1 | Parameter 2 |
---|---|---|---|---|---|
Log Level: Service | |||||
INTERFACE | urn:xUML_Controller.xUML Controller. <api resource path>. <request method> | SERVICE_ENTER | OK | anonymous | IP address of the caller Example: 1700:e84e:: |
- No labels