DE4A Logs and error messages

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:

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