Page tree
Skip to end of metadata
Go to start of metadata

On this Page:

Structure of the Transaction Log

The transaction log contains the following information:

FieldDescription
Example
DateDate 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() Macro can contain a custom timestamp. This may result in log messages that are not sequential.
2018-06-06
TimeTime when request was received.08:02:45
Time ZoneTime zone offset+0200
Transaction IDUnique 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 IDUnique ID of request. It will be reset when restarting the xUML service.101
Component NameName of component that has been requested (not the name of the xUML service).urn:Services.SupportCase.SupportAPI.supportcases.GET
Elapsed Time

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 SERVICE_ENTER

    • reading the request data from the network

    • parsing the request body (e.g. SOAP)

  • after SERVICE_EXIT

    • creating the response (e.g. SOAP)

    • sending the response to the client

36

StateState is either OK or ERROR.OK
Domain
  • If an adapter has been called, the domain fields contains a value denoting the adapter, for instance SAPRFC, SQL, FILE, SYSAD, POP3, URL, etc.
  • If a service operation has been called, the value is INTERFACE.
  • If a log entry has been triggered by the user via the logger adapter, the value was defined in the UML model.

INTERFACE

Log Type
  • SERVICE_ENTER or SERVICE_EXIT marks the begin/end of a service call.
  • TRANSITION_ENTER or TRANSITION_EXIT marks the begin/end of persistent state transition handling.
  • DOACTION_ENTRY or DOACTION_EXIT marks the begin/end of a persistent state do activity.
  • IO_ENTER or IO_EXIT marks the begin/end of an IO operation, like e.g. an adapter call.
  • If the logger adapter triggered the log entry, the value is CUSTOM.

SERVICE_EXIT

Parameter 1 and 2
  • Parameters, for instance, if the file system adapter has been called, the first parameter corresponds to the executed action (e.g. ReadDirectory) and the second one to the specified file.
  • If the logger adapter triggered the log entry, the first parameter corresponds to the description defined as input for the adapter in the UML model.

anonymous 2.0.232.75

Correlation ID

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:

  • adapters sending a correlation ID: SOAP, URL, SMTP, SAPRFC, Persistent State
  • services receiving a correlation ID: SOAP, HTTP, SAP

For more information refer to the adapter pages.

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 LevelLog Types LoggedDescription
None
No logging executed.
CustomCUSTOM
Logs everything that is written by the logger adapter (for more details, see Log Adapter).
ServiceCUSTOM
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
SERVICE_ENTER
SERVICE_EXIT
TRANSITION_ENTER
TRANSITION_EXIT
DOACTION_ENTER
DOACTION_EXIT
IO_ENTER
IO_EXIT

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
SERVICE_ENTER
SERVICE_EXIT
TRANSITION_ENTER
TRANSITION_EXIT
DOACTION_ENTER
DOACTION_EXIT
IO_ENTER
IO_EXIT

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:

AdapterAdapter StereotypeDomainDocumentation Link
Log entries that concern the service itself
INTERFACE
Conversation<<E2ESendSignalAction>>
<<E2EAcceptEventAction>>
CONVERSATIONTransaction Logging of Conversations
File System Adapter<<FileSystemAdapter>>FILETransaction Logging of the File System Adapter
Java Adapter
JMS Adapter
<<JavaAdapter>>
<<JMSAdapter>>
<<E2EJMSListener>>
JAVATransaction Logging of the Java Adapter
Log Adapter<<Logger>>domain given by the adapter call in tagged value domainTransaction Logging of Log Adapter
Persistent States Adapter<<PersistentStateAdapter>>PSTATETransation Logging of the Persistent State Adapter
POP3 Adapter<<POP3Adapter>>POP3Transaction Logging of the POP3 Adapter
REST Adapter<<RESTAdapter>>RESTTransaction Logging of the REST Adapter
SAP Adapter<<SAPRFCAdapter>>
<<SAPTRFCAdapter>>
<<SAPTRFCCreateTransaction>>
<<SAPTRFCConfirmTransaction>>
SAPRFCTransaction Logging of the SAP Adapter
SMTP Adapter<<SMTPAdapter>>SMTPTransaction Logging of the SMTP Adapter
SOAP Adapter<<SOAPAdapter>>SOAPTransaction Logging of the SOAP Adapter
SQL Adapter<<SQLAdapter>>SQLTransaction Logging of the SQL Adapter
System Adapter<<SystemAdapter>>SYSADTransaction Logging of the System Adapter
URL Adapter<<URLAdapter>>URLTransaction Logging of the URL Adapter
ZIP Adapter<<ZIPAdapter>>ZIPTransaction Logging of the ZIP Adapter

Transaction Log xUML Service Adapter Details

Conversations

DomainStateParameter 1Parameter 2Correlation ID
Log Level: IOInternal
CONVERSATIONOKSend

conversation ID

(tick)
Receive conversation ID(tick)

File System Adapter

DomainComponentParameter 1StateParameter 2
Log Level: IOInternal
FILEname of the adapter action node

adapter action as defined on the adapter: read, readLine, write, createDirectory, readDirectory, status, remove, removeRecursively, rename, append, close

Example: createDirectory

OK path to file/directory
Example: ./tmp/testFile_dyn.txt
ERRORerror message
Example: Failed stating entry "./tmp/testFile_dyn.txt".
rename OK path to old file
Example: ./tmp/testFile_old.txt

Java Adapter

DomainComponentParameter 1StateParameter 2
Log Level: IOInternalIO_ENTERIO_EXIT
JAVAname of the adapter action nodeJavaAddOn.executeOK
ERROR
start
executed

JMS Adapter

The JMS adapter is used in combination with the Java adapter. Possible errors are logged with the Java adapter.

DomainComponentParameter 1StateParameter 2
Log Level: IOInternal
JAVAname of the adapter action nodeSendMessageAction.execute
ReceiveMessageAction.execute
OK
JMS connection
Example: tcp://localhost:61616

Log Adapter

DomainComponentAdapter ActionStateParameter 1Parameter 2
Log Level: Custom
as defined in tagged value domainname of the adapter action nodereportOKas defined in tagged value descriptionas defined in tagged value parameter

POP3 Adapter

DomainComponentAdapter ActionParameter 1Parameter 2
State OKState ERROR 
Log Level: IOExternal
POP3name of the adapter action nodegetMessageGetMail 

Mail host
Example:  linux.e2e.ch

Failed
deleteDeleteMail
commitcommit
rollbackRollback

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.

DomainComponentLog TypeStateParameter 1Parameter 2
Log Level: Service
PSTATEname of the persistent state classTRANSITION_ENTER
TRANSITION_EXIT
OKname of the transition

primary key of the persistent state object

DOACTION_ENTER
DOACTION_EXIT
OKinternal MagicDraw id of the do activityprimary key of the persistent state object

Log Level "IOInternal" for Bridge Console Actions

DomainControl Port ActionComponentParameter 1Parameter 2
Log Level: IOInternal
PSTATEretry of completion transitionbroadcastCompletionEvent<name of persistent state class><console user>
retry of completion transitioncreateCompletionEvent<name of persistent state class>:<unique object ID>
delete single PS objectdeleteObject<name of persistent state class>:<unique object ID>
show pstate data as raw objectgetObject<name of persistent state class>:<unique object ID>
show pstate data as raw objectgetObjectByKey<name of persistent state class>:<unique object ID>
list all PS classeslistAllClasses
list all PS classeslistClasses
list all PS objectslistObjects<name of persistent state class>
show instances for ownerlistOwners
assign objects to own service instancemoveOwnerMove owner from <ID of old owner> to <ID of new owner>
delete PS objectsreset
delete PS objectsresetAll
send signal to PS objectsendSignal<unique object ID>

Log Level "IOInternal" for xUML Service Actions

DomainComponentAdapter ActionParameter 1Parameter 2
IO_ENTER State OKIO_EXIT State OKIO_EXIT State ERROR
Log Level: IOInternal
PSTATE







name of the persistent state class







broadcast signalBroadcastsignal name

createCreateundefinedprimary key of the persistent state objectundefined
getObjectHandleGet handleunknownprimary key of the persistent state objectunknown
getObjectHandlesSearch handles
name of the persistent state class

getObjectCopyGet copyprimary key of the persistent state object

getStateInfoGet state infoprimary key of the persistent state object

commitCommitprimary key of the persistent state object

rollbackRollbackpimary key of the persistent state object

send signalSendsignal name

REST Adapter

DomainComponentParameter 1StateParameter 2
Log Level: IOExternal
RESTname of the adapter action nodeREST method, e.g. GET
OK
ERROR

REST URL

SAP Adapter

DomainComponentParameter 1StateParameter 2Correlation ID
Log Level: IOExternal
SAPRFCname of the adapter action nodeadapter operation
Example: RFC_SYSTEM_INFO
OK
ERROR
IP address of the SAP system
Example: 80.241.97.227
(tick)
SAPConnectionPool OpenConnectionOpen connection to SAP system.
CloseConnectionClose connection to SAP system.
PoolExhaustedNo connection available from the SAP connection pool.

SMTP Adapter

DomainComponentParameter 1StateParameter 2Correlation ID
Log Level:IOExternal
SMTPname of the adapter action nodeSend Mail
OK
SMTP host and correlation ID
Example: smtp.mail.net 00000002a28435030000387c00001adcd46ef793
(tick)
ERRORerror message
Example: <test3@e2e.ch>: Recipient address rejected: User unknown in local recipient table
(tick)

SOAP Adapter

DomainComponent NameParameter 1StateParameter 2Correlation ID
Log Level:IOExternal
SOAPname of the SOAP operation""OKURL(tick)
ERRORerror message

SQL Adapter

Adapter Call

DomainAdapter ActionParameter 1
Log Level:IOExternal
SQLexecuteSQL action as defined in the SQL statement:
select, insert, update, commit, rollback or stored procedure name
Example: INSERT
fetchfetch
closeHandlecloseHandle
Log Level: IOInternal
SQLimplicit actionconnectEstablish a connection to the database.
PRAGMAApply a PRAGMA statment to the database connection.
disable autocommitDisable autocommit on this database connection.
set transaction isolation level toSet 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.
disconnectDisconnect from the database.

States

DomainStateParameter 2
SQLOKname and path of the SQL database the action has been performed on
Example: ..\resource\Employee.sqlite
ERRORerror message
Example: SQLAPI exception

System Adapter

DomainComponent NameParameter 1StateParameter 2
Log Level: IOInternal
SYSADname of the adapter action nodeExecuteOKcomponent name

URL Adapter

DomainParameter 1StateParameter 2Correlation ID
Log Level: IOExternal
URLURL method
Example: GET
OKURL
Example: http://www.e2ebridge.com/BridgeFiles/bridging_in_a_nutshell.htm
(tick)

ERROR-

ZIP Adapter

DomainParameter 1StateParameter 2
Log Level: IOInternal
ZIPZipOKname of the ZIP file
ERROR-

Transaction Log Service Implementation Details

HTTP Service

DomainComponentLog TypeTransaction IDStateParameter 1Parameter 2Correlation ID
Log Level: Service
INTERFACEmodel path to the HTTP operation
Example: urn:Services.SimpleHTTPService.SimpleHTTPPort.echo
SERVICE_ENTER
HTTP header X-Transaction-ID if presentOKanonymousIP 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_EXITHTTP header X-Transaction-ID
or unique id if not present

Java Callback Service

DomainComponentLog TypeStateParameter 1Parameter 2
Log Level: Service
INTERFACEmodel path to the callback operation
Example: urn:Services.HelloBridgeService.HelloBridgePort.sendText
SERVICE_ENTER
SERVICE_EXIT
OKanonymousIP address of the caller
Example: 1700:e84e:

REST Service

DomainComponentLog TypeTransaction IDStateParameter 1Parameter 2Correlation ID
Log Level: Service
INTERFACEmodel path to the REST operation
Example: urn:Services.SupportCase.SupportAPI.supportcases.POST
SERVICE_ENTER
HTTP header X-Transaction-ID if presentOKanonymousIP 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_EXITHTTP header X-Transaction-ID
or unique id if not present

SAP Service

DomainComponentLog TypeStateParameter 1Parameter 2
Log Level: Service
INTERFACEmodel path to the SAPRFC operation
Example: urn:Services.RFCServerExample.CalculatorPort.Z_RFC_SERVICES.Z_RFC_ADD
SERVICE_ENTER
SERVICE_EXIT
OKanonymousIP address of the caller
Example: 1700:e84e:

Scheduler Service

DomainComponentLog TypeStateParameter 1Parameter 2
Log Level: Service
INTERFACEmodel path to the scheuler.EXECUTE_SCHEDULER_DIAGRAM SERVICE_ENTER
SERVICE_EXIT
OKdefault 

-

SOAP Service

DomainComponentLog TypeTransaction IDStateParameter 1Parameter 2Correlation ID
Log Level: Service
INTERFACEmodel path to the SOAP operation
Example: urn:HelloWorldService.HelloWorldPort.helloWorldCreate
SERVICE_ENTER
HTTP header X-Transaction-ID if presentOKanonymousIP 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_EXITHTTP header X-Transaction-ID
or unique id if not present

Timer and Event Observer Service

DomainComponentLog TypeStateParameter 1Parameter 2
Log Level: Service
INTERFACEmodel path to the timer.EXECUTE_TIMER_DIAGRAM SERVICE_ENTER
SERVICE_EXIT
OKdefault 

-

Transaction Log System Log Details

DomainComponentLog TypeStateParameter 1Parameter 2
Log Level: Service
INTERFACE

request service status
rpcctrl.Status
SERVICE_ENTER
SERVICE_EXIT
OK anonymousIP address of the caller
Example: 1700:e84e::
request long running session threshold
rpcctrl.Sessions

SERVICE_ENTER
SERVICE_EXIT
OK SYSTEM 

reload changed tab files (e.g. due to changes to service preferences)
rpcctrl.Reload

SERVICE_ENTER
SERVICE_EXIT
OK anonymous

request service shutdown
rpcctrl.Shutdown

SERVICE_ENTER
SERVICE_EXIT
OK<user that has triggered the action>
Example: admin 

Transaction Log xUML Runtime API Details

DomainComponentLog TypeStateParameter 1Parameter 2
Log Level: Service
INTERFACE

urn:xUML_Controller.xUML Controller.<api resource path>.<request method>SERVICE_ENTER
SERVICE_EXIT
OK anonymousIP address of the caller
Example: 1700:e84e::
  • No labels