Difference between revisions of "DE4A Logs and error messages"

From DE4A
Jump to navigation Jump to search
Line 86: Line 86:
 
=== Error messages ===
 
=== Error messages ===
 
As part of the logging standardization, some error messages templates have been defined. Those messages will be thrown by each component with the corresponding parameterization.
 
As part of the logging standardization, some error messages templates have been defined. Those messages will be thrown by each component with the corresponding parameterization.
 +
{| 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
 +
|{0}: Module name
 +
{1}: Inherited error message
 +
|
 +
|-
 +
|Failed  to establish user identity
 +
|09
 +
|
 +
|
 +
|-
 +
|Error  extracting evidence
 +
|10
 +
|
 +
|
 +
|-
 +
|Error in  identity matching
 +
|11
 +
|
 +
|
 +
|-
 +
|Unsuccessful  completion of preview
 +
|12
 +
|
 +
|
 +
|-
 +
|Preview  rejected by user
 +
|13
 +
|
 +
|
 +
|-
 +
|Failed  to re-establish user identity
 +
|14
 +
|
 +
|
 +
|-
 +
|Evidence  not available yet (delayed)
 +
|15
 +
|
 +
|
 +
|-
 +
|Unsuccessful  generation of the canonical evidence
 +
|16
 +
|
 +
|
 +
|}

Revision as of 09:30, 26 October 2021

Overview

In order to standarize 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 develop 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 messages definition are supported:

  • Kafka tracking: messages sent to the Kafka server which can be previewed at: https://de4a-dev-pt.egovlab.eu/#!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 convenction: standarize 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 multples pattern depending on the message nature, but the following tables will be a common reference to understand the rest of information collected in the page.

Layer

The layer concept will be used to name the system level where the message comes from.

Layer Layer Code Description
Communication 1 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

Module Name Module Code
IDK 01
SMP 02
Connector DR 03
Connector DT 04
Data Owner 05
Data Evaluator 06
None 07

Type

It is mean to use just for the Connector log messages (metrics and Kafka)

Log Type Type code
Services 01
Client 02
AS4 03

Error messages

As part of the logging standardization, some error messages templates have been defined. Those messages will be thrown by each component with the corresponding parameterization.

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 {0}: Module name

{1}: Inherited error message

Failed to establish user identity 09
Error extracting evidence 10
Error in identity matching 11
Unsuccessful completion of preview 12
Preview rejected by user 13
Failed to re-establish user identity 14
Evidence not available yet (delayed) 15
Unsuccessful generation of the canonical evidence 16
Retrieved from ‘https://wiki.de4a.eu/index.php?title=DE4A_Logs_and_error_messages&oldid=3700’