Difference between revisions of "DE4A Logs and error messages it2"

From DE4A
Jump to navigation Jump to search
 
(5 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
In order to standardise the errors and logs handled by each component, some conventions have been taken, as log patterns, error codes definition or messages content.
 
−
 
−
The information on this page should be used by each partner who develops a DE4A component, also it should be maintained to have a proper messages reference and be aware which information will include.
 
−
 
−
Apart from the usual reasons of the logging and error handling, in the DE4A project, there are 3 main bullet points on which the definition of messages is based:
 
−
 
−
* '''Kafka tracking''': messages sent to the [[Usage of third party specifications and components|Kafka]] server which can be previewed at: https://de4a.simplegob.com/package-tracker/#!detail
 
−
* '''Metrics logs''': messages marked with a special tag inside the common log file or logged on a separated file, which will be used to analyze and raise some metrics about each system
 
−
* '''Error convention''': standardise the error messages and codes
 
−
 
−
== Structure definition ==
 
−
This section will describe the hierarchy and model followed to build the different logs and messages. There are multiple patterns depending on the message nature, but the following tables will be a common reference to understand the rest of information collected in the page.
 
−
 
 
== General structure ==
 
== General structure ==
 
The log message follows the structure below:
 
The log message follows the structure below:
Line 23: Line 10:
 
* '''[message code]:''' 5-character string consisting of:
 
* '''[message code]:''' 5-character string consisting of:
  
−
Component code (2 letters) + Level code (1 letter) + Template (2 digits)
+
              Component code (2 letters) + Level code (1 letter) + Template (2 digits)
  
 
* '''[Logging participant ID]:''' composed of:
 
* '''[Logging participant ID]:''' composed of:
  
−
Acronym of the participant's name + ‘-’ + Two-letter country code
+
              Acronym of the participant's name + ‘-’ + Two-letter country code
  
 
* '''Specific text message:''' instance of the text message template that is referred to in the message code. In the case of messages logged by Data Evaluators and Data Owners (codes starting with DE and DO respectively), the text is preceded by [Use Case] that identifies the running use case.
 
* '''Specific text message:''' instance of the text message template that is referred to in the message code. In the case of messages logged by Data Evaluators and Data Owners (codes starting with DE and DO respectively), the text is preceded by [Use Case] that identifies the running use case.
 +
  
  
 
Details of the above mentioned parts of the log message are included below the following examples.
 
Details of the above mentioned parts of the log message are included below the following examples.
−
Example of a log message (''response'' message, ''INFO'' level, by a ''DT''):<blockquote>
+
 
 +
Example of a log message (''response'' message, ''INFO'' level, by a ''DT''):
 
  [2021-07-26T12:41:13.657Z] [INFO] [DTI07] [SGAD-ES] Evidence Response message received: ResponseExtractMultiEvidenceType - 2ecda60e-3824-4e92-a459-7c4a81258952 - iso6523-actorid-upis::9991:pt990000101 - iso6523-actorid-upis::9920:ess2833002e – (09754288-72b9-41d0-92b2-59f02506891c:<nowiki>urn:de4a-eu:CanonicalEvidenceType::HigherEducationDiploma:2.0</nowiki>, f0cbbb5f-45d6-4d1e-8be4-047c1ce2ae8b:DOE01)
 
  [2021-07-26T12:41:13.657Z] [INFO] [DTI07] [SGAD-ES] Evidence Response message received: ResponseExtractMultiEvidenceType - 2ecda60e-3824-4e92-a459-7c4a81258952 - iso6523-actorid-upis::9991:pt990000101 - iso6523-actorid-upis::9920:ess2833002e – (09754288-72b9-41d0-92b2-59f02506891c:<nowiki>urn:de4a-eu:CanonicalEvidenceType::HigherEducationDiploma:2.0</nowiki>, f0cbbb5f-45d6-4d1e-8be4-047c1ce2ae8b:DOE01)
−
</blockquote>Example of a log message (''response'' message ''ERROR'' level, by a ''DO''):<blockquote>
+
Example of a log message (''response'' message ''ERROR'' level, by a ''DO''):
 
  [2021-08-16T19:01:33.803Z] [ERROR] [DOE02] [MIZŠ-SI] [UC#1.1] Evidence not available yet (delayed)
 
  [2021-08-16T19:01:33.803Z] [ERROR] [DOE02] [MIZŠ-SI] [UC#1.1] Evidence not available yet (delayed)
−
</blockquote>ERROR level log messages should contain the same error code and text than the corresponding ErrorResponseItem within IEM response message:
+
ERROR level log messages should contain the same error code and text than the corresponding ErrorResponseItem within IEM response message:
 
{| class="wikitable"
 
{| class="wikitable"
−
!'''Log message'''
+
!'''Log message'''
 
!'''IEM Response message'''
 
!'''IEM Response message'''
 
!'''Example'''
 
!'''Example'''
 
|-
 
|-
−
|Message code
+
|Message code
−
|ErrorResponseItem/Code<span lang="EN-GB">The log
+
|ErrorResponseItem/Code
−
message follows the structure bellow:</span>
 
 
|DRE05
 
|DRE05
 
|-
 
|-
−
|Specific text
+
|Specific text
−
|ErrorResponseItem/Message<span lang="EN-GB">The log
+
|ErrorResponseItem/Message
−
message follows the structure bellow:</span>
+
|Missing or invalid arguments at {service requested}: {missing arguments}
−
|Missing or invalid arguments at {service requested}: {missing arguments}
 
 
|}
 
|}
  
Line 102: Line 89:
 
|WARN
 
|WARN
 
|W
 
|W
−
|To point out something unexpected that does not interrupt the functioning  
+
|To point out something unexpected that does not interrupt the functioning
 
|Internal logs (not to be collected)
 
|Internal logs (not to be collected)
 
|-
 
|-
Line 150: Line 137:
 
|I
 
|I
 
|01
 
|01
−
|Legacy IM Request message received: {MessageType} - {RequestID} - {DataEvaluator (ParticipantID)} - {DataOwner (ParticipantID)} - {CanonicalEvidenceTypeUri}
+
|Legacy IM Request message received: {MessageType} - {RequestID} - {DataEvaluator (ParticipantID)} - {DataOwner (ParticipantID)} - {CanonicalEvidenceTypeUri}
 
|-
 
|-
 
|DR
 
|DR
 
|I
 
|I
 
|02
 
|02
−
|IM Request message received: {MessageType} - {RequestID} - {DataEvaluator (ParticipantID)} - {DataOwner (ParticipantID)} - ({list (RequestItemID):(CanonicalEvidenceTypeUri)})
+
|IM Request message received: {MessageType} - {RequestID} - {DataEvaluator (ParticipantID)} - {DataOwner (ParticipantID)} - ({list (RequestItemID):(CanonicalEvidenceTypeUri)})
 
|-
 
|-
 
|DR
 
|DR
 
|I
 
|I
 
|03
 
|03
−
|USI Request message received: {MessageType} - {RequestID} - {DataEvaluator (ParticipantID)} - {DataOwner (ParticipantID)} - ({list (RequestItemID):(CanonicalEvidenceTypeUri)})
+
|USI Request message received: {MessageType} - {RequestID} - {DataEvaluator (ParticipantID)} - {DataOwner (ParticipantID)} - ({list (RequestItemID):(CanonicalEvidenceTypeUri)})
 
|-
 
|-
 
|DR
 
|DR
 
|I
 
|I
 
|04
 
|04
−
|Subscription Request message received: {MessageType} - {RequestID} - {DataEvaluator (ParticipantID)} - {DataOwner (ParticipantID)} - ({list (RequestItemID):(CanonicalEventCatalogUri)})
+
|Subscription Request message received: {MessageType} - {RequestID} - {DataEvaluator (ParticipantID)} - {DataOwner (ParticipantID)} - ({list (RequestItemID):(CanonicalEventCatalogUri)})
 
|-
 
|-
 
|DR
 
|DR
 
|I
 
|I
 
|05
 
|05
−
|LU Request message received: {MessageType} - {RequestID} - {DataEvaluator (ParticipantID)} - {DataOwner (ParticipantID)} - ({list (RequestItemID):(CanonicalEvidenceTypeUri)})
+
|LU Request message received: {MessageType} - {RequestID} - {DataEvaluator (ParticipantID)} - {DataOwner (ParticipantID)} - ({list (RequestItemID):(CanonicalEvidenceTypeUri)})
 
|-
 
|-
 
|DR
 
|DR
 
|I
 
|I
 
|06
 
|06
−
|Legacy IM Response message received: {MessageType} - {RequestID} - {DataEvaluator (ParticipantID)} - {DataOwner (ParticipantID)} - {CanonicalEvidenceTypeUri/ErrorCode}
+
|Legacy IM Response message received: {MessageType} - {RequestID} - {DataEvaluator (ParticipantID)} - {DataOwner (ParticipantID)} - {CanonicalEvidenceTypeUri/ErrorCode}
 
|-
 
|-
 
|DR
 
|DR
 
|I
 
|I
 
|07
 
|07
−
|Evidence Response message received: {MessageType} - {RequestID} - {DataEvaluator (ParticipantID)} - {DataOwner (ParticipantID)} - ({list (RequestItemID):(CanonicalEvidenceTypeUri/ErrorCode)})
+
|Evidence Response message received: {MessageType} - {RequestID} - {DataEvaluator (ParticipantID)} - {DataOwner (ParticipantID)} - ({list (RequestItemID):(CanonicalEvidenceTypeUri/ErrorCode)})
 
|-
 
|-
 
|DR
 
|DR
 
|I
 
|I
 
|08
 
|08
−
|Redirect User message received: {MessageType} - {RequestID} - {DataEvaluator (ParticipantID)} - {DataOwner (ParticipantID)} - {CanonicalEvidenceTypeUri} - {RedirectURL/ErrorCode}
+
|Redirect User message received: {MessageType} - {RequestID} - {DataEvaluator (ParticipantID)} - {DataOwner (ParticipantID)} - {CanonicalEvidenceTypeUri} - {RedirectURL/ErrorCode}
 
|-
 
|-
 
|DR
 
|DR
 
|I
 
|I
 
|09
 
|09
−
|Subscription Response message received: {MessageType} - {RequestID} - {DataEvaluator (ParticipantID)} - {DataOwner (ParticipantID)} - ({list (RequestItemID):(CanonicalEventCatalogUri/ErrorCode)})
+
|Subscription Response message received: {MessageType} - {RequestID} - {DataEvaluator (ParticipantID)} - {DataOwner (ParticipantID)} - ({list (RequestItemID):(CanonicalEventCatalogUri/ErrorCode)})
 
|-
 
|-
 
|DR
 
|DR
 
|I
 
|I
 
|10
 
|10
−
|Event Notification message received: {MessageType} - {NotificationID} - {DataEvaluator (ParticipantID)} - {DataOwner (ParticipantID)} - ({list (NotificationItemID):(CanonicalEventCatalogUri):(EventID)})
+
|Event Notification message received: {MessageType} - {NotificationID} - {DataEvaluator (ParticipantID)} - {DataOwner (ParticipantID)} - ({list (NotificationItemID):(CanonicalEventCatalogUri):(EventID)})
 
|-
 
|-
 
|DR
 
|DR
Line 205: Line 192:
 
|I
 
|I
 
|12
 
|12
−
|Querying SMP: {ParticipantID} - {DocumentTypeID} - {ProcessID}
+
|Querying SMP: {ParticipantID} - {DocumentTypeID} - {ProcessID}
 
|-
 
|-
 
|DR
 
|DR
Line 215: Line 202:
 
|E
 
|E
 
|01
 
|01
−
|Connection error with {destination component}: {inherited error message}
+
|Connection error with {destination component}: {inherited error message}
 
|-
 
|-
 
|DR
 
|DR
 
|E
 
|E
 
|02
 
|02
−
|Error on response from {error source component}: {inherited error message}
+
|Error on response from {error source component}: {inherited error message}
 
|-
 
|-
 
|DR
 
|DR
 
|E
 
|E
 
|03
 
|03
−
|Object conversion error in {error source component}: {inherited error message}
+
|Object conversion error in {error source component}: {inherited error message}
 
|-
 
|-
 
|DR
 
|DR
 
|E
 
|E
 
|04
 
|04
−
|Error accessing/saving data on {error source component}: {inherited error message}
+
|Error accessing/saving data on {error source component}: {inherited error message}
 
|-
 
|-
 
|DR
 
|DR
 
|E
 
|E
 
|05
 
|05
−
|Missing or invalid arguments at {service requested}: {missing arguments}
+
|Missing or invalid arguments at {service requested}: {missing arguments}
 
|-
 
|-
 
|DR
 
|DR
 
|E
 
|E
 
|06
 
|06
−
|Service requested {REST service requested} to {destination component} not found
+
|Service requested {REST service requested} to {destination component} not found
 
|-
 
|-
 
|DR
 
|DR
 
|E
 
|E
 
|07
 
|07
−
|Scheme validation failed for {MessageType}: {inherited error message}
+
|Scheme validation failed for {MessageType}: {inherited error message}
 
|-
 
|-
 
|DR
 
|DR
 
|E
 
|E
 
|08
 
|08
−
|Error occurred on AS4 Gateway to {destination component}: {inherited error message}
+
|Error occurred on AS4 Gateway to {destination component}: {inherited error message}
 
|}
 
|}
  
Line 263: Line 250:
 
|I
 
|I
 
|01
 
|01
−
|Legacy IM Request message received: {MessageType} - {RequestID} - {DataEvaluator (ParticipantID)} - {DataOwner (ParticipantID)} - {CanonicalEvidenceTypeUri}
+
|Legacy IM Request message received: {MessageType} - {RequestID} - {DataEvaluator (ParticipantID)} - {DataOwner (ParticipantID)} - {CanonicalEvidenceTypeUri}
 
|-
 
|-
 
|DT
 
|DT
 
|I
 
|I
 
|02
 
|02
−
|IM Request message received: {MessageType} - {RequestID} - {DataEvaluator (ParticipantID)} - {DataOwner (ParticipantID)} - ({list (RequestItemID):(CanonicalEvidenceTypeUri)})
+
|IM Request message received: {MessageType} - {RequestID} - {DataEvaluator (ParticipantID)} - {DataOwner (ParticipantID)} - ({list (RequestItemID):(CanonicalEvidenceTypeUri)})
 
|-
 
|-
 
|DT
 
|DT
 
|I
 
|I
 
|03
 
|03
−
|USI Request message received: {MessageType} - {RequestID} - {DataEvaluator (ParticipantID)} - {DataOwner (ParticipantID)} - ({list (RequestItemID):(CanonicalEvidenceTypeUri)})
+
|USI Request message received: {MessageType} - {RequestID} - {DataEvaluator (ParticipantID)} - {DataOwner (ParticipantID)} - ({list (RequestItemID):(CanonicalEvidenceTypeUri)})
 
|-
 
|-
 
|DT
 
|DT
 
|I
 
|I
 
|04
 
|04
−
|Subscription Request message received: {MessageType} - {RequestID} - {DataEvaluator (ParticipantID)} - {DataOwner (ParticipantID)} - ({list (RequestItemID):(CanonicalEventCatalogUri)})
+
|Subscription Request message received: {MessageType} - {RequestID} - {DataEvaluator (ParticipantID)} - {DataOwner (ParticipantID)} - ({list (RequestItemID):(CanonicalEventCatalogUri)})
 
|-
 
|-
 
|DT
 
|DT
 
|I
 
|I
 
|05
 
|05
−
|LU Request message received: {MessageType} - {RequestID} - {DataEvaluator (ParticipantID)} - {DataOwner (ParticipantID)} - ({list (RequestItemID):(CanonicalEvidenceTypeUri)})
+
|LU Request message received: {MessageType} - {RequestID} - {DataEvaluator (ParticipantID)} - {DataOwner (ParticipantID)} - ({list (RequestItemID):(CanonicalEvidenceTypeUri)})
 
|-
 
|-
 
|DT
 
|DT
 
|I
 
|I
 
|06
 
|06
−
|Legacy IM Response message received: {MessageType} - {RequestID} - {DataEvaluator (ParticipantID)} - {DataOwner (ParticipantID)} - {CanonicalEvidenceTypeUri/ErrorCode}
+
|Legacy IM Response message received: {MessageType} - {RequestID} - {DataEvaluator (ParticipantID)} - {DataOwner (ParticipantID)} - {CanonicalEvidenceTypeUri/ErrorCode}
 
|-
 
|-
 
|DT
 
|DT
 
|I
 
|I
 
|07
 
|07
−
|Evidence Response message received: {MessageType} - {RequestID} - {DataEvaluator (ParticipantID)} - {DataOwner (ParticipantID)} - ({list (RequestItemID):(CanonicalEvidenceTypeUri/ErrorCode)})
+
|Evidence Response message received: {MessageType} - {RequestID} - {DataEvaluator (ParticipantID)} - {DataOwner (ParticipantID)} - ({list (RequestItemID):(CanonicalEvidenceTypeUri/ErrorCode)})
 
|-
 
|-
 
|DT
 
|DT
 
|I
 
|I
 
|08
 
|08
−
|Redirect User message received: {MessageType} - {RequestID} - {DataEvaluator (ParticipantID)} - {DataOwner (ParticipantID)} - {CanonicalEvidenceTypeUri} - {RedirectURL/ErrorCode}
+
|Redirect User message received: {MessageType} - {RequestID} - {DataEvaluator (ParticipantID)} - {DataOwner (ParticipantID)} - {CanonicalEvidenceTypeUri} - {RedirectURL/ErrorCode}
 
|-
 
|-
 
|DT
 
|DT
 
|I
 
|I
 
|09
 
|09
−
|Subscription Response message received: {MessageType} - {RequestID} - {DataEvaluator (ParticipantID)} - {DataOwner (ParticipantID)} - ({list (RequestItemID):(CanonicalEventCatalogUri/ErrorCode)})
+
|Subscription Response message received: {MessageType} - {RequestID} - {DataEvaluator (ParticipantID)} - {DataOwner (ParticipantID)} - ({list (RequestItemID):(CanonicalEventCatalogUri/ErrorCode)})
 
|-
 
|-
 
|DT
 
|DT
 
|I
 
|I
 
|10
 
|10
−
|Event Notification message received: {MessageType} - {NotificationID} - {DataEvaluator (ParticipantID)} - {DataOwner (ParticipantID)} - ({list (NotificationItemID):(CanonicalEventCatalogUri):(EventID)})
+
|Event Notification message received: {MessageType} - {NotificationID} - {DataEvaluator (ParticipantID)} - {DataOwner (ParticipantID)} - ({list (NotificationItemID):(CanonicalEventCatalogUri):(EventID)})
 
|-
 
|-
 
|DT
 
|DT
Line 318: Line 305:
 
|I
 
|I
 
|12
 
|12
−
|Querying SMP: {ParticipantID} - {DocumentTypeID} - {ProcessID}
+
|Querying SMP: {ParticipantID} - {DocumentTypeID} - {ProcessID}
 
|-
 
|-
 
|DT
 
|DT
 
|E
 
|E
 
|01
 
|01
−
|Connection error with {destination component}: {inherited error message}
+
|Connection error with {destination component}: {inherited error message}
 
|-
 
|-
 
|DT
 
|DT
 
|E
 
|E
 
|02
 
|02
−
|Error on response from {error source component}: {inherited error message}
+
|Error on response from {error source component}: {inherited error message}
 
|-
 
|-
 
|DT
 
|DT
 
|E
 
|E
 
|03
 
|03
−
|Object conversion error in {error source component}: {inherited error message}
+
|Object conversion error in {error source component}: {inherited error message}
 
|-
 
|-
 
|DT
 
|DT
 
|E
 
|E
 
|04
 
|04
−
|Error accessing/saving data on {error source component}: {inherited error message}
+
|Error accessing/saving data on {error source component}: {inherited error message}
 
|-
 
|-
 
|DT
 
|DT
 
|E
 
|E
 
|05
 
|05
−
|Missing or invalid arguments at {service requested}: {missing arguments}
+
|Missing or invalid arguments at {service requested}: {missing arguments}
 
|-
 
|-
 
|DT
 
|DT
 
|E
 
|E
 
|06
 
|06
−
|Service requested {REST service requested} to {destination component} not found
+
|Service requested {REST service requested} to {destination component} not found
 
|-
 
|-
 
|DT
 
|DT
 
|E
 
|E
 
|07
 
|07
−
|Scheme validation failed for {MessageType}: {inherited error message}
+
|Scheme validation failed for {MessageType}: {inherited error message}
 
|-
 
|-
 
|DT
 
|DT
 
|E
 
|E
 
|08
 
|08
−
|Error occurred on AS4 Gateway to {destination component}: {inherited error message}
+
|Error occurred on AS4 Gateway to {destination component}: {inherited error message}
 
|}
 
|}
  
Line 381: Line 368:
 
|I
 
|I
 
|03
 
|03
−
|{APIMethod}: Generated DID invitation for edge agent with ID {UUID}.
+
|{APIMethod}: Generated DID invitation for edge agent with ID {UUID}.
 
|-
 
|-
 
|AA
 
|AA
Line 396: Line 383:
 
|I
 
|I
 
|06
 
|06
−
|{APIMethod}: Sent Verifiable Credential {VC Id} to the edge agent under invitation {UUID} from {DO URI}.
+
|{APIMethod}: Sent Verifiable Credential {VC Id} to the edge agent under invitation {UUID} from {DO URI}.
 
|-
 
|-
 
|AA
 
|AA
Line 421: Line 408:
 
|I
 
|I
 
|11
 
|11
−
|{APIMethod}: Received HTTP response code: {ResponseCode} from endpoint: {Endpoint}.
+
|{APIMethod}: Received HTTP response code: {ResponseCode} from endpoint: {Endpoint}.
 
|-
 
|-
 
|AA
 
|AA
 
|I
 
|I
 
|12
 
|12
−
|{APIMethod}: Processing the JSON response received from /{AriesAPIMethod}.
+
|{APIMethod}: Processing the JSON response received from /{AriesAPIMethod}.
 
|-
 
|-
 
|AA
 
|AA
 
|I
 
|I
 
|13
 
|13
−
|{APIMethod}: Stored current state in {Component} internal database.
+
|{APIMethod}: Stored current state in {Component} internal database.
 
|-
 
|-
 
|AA
 
|AA
Line 441: Line 428:
 
|I
 
|I
 
|15
 
|15
−
|{APIMethod}: Converted input evidence in format: {Format} to format: {Format}.
+
|{APIMethod}: Converted input evidence in format: {Format} to format: {Format}.
 
|-
 
|-
 
|AA
 
|AA
Line 466: Line 453:
 
|I
 
|I
 
|20
 
|20
−
|{APIMethod}: Received Verifiable Credential {VC Id} at the verifier {DE URI} under invitation {UUID}
+
|{APIMethod}: Received Verifiable Credential {VC Id} at the verifier {DE URI} under invitation {UUID}
 
|-
 
|-
 
|AA
 
|AA
 
|I
 
|I
 
|21
 
|21
−
|{APIMethod}: Validated Verifiable Credential {VC Id} of type {CanonicalEvidenceTypeUri} under invitation {UUID} for {DE URI}.
+
|{APIMethod}: Validated Verifiable Credential {VC Id} of type {CanonicalEvidenceTypeUri} under invitation {UUID} for {DE URI}.
 
|-
 
|-
 
|AA
 
|AA
 
|I
 
|I
 
|22
 
|22
−
|{APIMethod}: Sent Offer for Verifiable Credential {VC Id} of type {CanonicalEvidenceTypeUri} under invitation {UUID} from {DO URI}.
+
|{APIMethod}: Sent Offer for Verifiable Credential {VC Id} of type {CanonicalEvidenceTypeUri} under invitation {UUID} from {DO URI}.
 
|-
 
|-
 
|AA
 
|AA
 
|I
 
|I
 
|23
 
|23
−
|{Component}: Issuer DID has already been generated and registered in EBSI.
+
|{Component}: Issuer DID has already been generated and registered in EBSI.
 
|-
 
|-
 
|AA
 
|AA
Line 491: Line 478:
 
|I
 
|I
 
|25
 
|25
−
|{Component}: Successfully generated key: {KeyType}, value: {Value}.
+
|{Component}: Successfully generated key: {KeyType}, value: {Value}.
 
|-
 
|-
 
|AA
 
|AA
Line 502: Line 489:
 
|27
 
|27
 
|{Component}: Successfully imported DID document into Aries.
 
|{Component}: Successfully imported DID document into Aries.
 +
|-
 +
|AA
 +
|I
 +
|28
 +
|{APIMethod}: Overwriting DID connection with ID {old invitation ID} to {new invitation ID} .
 +
|-
 +
|AA
 +
|I
 +
|29
 +
|{APIMethod}: DID connection has been established for invitation ID {invitation ID}.
 +
|-
 +
|AA
 +
|I
 +
|30
 +
|{APIMethod}: Validated the issuer of the submitted VP.
 +
|-
 +
|AA
 +
|I
 +
|31
 +
|{APIMethod}: Validated the schema of the submitted VP.
 +
|-
 +
|AA
 +
|I
 +
|32
 +
|{APIMethod}: Event notification of type ‘{event type}’ has been successfully sent to {frontend URI}. Received HTTP response code: {response code}.
 +
|-
 +
|AA
 +
|I
 +
|33
 +
|{Component}: Successfully anchored DID {did} for organization {organization alias} into the EBSI DID Registry.
 
|-
 
|-
 
|AA
 
|AA
 
|E
 
|E
 
|01
 
|01
−
|Connection error with {destination component}: {inherited error message}
+
|Connection error with {destination component}: {inherited error message}
 
|-
 
|-
 
|AA
 
|AA
 
|E
 
|E
 
|02
 
|02
−
|Error on response from {error source component}: {inherited error message}
+
|Error on response from {error source component}: {inherited error message}
 
|-
 
|-
 
|AA
 
|AA
 
|E
 
|E
 
|03
 
|03
−
|Object conversion error in {error source component}: {inherited error message}
+
|Object conversion error in {error source component}: {inherited error message}
 
|-
 
|-
 
|AA
 
|AA
 
|E
 
|E
 
|04
 
|04
−
|Error accessing/saving data on {error source component}: {inherited error message}
+
|Error accessing/saving data on {error source component}: {inherited error message}
 
|-
 
|-
 
|AA
 
|AA
 
|E
 
|E
 
|05
 
|05
−
|Missing or invalid arguments at {service requested}: {missing arguments}
+
|Missing or invalid arguments at {service requested}: {missing arguments}
 
|-
 
|-
 
|AA
 
|AA
Line 547: Line 564:
 
|09
 
|09
 
|Configuration error occurred on {error source component}
 
|Configuration error occurred on {error source component}
 +
|-
 +
|AA
 +
|E
 +
|10
 +
|Event notification of type ‘{event type}’ could not be sent: {inherited error message}
 +
|-
 +
|AA
 +
|E
 +
|11
 +
|Event notification of type ‘{event type}’ could not be sent: {inherited error message}
 
|}
 
|}
  
Line 564: Line 591:
 
|I
 
|I
 
|02
 
|02
−
|[UseCase] DE4A pilot process successfully finished
+
|[UseCase] DE4A pilot process successfully finished
 
|-
 
|-
 
|DE
 
|DE
 
|E
 
|E
 
|03
 
|03
−
|[UseCase] Failed to establish user identity
+
|[UseCase] Failed to establish user identity
 
|-
 
|-
 
|DE
 
|DE
 
|E
 
|E
 
|04
 
|04
−
|[UseCase] Preview rejected by the User
+
|[UseCase] Preview rejected by the User
 
|}
 
|}
  
Line 587: Line 614:
 
|E
 
|E
 
|01
 
|01
−
|[UseCase] Error extracting evidence
+
|[UseCase] Error extracting evidence/subscription
 
|-
 
|-
 
|DO
 
|DO
 
|E
 
|E
 
|02
 
|02
−
|[UseCase] Evidence not available yet (delayed)
+
|[UseCase] Evidence/Subscription not available yet (delayed)
 
|-
 
|-
 
|DO
 
|DO
 
|E
 
|E
 
|03
 
|03
−
|[UseCase] Error in identity matching
+
|[UseCase] Error in identity matching
 
|-
 
|-
 
|DO
 
|DO
 
|E
 
|E
 
|04
 
|04
−
|[UseCase] Unsuccessful completion of preview
+
|[UseCase] Unsuccessful completion of preview
 
|-
 
|-
 
|DO
 
|DO
 
|E
 
|E
 
|05
 
|05
−
|[UseCase] Failed to re-establish user identity
+
|[UseCase] Failed to re-establish user identity
 
|-
 
|-
 
|DO
 
|DO
 
|E
 
|E
 
|06
 
|06
−
|[UseCase] Preview rejected by the User
+
|[UseCase] Preview rejected by the User
 
|-
 
|-
 
|DO
 
|DO
 
|E
 
|E
 
|07
 
|07
−
|[UseCase] Unsuccessful generation of the canonical evidence
+
|[UseCase] Unsuccessful generation of the canonical evidence/subscription
−
|}
 
−
 
 
−
=== - DEPRECATED ↓- ===
 
−
 
 
−
=== Layer ===
 
−
The layer concept will be used to name the system level where the message comes from.
 
−
{| class="wikitable"
 
−
|+
 
−
!Layer
 
−
!Layer Code
 
−
!Description
 
 
|-
 
|-
−
|Communications
+
|DO
−
|1
+
|E
−
|External connections/communications performed by the Connector
 
−
|-
 
−
|Internal failure
 
−
|2
 
−
|Internal failure of the Connector to be handled and stored in ErrorTypes wrapped in DE4A responses
 
−
|-
 
−
|Configuration
 
−
|3
 
−
|Unexpected situation due to a missing configuration paramater
 
−
|-
 
−
|Business
 
−
|4
 
−
|Unsuccessful situation on the business flow
 
−
|}
 
−
 
 
−
=== Module ===
 
−
A reference to each DE4A module possibly involved in an interaction. A "None" element has been included to represent the situation where a message occurs internally in a certain component.
 
−
{| class="wikitable"
 
−
|+
 
−
!Module Name
 
−
!Module Code
 
−
|-
 
−
|IDK
 
−
|01
 
−
|-
 
−
|SMP
 
−
|02
 
−
|-
 
−
|Connector DR
 
−
|03
 
−
|-
 
−
|Connector DT
 
−
|04
 
−
|-
 
−
|Data Owner
 
−
|05
 
−
|-
 
−
|Data Evaluator
 
−
|06
 
−
|-
 
−
|None
 
−
|00
 
−
|}
 
−
 
 
−
=== Type ===
 
−
It is mean to use just for the Connector log messages (metrics and [[Usage of third party specifications and components|Kafka]]).
 
−
{| class="wikitable"
 
−
|+
 
−
!Log Type
 
−
!Type code
 
−
|-
 
−
|Services
 
−
|01
 
−
|-
 
−
|Client
 
−
|02
 
−
|-
 
−
|AS4
 
−
|03
 
−
|}
 
−
 
 
−
=== Severity ===
 
−
Severity log messages.
 
−
{| class="wikitable"
 
−
|+
 
−
!Severity
 
−
!Severity code
 
−
|-
 
−
|DEBUG
 
−
|01
 
−
|-
 
−
|INFO
 
−
|02
 
−
|-
 
−
|WARNING
 
−
|03
 
−
|}
 
−
 
 
−
=== Error messages ===
 
−
As part of the logging standardisation, some error messages templates have been defined. Those messages will be thrown by each component with the corresponding parameterisation.
 
−
{| class="wikitable"
 
−
|+
 
−
!Error message
 
−
!Code
 
−
!Parameters
 
−
|-
 
−
|Service requested {0} not found
 
−
|01
 
−
|{0}: REST service requested
 
−
|-
 
−
|Arguments missing or invalid at {0} - {1}
 
−
|02
 
−
|{0}: Service requested
 
−
{1}: Missing arguments
 
−
|-
 
−
|Connection error with {0} - {1}
 
−
|03
 
−
|{0}: Module name
 
−
{1}: Inherited error message
 
−
|-
 
−
|Error on response from {0} - {1}
 
−
|04
 
−
|{0}: Module name
 
−
{1}: Inherited error message
 
−
|-
 
−
|Object conversion error on {0} - {1}
 
−
|05
 
−
|{0}: Module name
 
−
{1}: Inherited error message
 
−
|-
 
−
|Error accessing/saving data on {0} - {1}
 
−
|06
 
−
|{0}: Module name
 
−
{1}: Inherited error message
 
−
|-
 
−
|Scheme validation failed for {0} message - {1}
 
−
|07
 
−
|{0}: Message type
 
−
{1}: Inherited error message
 
−
|-
 
−
|Error occurred on AS4 Gateway to {0} - {1}
 
 
|08
 
|08
−
|{0}: Module name
+
|Connection error with {destination component}: {inherited error message}
−
{1}: Inherited error message
 
−
|-
 
−
|Failed to establish user identity
 
−
|09
 
−
|<nowiki>-</nowiki>
 
−
|-
 
−
|Error extracting evidence
 
−
|10
 
−
|<nowiki>-</nowiki>
 
−
|-
 
−
|Error in identity matching
 
−
|11
 
−
|<nowiki>-</nowiki>
 
−
|-
 
−
|Unsuccessful completion of preview
 
−
|12
 
−
|<nowiki>-</nowiki>
 
−
|-
 
−
|Preview rejected by user
 
−
|13
 
−
|<nowiki>-</nowiki>
 
−
|-
 
−
|Failed to re-establish user identity
 
−
|14
 
−
| -
 
−
|-
 
−
|Evidence  not available yet (delayed)
 
−
|15
 
−
|<nowiki>-</nowiki>
 
−
|-
 
−
|Unsuccessful  generation of the canonical evidence
 
−
|16
 
−
|<nowiki>-</nowiki>
 
−
|-
 
−
|DE4A pilot process started
 
−
|17
 
−
| -
 
−
|-
 
−
|DE4A pilot process finished
 
−
|18
 
−
| -
 
−
|}
 
−
'''Complementary syntaxis for the logs to be collected'''
 
−
{| class="wikitable"
 
−
![prefix]
 
−
 
 
−
(configurable)
 
−
![timestamp]
 
−
![Level]
 
−
![Error/Log Code]
 
−
![UC#]
 
−
![Origin]
 
−
![Destiny]
 
−
 
 
−
(optional)
 
−
![Message]
 
−
|-
 
−
|Static  value: DE4A METRICS
 
−
|YYYY-MM-DD  HH:MM:SS:mm (UTC)
 
−
|DEBUG, INFO, WARNING, FATAL
 
−
|To extract from this list
 
−
|Number to identify the pilot use case.
 
−
Options: 1.1, 1.2, 1.3, 2.1, 2.2, 3.1, 3.2, 3.3
 
−
|Entity where the message is originated
 
−
|Entity where the message is targeting
 
−
|Message extracted from the field Message in this tab
 
−
|}
 
−
Example of log to be collected for metric evaluation purposes:
 
−
DE4A METRICS - [2021-07-13 14:15:51:657] [INFO] [10104] [ ] [CONNECTOR DR] [CONNECTOR DT] Connection error with CONNECTOR DT - It is not possible to retrieve data from the SMP, either because of a connection problem or because it does not exist.
 
−
 
 
−
== Connector ==
 
−
Specific messages for the Connector. Each component around the Connector should be aware of the codes and content of these messages to act accordingly on each case.
 
−
 
 
−
=== Error messages ===
 
−
{| class="wikitable"
 
−
|+
 
−
!Layer
 
−
!#Layer
 
−
!Module
 
−
!#Module
 
−
!Error type
 
−
!#
 
−
!Error Code
 
−
|-
 
−
|Communications
 
−
|1
 
−
|None
 
−
|00
 
−
|Service requested {0} not found
 
−
|01
 
−
|10001
 
−
|-
 
−
|Communications
 
−
|1
 
−
|None
 
−
|00
 
−
|Scheme validation failed for {0}  message - {1}
 
−
|07
 
−
|10007
 
−
|-
 
−
|Communications
 
−
|1
 
−
|IDK
 
−
|01
 
−
|Service requested {0} not found
 
−
|01
 
−
|10101
 
−
|-
 
−
|Communications
 
−
|1
 
−
|IDK
 
−
|01
 
−
|Arguments missing or invalid at  {0} - {1}
 
−
|02
 
−
|10102
 
−
|-
 
−
|Communications
 
−
|1
 
−
|IDK
 
−
|01
 
−
|Error on response from {0} - {1}
 
−
|04
 
−
|10104
 
−
|-
 
−
|Communications
 
−
|1
 
−
|IDK
 
−
|01
 
−
|Connection error with {0} - {1}
 
−
|03
 
−
|10103
 
−
|-
 
−
|Communications
 
−
|1
 
−
|IDK
 
−
|01
 
−
|Scheme validation failed for {0}  message - {1}
 
−
|07
 
−
|10107
 
−
|-
 
−
|Communications
 
−
|1
 
−
|SMP
 
−
|02
 
−
|Error on response from {0} - {1}
 
−
|04
 
−
|10204
 
−
|-
 
−
|Communications
 
−
|1
 
−
|SMP
 
−
|02
 
−
|Service requested {0} not found
 
−
|01
 
−
|10201
 
−
|-
 
−
|Communications
 
−
|1
 
−
|SMP
 
−
|02
 
−
|Connection error with {0} - {1}
 
−
|03
 
−
|10203
 
−
|-
 
−
|Communications
 
−
|1
 
−
|SMP
 
−
|02
 
−
|Scheme validation failed for {0}  message - {1}
 
−
|07
 
−
|10207
 
−
|-
 
−
|Communications
 
−
|1
 
−
|Data Owner
 
−
|05
 
−
|Connection error with {0} - {1}
 
−
|03
 
−
|10503
 
−
|-
 
−
|Communications
 
−
|1
 
−
|Data Owner
 
−
|05
 
−
|Service requested {0} not found
 
−
|01
 
−
|10501
 
−
|-
 
−
|Communications
 
−
|1
 
−
|Data Owner
 
−
|05
 
−
|Error accessing/saving data on  {0} - {1}
 
−
|06
 
−
|10506
 
−
|-
 
−
|Communications
 
−
|1
 
−
|Data Owner
 
−
|05
 
−
|Error on response from {0} - {1}
 
−
|04
 
−
|10504
 
−
|-
 
−
|Communications
 
−
|1
 
−
|Data Owner
 
−
|05
 
−
|Scheme validation failed for {0}  message - {1}
 
−
|07
 
−
|10507
 
−
|-
 
−
|Communications
 
−
|1
 
−
|Data Evaluator
 
−
|06
 
−
|Service requested {0} not found
 
−
|01
 
−
|10601
 
−
|-
 
−
|Communications
 
−
|1
 
−
|Data Evaluator
 
−
|06
 
−
|Error on response from {0} - {1}
 
−
|04
 
−
|10604
 
−
|-
 
−
|Communications
 
−
|1
 
−
|Data Evaluator
 
−
|06
 
−
|Connection error with {0} - {1}
 
−
|03
 
−
|10603
 
−
|-
 
−
|Communications
 
−
|1
 
−
|Data Evaluator
 
−
|06
 
−
|Scheme validation failed for {0}  message - {1}
 
−
|07
 
−
|10607
 
−
|-
 
−
|Communications
 
−
|1
 
−
|Connector DR
 
−
|03
 
−
|Error occurred on AS4 Gateway to  {0} - {1}
 
−
|08
 
−
|10308
 
−
|-
 
−
|Communications
 
−
|1
 
−
|Connector DT
 
−
|04
 
−
|Error occurred on AS4 Gateway to  {0} - {1}
 
−
|08
 
−
|10408
 
−
|-
 
−
|Internal  failure
 
−
|2
 
−
|None
 
−
|00
 
−
|Object conversion error on {0} -  {1}
 
−
|05
 
−
|20005
 
−
|-
 
−
|Internal  failure
 
−
|2
 
−
|None
 
−
|00
 
−
|Error accessing/saving data on  {0} - {1}
 
−
|06
 
−
|20006
 
−
|-
 
−
|Internal  failure
 
−
|2
 
−
|None
 
−
|00
 
−
|Error occurred on AS4 Gateway to  {0} - {1}
 
−
|08
 
−
|20008
 
−
|-
 
−
|Internal  failure
 
−
|2
 
−
|None
 
−
|00
 
−
|Object conversion error on {0} -  {1}
 
−
|05
 
−
|20005
 
−
|-
 
−
|Configuration
 
−
|3
 
−
|None
 
−
|00
 
−
|Error occurred on AS4 Gateway to  {0} - {1}
 
−
|08
 
−
|30008
 
−
|}
 
−
 
 
−
=== Log messages ===
 
−
Messages meant to be sent to the [[Usage of third party specifications and components|Kafka]] server and also to be printed at the logging files of the Connector.
 
−
{| class="wikitable"
 
−
|+
 
−
!Message
 
−
!#Message
 
−
!Type
 
−
!#Type
 
−
!Parameters
 
−
!Log code
 
−
|-
 
−
|Legacy IM Request message received - Request ID: {0}, Canonical Evidence Type: {1}, Data  Evaluator: {2}, Data Owner: {3}
 
−
|00
 
−
|Services
 
−
|01
 
−
|{0}: RequestId
 
−
{1}: CanonicalEvidenceType
 
−
 
 
−
{2}: DataEvaluator
 
−
 
 
−
{3}: DataOwner
 
−
|0100
 
−
|-
 
−
|IM Request message received - Request ID: {0}, Canonical Evidence Type: {1}, Data  Evaluator: {2}, Data Owner: {3}
 
−
|01
 
−
|Services
 
−
|01
 
−
|{0}: RequestId
 
−
{1}: CanonicalEvidenceType
 
−
 
 
−
{2}: DataEvaluator
 
−
 
 
−
{3}: DataOwner
 
−
|0101
 
−
|-
 
−
|USI Request message received - Request ID: {0}, Canonical Evidence Type: {1}, Data  Evaluator: {2}, Data Owner: {3}
 
−
|02
 
−
|Services
 
−
|01
 
−
|{0}: RequestId
 
−
{1}: CanonicalEvidenceType
 
−
 
 
−
{2}: DataEvaluator
 
−
 
 
−
{3}: DataOwner
 
−
|0102
 
−
|-
 
−
|<s>RequestLookupRoutingInformation  message received - Canonical Evidence Type: {0}, Country Code: {1}, Data  Owner: {2}</s>
 
−
|03
 
−
|Services
 
−
|01
 
−
|{0}: CanonicalEvidenceType 
 
−
{1}: CountryCode
 
−
 
 
−
{2}: DataOwnerId
 
−
|0103
 
−
|-
 
−
|Subscription Request message received - Request ID: {0}, Canonical Evidence Type: {1}, Data  Evaluator: {2}, Data Owner: {3}
 
−
|04
 
−
|Services
 
−
|01
 
−
|{0}: RequestId
 
−
{1}: CanonicalEvidenceType
 
−
 
 
−
{2}: DataEvaluator
 
−
 
 
−
{3}: DataOwner
 
−
|0104
 
−
|-
 
−
|Event Notification message received - Request ID: {0}, Canonical Evidence Type: {1}, Data  Evaluator: {2}, Data Owner: {3}
 
−
|05
 
−
|Services
 
−
|01
 
−
|{0}: RequestId
 
−
{1}: CanonicalEvidenceType
 
−
 
 
−
{2}: DataEvaluator
 
−
 
 
−
{3}: DataOwner
 
−
|0105
 
−
|-
 
−
|Legacy IM Response Evidence message received - Request ID: {0}, Canonical Evidence Type: {1}, Data  Evaluator: {2}, Data Owner: {3}
 
−
|06
 
−
|Services
 
−
|01
 
−
|{0}: RequestId
 
−
{1}: CanonicalEvidenceType
 
−
 
 
−
{2}: DataEvaluator
 
−
 
 
−
{3}: DataOwner
 
−
|0106
 
−
|-
 
−
|Redirect User message received - Request ID: {0}, Canonical Evidence Type: {1}, Data  Evaluator: {2}, Data Owner: {3}
 
−
|07
 
−
|Services
 
−
|01
 
−
|{0}: RequestId
 
−
{1}: CanonicalEvidenceType
 
−
 
 
−
{2}: DataEvaluator
 
−
 
 
−
{3}: DataOwner
 
−
|0107
 
−
|-
 
−
|Response Evidence message received - Request ID: {0}, Canonical Evidence Type: {1}, Data  Evaluator: {2}, Data Owner: {3}
 
−
|08
 
−
|Services
 
−
|01
 
−
|{0}: RequestId
 
−
{1}: CanonicalEvidenceType
 
−
 
 
−
{2}: DataEvaluator
 
−
 
 
−
{3}: DataOwner
 
−
|0108
 
−
|-
 
−
|Looking for participant address - Participant Identifier: {0}, Endpoint type: {1}
 
−
|01
 
−
|Client
 
−
|02
 
−
|{0}: ParticipantId
 
−
{1}: Endpoint type
 
−
|0201
 
−
|-
 
−
|Sending {0} to the Data Evaluator - RequestId: {1}, DataEvaluatorId: {2}, DataOwnerId: {3}, Endpoint: {4}
 
−
|02
 
−
|Client
 
−
|02
 
−
|{0}: Response Type *
 
−
{1}: RequestId
 
−
 
 
−
{2}: DataEvaluatorId
 
−
 
 
−
{3}: DataOwnerId
 
−
 
 
−
{4}: Endpoint
 
−
|0202
 
−
|-
 
−
|Sending {0} to the Data Owner - RequestId: {1}, DataEvaluatorId: {2}, DataOwnerId: {3}, Endpoint: {4}
 
−
|03
 
−
|Client
 
−
|02
 
−
|{0}: Request Type *
 
−
{1}: RequestId
 
−
 
 
−
{2}: DataEvaluatorId
 
−
 
 
−
{3}: DataOwnerId
 
−
 
 
−
{4}: Endpoint
 
−
|0203
 
−
|-
 
−
|Sending  request to IDK - URL: {0}
 
−
|04
 
−
|Client
 
−
|02
 
−
|{0}: URL
 
−
|0204
 
−
|-
 
−
|Looking  for Data Owner address - Data Owner: {0}
 
−
|05
 
−
|Client
 
−
|02
 
−
|{0}: DataOwnerId
 
−
|0205
 
−
|-
 
−
|Data  Owner address not found - Data Owner: {0}
 
−
|06
 
−
|Client
 
−
|02
 
−
|{0}: DataOwnerId
 
−
|0206
 
−
|-
 
−
|Sending message via AS4 gateway - SenderId: {0}, ReceivedId: {1},  Canonical Evidence Type: {2}, MessageType: {3}
 
−
|01
 
−
|AS4
 
−
|03
 
−
|{0}: DataEvaluatorId
 
−
{1}: DataOwnerId
 
−
 
 
−
{2}: CanonicalEvidenceType
 
−
 
 
−
{3}: MessageType
 
−
|0301
 
−
|-
 
−
|Processing the request received via AS4 gateway
 
−
|02
 
−
|AS4
 
−
|03
 
−
|
 
−
|0302
 
−
|}
 
−
 
 
−
 
 
−
<big>*</big> '''Request Types:'''
 
−
 
 
−
* RequestTransferEvidenceIM
 
−
* RequestTransferEvidenceLU
 
−
* RequestTransferEvidenceUSI
 
−
 
 
−
* RequestEventSubscription
 
−
 
 
−
 
 
−
'''<big>*</big> Response Types:'''
 
−
 
 
−
* USIRedirectUser
 
−
 
 
−
* ResponseTransferEvidence
 
−
 
 
−
* ResponseEventSubscription
 
−
 
 
−
* EventNotification
 
−
 
 
−
'''Examples'''
 
−
* '''Kafka'''
 
−
 
 
−
2021-08-09 14:15:51:657: [de4a-connector-sgad] [INFO] RequestTransferEvidenceUSIDT message received - Request ID: 2ecda60e-3824-4e92-a459-7c4a81258952
 
−
 
 
−
* '''Internal log'''
 
−
 
 
−
[2021-07-13 14:15:51:657] [INFO] [0103] RequestTransferEvidenceUSIDT message received - Request ID: 2ecda60e-3824-4e92-a459-7c4a81258952 - Extra technical information (java source and execution thread)
 
−
== SSI Authority Agent ==
 
−
 
 
−
===Message types===
 
−
The Authority Agent implements a custom DE4A Logger, which is responsible for producing a pre-defined format of the log message. The Logger provides the following types of messages:
 
−
*'''Info'''
 
−
*'''Error'''
 
−
Those basic message categories are used to record success or failure of individual operations executed within each API method call.
 
−
====List of messages====
 
−
The messages currently logged by the Authority Agent are as follows:
 
−
 
 
−
'''Services - ('''''Info level)''
 
−
{| class="wikitable"
 
−
!Message
 
−
!#Message
 
−
!Type
 
−
!#Type
 
−
!Parameters
 
−
!Severity
 
−
!Log Code
 
−
|-
 
−
|{0}:  Received input eIDAS user data.
 
−
|01
 
−
|Client
 
−
|02
 
−
|{0}: APIMethod
 
−
|INFO
 
−
|0201
 
−
|-
 
−
|{0}:  Received input userId data.
 
−
|02
 
−
|Client
 
−
|02
 
−
|{0}: APIMethod
 
−
|INFO
 
−
|0202
 
−
|-
 
−
|{0}:  Generated DID invitation for edge agent.
 
−
|03
 
−
|Client
 
−
|02
 
−
|{0}: APIMethod
 
−
|INFO
 
−
|0203
 
−
|-
 
−
|{0}:  Received input evidence data.
 
−
|04
 
−
|Client
 
−
|02
 
−
|{0}: APIMethod
 
−
|INFO
 
−
|0204
 
−
|-
 
−
|{0}:  Signed a Verifiable Credential.
 
−
|05
 
−
|Client
 
−
|02
 
−
|{0}: APIMethod
 
−
|INFO
 
−
|0205
 
−
|-
 
−
|{0}:  Sent a Verifiable Credential to the edge agent.
 
−
|06
 
−
|Client
 
−
|02
 
−
|{0}: APIMethod
 
−
|INFO
 
−
|0206
 
−
|-
 
−
|{0}:  Accepted a submitted Verifiable Presentation.
 
−
|07
 
−
|Client
 
−
|02
 
−
|{0}: APIMethod
 
−
|INFO
 
−
|0207
 
−
|-
 
−
|{0}:  Decoded input eIDAS user data.
 
−
|08
 
−
|Client
 
−
|02
 
−
|{0}: APIMethod
 
−
|INFO
 
−
|0208
 
−
|-
 
−
|{0}:  Validated the digital signature of the submitted VP.
 
−
|09
 
−
|Client
 
−
|02
 
−
|{0}: APIMethod
 
−
|INFO
 
−
|0209
 
−
|-
 
−
|{0}:  Validated the subject of the submitted VP.
 
−
|10
 
−
|Client
 
−
|02
 
−
|{0}: APIMethod
 
−
|INFO
 
−
|0210
 
−
|-
 
−
|{0}:  Received HTTP response code: {1} from endpoint: {2}.
 
−
|01
 
−
|Services
 
−
|01
 
−
|{0}: APIMethod
 
−
{1}: ResponseCode
 
−
{2}: Endpoint
 
−
|INFO
 
−
|0101
 
−
|-
 
−
|{0}:  Processing the JSON response received from /{1}.
 
−
|02
 
−
|Services
 
−
|01
 
−
|{0}: APIMethod
 
−
{1}: AriesAPIMethod
 
−
|INFO
 
−
|0102
 
−
|-
 
−
|{0}:  Stored current state in {1} internal database.
 
−
|03
 
−
|Services
 
−
|01
 
−
|{0}: APIMethod
 
−
{1}: Component
 
−
|INFO
 
−
|0103
 
−
|-
 
−
|{0}:  Received user {1} status data.
 
−
|04
 
−
|Services
 
−
|01
 
−
|{0}: APIMethod
 
−
{1}: DataObject
 
−
|INFO
 
−
|0104
 
−
|-
 
−
|{0}:  Converted input evidence in format: {1} to format: {2}.
 
−
|05
 
−
|Services
 
−
|01
 
−
|{0}: APIMethod
 
−
{1}: Format
 
−
{2}: Format
 
−
|INFO
 
−
|0105
 
−
|-
 
−
|{0}:  Received response data PIID: {1}.
 
−
|06
 
−
|Services
 
−
|01
 
−
|{0}: APIMethod
 
−
{1}: PIID
 
−
|INFO
 
−
|0106
 
−
|-
 
−
|{0}:  Found a {1} action match with PIID: {2}.
 
−
|07
 
−
|Services
 
−
|01
 
−
|{0}: APIMethod
 
−
{1}: DataObject
 
−
{2}: PIID
 
−
|INFO
 
−
|0107
 
−
|-
 
−
|{0}:  Found a Verifiable Presentation with name: {1}.
 
−
|08
 
−
|Services
 
−
|01
 
−
|{0}: APIMethod
 
−
{1}: VPName
 
−
|INFO
 
−
|0108
 
−
|-
 
−
|{0}:  Found a Verifiable Presentation with ID: {1}.
 
−
|09
 
−
|Services
 
−
|01
 
−
|{0}: APIMethod
 
−
{1}: VPID
 
−
|INFO
 
−
|0109
 
−
|-
 
−
|{0}:  Issuer DID has already been generated and registered in EBSI.
 
−
|10
 
−
|Services
 
−
|01
 
−
|{0}: Component
 
−
|INFO
 
−
|0110
 
−
|-
 
−
|{0}:  Successfully created files for EBSI integration.
 
−
|11
 
−
|Services
 
−
|01
 
−
|{0}: Component
 
−
|INFO
 
−
|0111
 
−
|-
 
−
|{0}:  Successfully generated key: {1}, value: {2}.
 
−
|12
 
−
|Services
 
−
|01
 
−
|{0}: Component
 
−
{1}: KeyType
 
−
{2}: Value
 
−
|INFO
 
−
|0112
 
−
|-
 
−
|{0}:  Successfully exported JWK private key.
 
−
|13
 
−
|Services
 
−
|01
 
−
|{0}: Component
 
−
|INFO
 
−
|0113
 
−
|-
 
−
|{0}:  Successfully imported DID document into Aries.
 
−
|14
 
−
|Services
 
−
|01
 
−
|{0}: Component
 
−
|INFO
 
−
|0114
 
−
|}'''Errors''' – ''(Error level)''
 
−
 
 
−
The following list of error messages are recorded on the Communications, Internal failure and Configuration layers:
 
−
{| class="wikitable"
 
−
!Layer
 
−
!#Layer
 
−
!Module
 
−
!#Module
 
−
!Error type
 
−
!#
 
−
!Error Code
 
−
|-
 
−
|Communications
 
−
|1
 
−
|Authority Agent
 
−
|07
 
−
|Connection error with {0} - {1}
 
−
|03
 
−
|10703
 
−
|-
 
−
|Communications
 
−
|1
 
−
|Authority Agent
 
−
|07
 
−
|Error on response from {0} - {1}
 
−
|04
 
−
|10704
 
−
|-
 
−
|Communications
 
−
|1
 
−
|Authority Agent
 
−
|07
 
−
|Arguments missing or invalid at  {0} - {1}
 
−
|02
 
−
|10702
 
−
|-
 
−
|Internal  failure
 
−
|2
 
−
|Authority Agent
 
−
|07
 
−
|Object conversion error on {0} -  {1}
 
−
|05
 
−
|20705
 
−
|-
 
−
|Internal  failure
 
−
|2
 
−
|Authority Agent
 
−
|07
 
−
|Error accessing/saving data on  {0} - {1}
 
−
|06
 
−
|20706
 
−
|-
 
−
|Internal  failure
 
−
|2
 
−
|Authority Agent
 
−
|07
 
−
|Error generating {0} key.
 
−
|18
 
−
|20718
 
−
|-
 
−
|Internal  failure
 
−
|2
 
−
|Authority Agent
 
−
|07
 
−
|Error exporting JWK private key.
 
−
|19
 
−
|20719
 
−
|-
 
−
|Internal  failure
 
−
|2
 
−
|Authority Agent
 
−
|07
 
−
|Error importing DID document  into Aries.
 
−
|20
 
−
|20720
 
−
|-
 
−
|Configuration
 
−
|3
 
−
|Authority Agent
 
−
|07
 
−
|Configuration error occurred on  {0}
 
−
|17
 
−
|30717
 
−
|}
 
−
 
 
−
== Final participants DE/DO ==
 
−
The proposal includes specific messages to the final participants which would be part of the metrics and statistics collection. Some basic messages have been defined to identify the possible situations at the Data Evaluator and Data Owner's.
 
−
 
 
−
=== Error warning and local logs to collect ===
 
−
{| class="wikitable"
 
−
|+
 
−
!Layer
 
−
!#Layer
 
−
!Module
 
−
!#Module
 
−
!Error Type
 
−
!#Type
 
−
!To be displayed
 
−
!#Code
 
−
|-
 
−
|Business
 
−
|4
 
−
|Data Owner
 
−
|05
 
−
|Error extracting evidence
 
−
|10
 
−
|Y
 
−
|40510
 
−
|-
 
−
|Business
 
−
|4
 
−
|Data Owner
 
−
|05
 
−
|Evidence not available yet  (delayed)
 
−
|15
 
−
|Y
 
−
|40515
 
−
|-
 
−
|Business
 
−
|4
 
−
|Data Owner
 
−
|05
 
−
|Error in identity matching
 
−
|11
 
−
|Y
 
−
|40511
 
−
|-
 
−
|Business
 
−
|4
 
−
|Data Owner
 
−
|05
 
−
|Unsuccessful completion of  preview
 
−
|12
 
−
|Y
 
−
|40512
 
−
|-
 
−
|Business
 
−
|4
 
−
|Data Owner
 
−
|05
 
−
|Failed to re-establish user  identity
 
−
|14
 
−
|Y
 
−
|40514
 
−
|-
 
−
|Business
 
−
|4
 
−
|Data Owner
 
−
|05
 
−
|Preview rejected by user
 
−
|13
 
−
|N
 
−
|40513
 
−
|-
 
−
|Business
 
−
|4
 
−
|Data Evaluator
 
−
|06
 
−
|Failed to establish user  identity
 
−
|09
 
−
|Y
 
−
|40609
 
−
|-
 
−
|Business
 
−
|4
 
−
|Data Evaluator
 
−
|06
 
−
|Preview rejected by user
 
−
|13
 
−
|N
 
−
|40613
 
−
|-
 
−
|Business
 
−
|4
 
−
|Data Owner
 
−
|05
 
−
|Unsuccessful generation of the  canonical evidence
 
−
|16
 
−
|N
 
−
|40516
 
−
|-
 
−
|Business
 
−
|4
 
−
|Data Evaluator
 
−
|06
 
−
|DE4A pilot process started
 
−
|17
 
−
|N
 
−
|40617
 
−
|-
 
−
|Business
 
−
|4
 
−
|Data Evaluator
 
−
|06
 
−
|DE4A pilot process finished
 
−
|18
 
−
|N
 
−
|40618
 
 
|}
 
|}
 
[[Category:Wip]]
 
[[Category:Wip]]

Latest revision as of 12:09, 30 November 2022

General structure

The log message follows the structure below: 

[timestamp] [level] [message code] [logging participant ID] + Specific text message

Where:

  • [timestamp]: when the log message is written. ISO 8601 format with UTC time, e.g. [2022-07-26T12:41:13.666Z]
  • [level]: INFO, ERROR, WARN or DEBUG
  • [message code]: 5-character string consisting of:

              Component code (2 letters) + Level code (1 letter) + Template (2 digits)

  • [Logging participant ID]: composed of:

              Acronym of the participant's name + ‘-’ + Two-letter country code

  • Specific text message: instance of the text message template that is referred to in the message code. In the case of messages logged by Data Evaluators and Data Owners (codes starting with DE and DO respectively), the text is preceded by [Use Case] that identifies the running use case.


Details of the above mentioned parts of the log message are included below the following examples.

Example of a log message (response message, INFO level, by a DT): 

[2021-07-26T12:41:13.657Z] [INFO] [DTI07] [SGAD-ES] Evidence Response message received: ResponseExtractMultiEvidenceType - 2ecda60e-3824-4e92-a459-7c4a81258952 - iso6523-actorid-upis::9991:pt990000101 - iso6523-actorid-upis::9920:ess2833002e – (09754288-72b9-41d0-92b2-59f02506891c:urn:de4a-eu:CanonicalEvidenceType::HigherEducationDiploma:2.0, f0cbbb5f-45d6-4d1e-8be4-047c1ce2ae8b:DOE01)

Example of a log message (response message ERROR level, by a DO): 

[2021-08-16T19:01:33.803Z] [ERROR] [DOE02] [MIZŠ-SI] [UC#1.1] Evidence not available yet (delayed)

ERROR level log messages should contain the same error code and text than the corresponding ErrorResponseItem within IEM response message:

Log message IEM Response message Example
Message code ErrorResponseItem/Code DRE05
Specific text ErrorResponseItem/Message Missing or invalid arguments at {service requested}: {missing arguments}

Logging components and their codes

Specifies which component is logging the message.

Logging component Component code
Data Requestor DR
Data Transferor DT
SSI Authority Agent AA
Data Evaluator DE
Data Owner DO

Message severity and level code

Besides the severity of the message, the level determines where the messages SHOULD be sent. In Warning and Debug level messages, the “Specific text message” is freely defined.

Level Level code Meaning Destination
INFO I To inform on an event relevant for the system Logs for collection

Kafka server

ERROR E To inform on an error that interrupt the proper functioning DE4A response messages

Logs for collection

Kafka server

WARN W To point out something unexpected that does not interrupt the functioning Internal logs (not to be collected)
DEBUG D To help diagnose issues Internal logs (not to be collected)

Logging participant ID

Identifies the specific participant that is logging the message. It is compound of the following elements:

Acronym of the participant's name + ‘-’ + Two-letter country code’

The acronym refers to the participant that has deployed and is operating the corresponding component. In the case of the Connector, this is a configurable property whose value is set by the operator of the Connector themselves.

The acronym values must be taken from the DE4A Wiki page Useful information on pilots and participants.

Use case

Specific text in messages logged by Data Evaluator and Data Owner components (log messages with codes starting by “DE” and “DO” respectively) should be preceded by [Use Case], which corresponds to the specific DE4A use case running by such components:

Studying Abroad pilot Doing Business Abroad pilot Moving Abroad pilot
UC#1.1 UC#2.1 UC#3.1
UC#1.2 UC#2.2 UC#3.2
UC#1.3

Message catalogue

Data Requestor

Component Level Template Specific text message
DR I 01 Legacy IM Request message received: {MessageType} - {RequestID} - {DataEvaluator (ParticipantID)} - {DataOwner (ParticipantID)} - {CanonicalEvidenceTypeUri}
DR I 02 IM Request message received: {MessageType} - {RequestID} - {DataEvaluator (ParticipantID)} - {DataOwner (ParticipantID)} - ({list (RequestItemID):(CanonicalEvidenceTypeUri)})
DR I 03 USI Request message received: {MessageType} - {RequestID} - {DataEvaluator (ParticipantID)} - {DataOwner (ParticipantID)} - ({list (RequestItemID):(CanonicalEvidenceTypeUri)})
DR I 04 Subscription Request message received: {MessageType} - {RequestID} - {DataEvaluator (ParticipantID)} - {DataOwner (ParticipantID)} - ({list (RequestItemID):(CanonicalEventCatalogUri)})
DR I 05 LU Request message received: {MessageType} - {RequestID} - {DataEvaluator (ParticipantID)} - {DataOwner (ParticipantID)} - ({list (RequestItemID):(CanonicalEvidenceTypeUri)})
DR I 06 Legacy IM Response message received: {MessageType} - {RequestID} - {DataEvaluator (ParticipantID)} - {DataOwner (ParticipantID)} - {CanonicalEvidenceTypeUri/ErrorCode}
DR I 07 Evidence Response message received: {MessageType} - {RequestID} - {DataEvaluator (ParticipantID)} - {DataOwner (ParticipantID)} - ({list (RequestItemID):(CanonicalEvidenceTypeUri/ErrorCode)})
DR I 08 Redirect User message received: {MessageType} - {RequestID} - {DataEvaluator (ParticipantID)} - {DataOwner (ParticipantID)} - {CanonicalEvidenceTypeUri} - {RedirectURL/ErrorCode}
DR I 09 Subscription Response message received: {MessageType} - {RequestID} - {DataEvaluator (ParticipantID)} - {DataOwner (ParticipantID)} - ({list (RequestItemID):(CanonicalEventCatalogUri/ErrorCode)})
DR I 10 Event Notification message received: {MessageType} - {NotificationID} - {DataEvaluator (ParticipantID)} - {DataOwner (ParticipantID)} - ({list (NotificationItemID):(CanonicalEventCatalogUri):(EventID)})
DR I 11 Querying SML: {ParticipantID}
DR I 12 Querying SMP: {ParticipantID} - {DocumentTypeID} - {ProcessID}
DR I 13 Querying Central IAL: {query url}
DR E 01 Connection error with {destination component}: {inherited error message}
DR E 02 Error on response from {error source component}: {inherited error message}
DR E 03 Object conversion error in {error source component}: {inherited error message}
DR E 04 Error accessing/saving data on {error source component}: {inherited error message}
DR E 05 Missing or invalid arguments at {service requested}: {missing arguments}
DR E 06 Service requested {REST service requested} to {destination component} not found
DR E 07 Scheme validation failed for {MessageType}: {inherited error message}
DR E 08 Error occurred on AS4 Gateway to {destination component}: {inherited error message}

Data Transferor

Component Level Template Specific text message
DT I 01 Legacy IM Request message received: {MessageType} - {RequestID} - {DataEvaluator (ParticipantID)} - {DataOwner (ParticipantID)} - {CanonicalEvidenceTypeUri}
DT I 02 IM Request message received: {MessageType} - {RequestID} - {DataEvaluator (ParticipantID)} - {DataOwner (ParticipantID)} - ({list (RequestItemID):(CanonicalEvidenceTypeUri)})
DT I 03 USI Request message received: {MessageType} - {RequestID} - {DataEvaluator (ParticipantID)} - {DataOwner (ParticipantID)} - ({list (RequestItemID):(CanonicalEvidenceTypeUri)})
DT I 04 Subscription Request message received: {MessageType} - {RequestID} - {DataEvaluator (ParticipantID)} - {DataOwner (ParticipantID)} - ({list (RequestItemID):(CanonicalEventCatalogUri)})
DT I 05 LU Request message received: {MessageType} - {RequestID} - {DataEvaluator (ParticipantID)} - {DataOwner (ParticipantID)} - ({list (RequestItemID):(CanonicalEvidenceTypeUri)})
DT I 06 Legacy IM Response message received: {MessageType} - {RequestID} - {DataEvaluator (ParticipantID)} - {DataOwner (ParticipantID)} - {CanonicalEvidenceTypeUri/ErrorCode}
DT I 07 Evidence Response message received: {MessageType} - {RequestID} - {DataEvaluator (ParticipantID)} - {DataOwner (ParticipantID)} - ({list (RequestItemID):(CanonicalEvidenceTypeUri/ErrorCode)})
DT I 08 Redirect User message received: {MessageType} - {RequestID} - {DataEvaluator (ParticipantID)} - {DataOwner (ParticipantID)} - {CanonicalEvidenceTypeUri} - {RedirectURL/ErrorCode}
DT I 09 Subscription Response message received: {MessageType} - {RequestID} - {DataEvaluator (ParticipantID)} - {DataOwner (ParticipantID)} - ({list (RequestItemID):(CanonicalEventCatalogUri/ErrorCode)})
DT I 10 Event Notification message received: {MessageType} - {NotificationID} - {DataEvaluator (ParticipantID)} - {DataOwner (ParticipantID)} - ({list (NotificationItemID):(CanonicalEventCatalogUri):(EventID)})
DT I 11 Querying SML: {ParticipantID}
DT I 12 Querying SMP: {ParticipantID} - {DocumentTypeID} - {ProcessID}
DT E 01 Connection error with {destination component}: {inherited error message}
DT E 02 Error on response from {error source component}: {inherited error message}
DT E 03 Object conversion error in {error source component}: {inherited error message}
DT E 04 Error accessing/saving data on {error source component}: {inherited error message}
DT E 05 Missing or invalid arguments at {service requested}: {missing arguments}
DT E 06 Service requested {REST service requested} to {destination component} not found
DT E 07 Scheme validation failed for {MessageType}: {inherited error message}
DT E 08 Error occurred on AS4 Gateway to {destination component}: {inherited error message}

SSI Authority Agent

Component Level Template Specific text message
AA I 01 {APIMethod}: Received input eIDAS user data.
AA I 02 {APIMethod}: Received input userId data.
AA I 03 {APIMethod}: Generated DID invitation for edge agent with ID {UUID}.
AA I 04 {APIMethod}: Received input evidence data.
AA I 05 {APIMethod}: Signed a Verifiable Credential.
AA I 06 {APIMethod}: Sent Verifiable Credential {VC Id} to the edge agent under invitation {UUID} from {DO URI}.
AA I 07 {APIMethod}: Accepted a submitted Verifiable Presentation.
AA I 08 {APIMethod}: Decoded input eIDAS user data.
AA I 09 {APIMethod}: Validated the digital signature of the submitted VP.
AA I 10 {APIMethod}: Validated the subject of the submitted VP.
AA I 11 {APIMethod}: Received HTTP response code: {ResponseCode} from endpoint: {Endpoint}.
AA I 12 {APIMethod}: Processing the JSON response received from /{AriesAPIMethod}.
AA I 13 {APIMethod}: Stored current state in {Component} internal database.
AA I 14 {APIMethod}: Received user {DataObject} status data.
AA I 15 {APIMethod}: Converted input evidence in format: {Format} to format: {Format}.
AA I 16 {APIMethod}: Received response data PIID: {PIID}.
AA I 17 {APIMethod}: Found a {DataObject} action match with PIID: {PIID}.
AA I 18 {APIMethod}: Found a Verifiable Presentation with name: {VPName}.
AA I 19 {APIMethod}: Found a Verifiable Presentation with ID: {VPID}.
AA I 20 {APIMethod}: Received Verifiable Credential {VC Id} at the verifier {DE URI} under invitation {UUID}
AA I 21 {APIMethod}: Validated Verifiable Credential {VC Id} of type {CanonicalEvidenceTypeUri} under invitation {UUID} for {DE URI}.
AA I 22 {APIMethod}: Sent Offer for Verifiable Credential {VC Id} of type {CanonicalEvidenceTypeUri} under invitation {UUID} from {DO URI}.
AA I 23 {Component}: Issuer DID has already been generated and registered in EBSI.
AA I 24 {Component}: Successfully created files for EBSI integration.
AA I 25 {Component}: Successfully generated key: {KeyType}, value: {Value}.
AA I 26 {Component}: Successfully exported JWK private key.
AA I 27 {Component}: Successfully imported DID document into Aries.
AA I 28 {APIMethod}: Overwriting DID connection with ID {old invitation ID} to {new invitation ID} .
AA I 29 {APIMethod}: DID connection has been established for invitation ID {invitation ID}.
AA I 30 {APIMethod}: Validated the issuer of the submitted VP.
AA I 31 {APIMethod}: Validated the schema of the submitted VP.
AA I 32 {APIMethod}: Event notification of type ‘{event type}’ has been successfully sent to {frontend URI}. Received HTTP response code: {response code}.
AA I 33 {Component}: Successfully anchored DID {did} for organization {organization alias} into the EBSI DID Registry.
AA E 01 Connection error with {destination component}: {inherited error message}
AA E 02 Error on response from {error source component}: {inherited error message}
AA E 03 Object conversion error in {error source component}: {inherited error message}
AA E 04 Error accessing/saving data on {error source component}: {inherited error message}
AA E 05 Missing or invalid arguments at {service requested}: {missing arguments}
AA E 06 Error generating {key} key.
AA E 07 Error exporting JWK private key.
AA E 08 Error importing DID document into Aries.
AA E 09 Configuration error occurred on {error source component}
AA E 10 Event notification of type ‘{event type}’ could not be sent: {inherited error message}
AA E 11 Event notification of type ‘{event type}’ could not be sent: {inherited error message}

Data Evaluator

Component Level Template Specific text message
DE I 01 [UseCase] DE4A pilot process started
DE I 02 [UseCase] DE4A pilot process successfully finished
DE E 03 [UseCase] Failed to establish user identity
DE E 04 [UseCase] Preview rejected by the User

Data Owner

Component Level Template Specific text message
DO E 01 [UseCase] Error extracting evidence/subscription
DO E 02 [UseCase] Evidence/Subscription not available yet (delayed)
DO E 03 [UseCase] Error in identity matching
DO E 04 [UseCase] Unsuccessful completion of preview
DO E 05 [UseCase] Failed to re-establish user identity
DO E 06 [UseCase] Preview rejected by the User
DO E 07 [UseCase] Unsuccessful generation of the canonical evidence/subscription
DO E 08 Connection error with {destination component}: {inherited error message}
Retrieved from ‘https://wiki.de4a.eu/index.php?title=DE4A_Logs_and_error_messages_it2&oldid=5637’