Project

General

Profile

User story #1523

LoggerService in MARTeApp

Added by André Neto over 1 year ago. Updated 8 months ago.

Status:
Closed
Priority:
Normal
Assignee:
-
Target version:
-
Start date:
12.07.2023
Due date:
% Done:

0%

Estimated time:
Git branch (link):
Git merge to develop (link):
SVN commit (link/?p=rev):

Description

Make the MARTeApp use a LoggerService-like interface to allow setting the error formatting fields.

  • Expose LoggerConsumerI::PrintToStream as a public (static?) function
    • Modify from LoggerPage * const logPage to ErrorManagement::ErrorInformation errorInfo
  • Modify the MARTeApp MainErrorProcessFunction to use the method above.
  • Modify the MARTe Loader to read the logging Format, to decide if it should print raw or encoded and to select if it should include the keys (in the case of encoded).
TestPlainLoggerService.cfg (2.38 KB) TestPlainLoggerService.cfg Simple CFG files used to test MARTeApp Giuseppe Avon, 03.07.2024 11:21

History

#1 Updated by André Neto 9 months ago

  • Assignee changed from André Neto to Giuseppe Avon

#2 Updated by Giuseppe Avon 9 months ago

The implementation deviated from the user story description:
- A new PlainLoggerService class was implemented. It retraces the LoggerService class but without the asynchronous service feature. The PlainLoggerService catches the SetErrorProcessFunction and using a binder singleton class (PlainLoggerBinderSingleton) takes all the logging functions into it. The prints are served synchronously. The PlainLoggerService bypasses the Logger to prepare itself a LoggerPage and send it to the subscripted LoggerConsumers.
- To inject a platform specific string (mainly for the Aggregator Board use-case) the errorInfo class was decorated with an additional field (platformSpecificString) which is taken directly from the platform using an hook (const char8* GetPlatformSpecificString()).
- Another format specifier was added to the LoggerConsumerI (P with key |P=) to add the platform specific string to the logger output.

Initial commit code is * 1523-plain-loggerservice a9da6df4
At this stage it is missing proper QA proc

#3 Updated by Giuseppe Avon 9 months ago

The singleton uses a MARTe StaticList to hold PlainLoggerService instances and also tracks whenever the number of instances is above or below 1 (one). When the first PlainLoggerService is registered into the singleton, the ErrorProcessFunction is redirected to the singleton mechanism, conversely when the last PlainLoggerService is unregistered, the previous ErrorProcessFunction is reinstated.
The term previous indicates the function that was registered before any PlainLoggerService and related mechanisms are created. Actually this definition can be found in the MARTeApp.

Current commit code * 1523-plain-loggerservice 8ae87f213
Linting gives 0 related errors (run on entire MARTe2)
Coverage hits 98.2% on PlainLoggerService.cpp and 100% on its header.

Will follow a final update with the QA results after last validation round.

#4 Updated by Giuseppe Avon 9 months ago

  • Assignee changed from Giuseppe Avon to André Neto
  • Status changed from Code: Impl to Code: Rev
Final commit, created some duplicated test-cases, adhering to QA schemes, fix some minor header issues and removed dead comments.
  • 1523-plain-loggerservice dc3796ff0

Relevant coverage report

LoggerService.cpp    
96.4%96.4%
96.4 %    81 / 84    100.0 %    14 / 14

PlainLoggerService.cpp    
98.2%98.2%
98.2 %    108 / 110    100.0 %    18 / 18

Lint report

FlexeLint for C/C++ (Unix) Vers. 9.00L, Copyright Gimpel Software 1985-2014
./MakeDefaults/Lint/marte_flint_exceptions.lnt  15  Warning 686: Option
    '-elib(*)' is suspicious because of 'the likelihood of causing meaningless
    output'; receiving a syntax error in a library file most likely means
    something is wrong with your Lint configuration
 Note 974: Worst case function for stack usage: 'MARTe::ConfigurationDatabase::Copy' is recursive, loop contains call to 'MARTe::ConfigurationDatabase::Copy'. See +stack for a full report. [MISRA C++ Rule 7-5-4]

#6 Updated by André Neto 9 months ago

  • Assignee deleted (André Neto)
  • Status changed from Code: Rev to Closed

Merged into develop in 8156f8f7

#7 Updated by André Neto 8 months ago

Merged again c6d64d9e48576983c300015363a61e2ae85679f5

Also available in: Atom PDF