Fixing some of the diagrams in the mw/log section #71

MaciejKaszynski · 2026-01-20T16:32:57Z

Diagrams were taken from https://github.com/eclipse-score/inc_mw_log and converted from uxf to puml.
Also fixed the links to embed the new diagrams in the markdown.
- Note: the links will work after the diagrams are merged to main.

github-actions · 2026-01-20T16:36:05Z

The created documentation from the pull request is available at: docu-html

4og · 2026-01-23T14:41:56Z

@rmaddikery, @hoppe-and-dreams, can you please review this PR?

rmaddikery · 2026-01-28T09:05:00Z

@MaciejKaszynski
eclipse-score/score#2509 for tracking

rmaddikery · 2026-02-03T04:55:35Z

score/mw/log/design/configuration_sequence.puml

+
+activate App
+
+App -> LOG **: CreateLogger(...)


The CreateLogger only registers a logger in the container butdoes not trigger the runtime initialization. The initialization is triggered by the first log call. A note would make sense here.

rmaddikery · 2026-02-03T05:02:35Z

score/mw/log/design/configuration_sequence.puml

+
+RF -> RT: Store returned instance
+
+RT -> LSF


Suggested change

RT -> LSF

LSF <- RT: Return Recorder reference

rmaddikery · 2026-02-03T07:38:39Z

score/mw/log/design/configuration_sequence.puml

+
+TCR -> RF: Return Configuration instance
+
+group Possibilities


Currently there are two possibilities:

At compile time:

Console only recorder with console backend

log mode is set to console logging by default.

Empty recorder if logmode other than KConsole is provided.

All recorders will respective backends

Depending on the log mode the runtime sets up the recorders. The log mode supports multiple recorders simultaneously through a composite recorder.

rmaddikery · 2026-02-03T07:40:09Z

score/mw/log/design/frontend_dependency_graph.puml

+  class score::mw::log::detail::Configuration {}
+  class score::mw::log::detail::TargetConfigReader {}
+
+  class score::mw::log::detail::DataRouterRecorder {}


Please revisit because only the EmptyRecorder, ConsoleRecorder and ConsoleRecorderFactory are included in the frontend.

rmaddikery · 2026-02-03T07:41:12Z

score/mw/log/design/frontend_dependency_graph.puml

+note top of frontend
+  Frontend contains the public user API,
+  and the necessary classes to interface
+  with the backend and implementation details.


Suggested change

with the backend and implementation details.

with the recorder interface.

rmaddikery · 2026-02-03T07:41:42Z

score/mw/log/design/frontend_dependency_graph.puml

+
+score::mw::log::Recorder <|-- score::mw::log::detail::FileRecorder
+score::mw::log::IRecorderFactory <|-- score::mw::log::detail::FileRecorderFactory
+score::mw::log::detail::FileRecorderFactory ..> score::mw::log::detail::FileRecorder


Same as above: https://github.com/eclipse-score/baselibs/pull/71/changes#r2757648550

rmaddikery · 2026-02-03T07:43:00Z

score/mw/log/design/verbose_logging_ara_log_interaction.puml

@@ -0,0 +1,43 @@
+@startuml verbose_logging_ara_log_interaction


This is legacy and no longer supported here hence should be removed.

rmaddikery · 2026-02-03T07:46:59Z

score/mw/log/design/wait_free_stack_trypush.puml

+        :Stack capacity full = true;
+    else (No)
+    :Push element to stack;
+    :Memory Fence (Release);


Suggested change

:Memory Fence (Release);

:Memory Fence (Release);

mark element as writen

rmaddikery · 2026-02-03T07:49:11Z

score/mw/log/design/wait_free_stack_trypush.puml

+    stop
+    endif
+endif
+    :Return null value;


Suggested change

:Return null value;

:Return nullopt

rmaddikery · 2026-02-03T07:49:33Z

score/mw/log/design/wait_free_stack_trypush.puml

+    else (No)
+    :Push element to stack;
+    :Memory Fence (Release);
+    :Return element value;


Suggested change

:Return element value;

:Return reference to element

rmaddikery · 2026-02-03T07:51:21Z

score/mw/log/design/configuration_sequence.puml

+RF -> RT: Store returned instance
+
+RT -> LSF
+LSF -> LOG: Return Recorder instance


Suggested change

LSF -> LOG: Return Recorder instance

LOG <- LSF: Return LogStream with Recorder

rmaddikery · 2026-02-03T07:56:10Z

score/mw/log/design/slot_drainer_sequence_design.puml

+SlotDrainer -> MessageBuilder : SetNextMessage(log_record)
+
+SlotDrainer -> NonBlockingWriter : FlushIntoFile()
+NonBlockingWriter -> SlotDrainer: kDone


Suggested change

NonBlockingWriter -> SlotDrainer: kDone

NonBlockingWriter -> SlotDrainer: kDone

ReleaseSlot() // slots are returned to the pool after being flushed.

The SlotDrainer is responsible for resource lifecycle management and not just data transfer.

Done on 32ca7ea

rmaddikery · 2026-02-03T08:28:52Z

score/mw/log/design/slot_drainer_sequence_design.puml

+SlotDrainer -> MessageBuilder : GetNextSpan()
+
+SlotDrainer -> NonBlockingWriter : FlushIntoFile()
+NonBlockingWriter -> SlotDrainer: kDone


This is the happy case. It would be good to show the kWouldBlock sequence as well

I added this on f38c3f7 However because of

baselibs/score/mw/log/detail/text_recorder/slot_drainer.cpp

Line 127 in 99d4963

std::ignore = TryFlushSlots();

I think the error would simply be ignored and later flushed so not sure if it makes sense to add

rmaddikery

Thanks, comments need to be addressed

4og · 2026-02-11T09:59:29Z

@MaciejKaszynski, thank you for the contribution! We are going to import these changes.
It is greatly appreciated if you squash the commits or at least get rid of the merge commit as it will be causing issues during the import.

- Added plantuml diagrams - Updated links in READMEs to the diagrams - Diagrams related to datarouter shall be in the seperate eclipse-score/logging repo

MaciejKaszynski · 2026-02-12T08:06:38Z

@MaciejKaszynski, thank you for the contribution! We are going to import these changes. It is greatly appreciated if you squash the commits or at least get rid of the merge commit as it will be causing issues during the import.

Rebased to new main & squashed to 1 commit

MaciejKaszynski requested review from 4og, LittleHuba, castler, hoe-jo, nradakovic and ramceb as code owners January 20, 2026 16:32

4og requested review from hoppe-and-dreams and rmaddikery January 23, 2026 14:42

MaciejKaszynski temporarily deployed to workflow-approval February 2, 2026 11:50 — with GitHub Actions Inactive

rmaddikery reviewed Feb 3, 2026

View reviewed changes

rmaddikery suggested changes Feb 3, 2026

View reviewed changes

rmaddikery self-assigned this Feb 3, 2026

MaciejKaszynski requested a deployment to workflow-approval February 5, 2026 14:45 — with GitHub Actions Waiting

MaciejKaszynski temporarily deployed to workflow-approval February 5, 2026 15:34 — with GitHub Actions Inactive

MaciejKaszynski requested a review from rmaddikery February 5, 2026 15:39

MaciejKaszynski force-pushed the feature/logging-arch-diagrams branch from f38c3f7 to aaaac2d Compare February 12, 2026 08:03

MaciejKaszynski requested a deployment to workflow-approval February 12, 2026 08:03 — with GitHub Actions Waiting

Updating logging architecture diagrams

ea70d7b

- Added plantuml diagrams - Updated links in READMEs to the diagrams - Diagrams related to datarouter shall be in the seperate eclipse-score/logging repo

MaciejKaszynski force-pushed the feature/logging-arch-diagrams branch from aaaac2d to ea70d7b Compare February 12, 2026 08:05

MaciejKaszynski requested a deployment to workflow-approval February 12, 2026 08:05 — with GitHub Actions Waiting

	with the backend and implementation details.
	with the recorder interface.

		@@ -0,0 +1,43 @@
		@startuml verbose_logging_ara_log_interaction

	:Memory Fence (Release);
	:Memory Fence (Release);
	mark element as writen

	LSF -> LOG: Return Recorder instance
	LOG <- LSF: Return LogStream with Recorder

	NonBlockingWriter -> SlotDrainer: kDone
	NonBlockingWriter -> SlotDrainer: kDone
	ReleaseSlot() // slots are returned to the pool after being flushed.

Fixing some of the diagrams in the mw/log section #71

Are you sure you want to change the base?

Fixing some of the diagrams in the mw/log section #71

Conversation

MaciejKaszynski commented Jan 20, 2026

Uh oh!

github-actions bot commented Jan 20, 2026

Uh oh!

4og commented Jan 23, 2026

Uh oh!

rmaddikery commented Jan 28, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rmaddikery Feb 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rmaddikery Feb 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rmaddikery left a comment

Choose a reason for hiding this comment

Uh oh!

4og commented Feb 11, 2026

Uh oh!

MaciejKaszynski commented Feb 12, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

rmaddikery Feb 3, 2026 •

edited

Loading

rmaddikery Feb 3, 2026 •

edited

Loading