docs: `mw_log` arch diagrams #4

arkjedrz · 2025-11-24T08:54:30Z

Notes for Reviewer

Pre-Review Checklist for the PR Author

PR title is short, expressive and meaningful
Commits are properly organized
Relevant issues are linked in the References section
Tests are conducted
Unit tests are added

Checklist for the PR Reviewer

Commits are properly organized and messages are according to the guideline
Unit tests have been written for new behavior
Public API is documented
PR title describes the changes

Post-review Checklist for the PR Author

All open points are addressed and tracked via issues

References

Closes #

github-actions · 2025-11-24T08:55:18Z

License Check Results

🚀 The license check job ran with the Bazel command:

bazel run //:license-check

Status: ⚠️ Needs Review

Click to expand output

[License Check Output]
Extracting Bazel installation...
Starting local Bazel server (8.4.2) and connecting to it...
INFO: Invocation ID: f36aaf55-bf93-4687-8a90-28772d983b51
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
DEBUG: Rule 'rust_qnx8_toolchain+' indicated that a canonical reproducible form can be obtained by modifying arguments integrity = "sha256-eQOopREOYCL5vtTb6c1cwZrql4GVrJ1FqgxarQRe1xs="
DEBUG: Repository rust_qnx8_toolchain+ instantiated at:
  <builtin>: in <toplevel>
Repository rule http_archive defined at:
  /home/runner/.bazel/external/bazel_tools/tools/build_defs/repo/http.bzl:431:31: in <toplevel>
Computing main repo mapping: 
Computing main repo mapping: 
WARNING: For repository 'aspect_rules_lint', the root module requires module version [email protected], but got [email protected] in the resolved dependency graph. Please update the version in your MODULE.bazel or set --check_direct_dependencies=off
WARNING: For repository 'buildifier_prebuilt', the root module requires module version [email protected], but got [email protected] in the resolved dependency graph. Please update the version in your MODULE.bazel or set --check_direct_dependencies=off
Loading: 
Loading: 0 packages loaded
Loading: 0 packages loaded
Loading: 0 packages loaded
    currently loading: 
Analyzing: target //:license-check (1 packages loaded, 0 targets configured)
Analyzing: target //:license-check (1 packages loaded, 0 targets configured)

Analyzing: target //:license-check (25 packages loaded, 9 targets configured)

Analyzing: target //:license-check (80 packages loaded, 9 targets configured)

Analyzing: target //:license-check (135 packages loaded, 1396 targets configured)

Analyzing: target //:license-check (139 packages loaded, 2556 targets configured)

Analyzing: target //:license-check (140 packages loaded, 2564 targets configured)

Analyzing: target //:license-check (147 packages loaded, 2616 targets configured)

Analyzing: target //:license-check (148 packages loaded, 2740 targets configured)

INFO: Analyzed target //:license-check (152 packages loaded, 4876 targets configured).
[7 / 14] Creating runfiles tree bazel-out/k8-opt-exec-ST-d57f47055a04/bin/external/score_tooling+/dash/tool/formatters/dash_format_converter.runfiles [for tool]; 0s local
INFO: From Generating Dash formatted dependency file ...:
WARNING: No packages found in Cargo.lock.
INFO: Successfully converted 0 packages from Cargo.lock to bazel-out/k8-fastbuild/bin/formatted.txt
INFO: Found 1 target...
Target //:license.check.license_check up-to-date:
  bazel-bin/license.check.license_check
  bazel-bin/license.check.license_check.jar
INFO: Elapsed time: 22.966s, Critical Path: 0.37s
INFO: 14 processes: 5 disk cache hit, 9 internal.
INFO: Build completed successfully, 14 total actions
INFO: Running command line: bazel-bin/license.check.license_check ./formatted.txt <args omitted>
usage: org.eclipse.dash.licenses.cli.Main [-batch <int>] [-cd <url>]
       [-confidence <int>] [-ef <url>] [-excludeSources <sources>] [-help] [-lic
       <url>] [-project <shortname>] [-repo <url>] [-review] [-summary <file>]
       [-timeout <seconds>] [-token <token>]

github-actions · 2025-11-24T08:57:03Z

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

pawelrutkaq

Please fix Detailed design part and remove code.

docs/module/log/architecture/index.rst

docs/module/log/architecture/_assets/log_with_global_logger.puml

docs/module/log/architecture/_assets/log_with_local_logger.puml

docs/module/log/architecture/_assets/static_view.puml

docs/module/log/architecture/_assets/interface.puml

docs/module/log/detailed_design/_assets/class_diagram.puml

docs/module/log/detailed_design/_assets/log_op.puml

Basic design for Log component.

Dynamic diagram for Log operation.

pawelrutkaq · 2025-11-25T12:06:20Z

For me looks good, lets ping to logging CFT

docs/module/log/architecture/_assets/static_view.puml

docs/module/log/architecture/index.rst

docs/module/log/detailed_design/_assets/class_diagram.puml

docs/module/log/detailed_design/index.rst

docs/module/log/detailed_design/_assets/log_to_level.puml

docs/module/log/detailed_design/_assets/class_diagram.puml

docs/module/log/detailed_design/_assets/log_op.puml

Post-review fixes.

MaciejKaszynski

look good

arsibo

Please generate a ticket(s) for findings what cannot be fixed now.

arsibo · 2025-12-01T16:48:02Z

docs/module/log/architecture/_assets/static_view.puml

+    Backend implementation.
+end note
+
+mw_log --> mw_log_subscriber : implements


mw_log_subscriber ..u.|> mw_log : implements

arsibo · 2025-12-01T16:58:10Z

docs/module/log/architecture/index.rst


-..    .. uml:: _assets/TODO.puml
+   .. uml:: _assets/static_view.puml



Does this diagram show all dependencies ? e.G. Do you use rust crates as helper functions ? What would this mean for safety?

This is depndendless

arsibo · 2025-12-01T17:01:18Z

docs/module/log/architecture/index.rst


-..    .. uml:: _assets/TODO.puml
+   .. uml:: _assets/static_view.puml



In logging FT we discussed to use log_fonted as component name. Shall we do it now or adapted later?

arsibo · 2025-12-01T17:06:12Z

docs/module/log/architecture/index.rst

-..    :implements: logic_arc_int__log__interface_name
-..    :fulfils:
-..    :includes:
+.. comp_arc_sta:: Log (Static View)


part has to be updated after Feature arc is available

arsibo · 2025-12-01T17:08:00Z

docs/module/log/architecture/index.rst


-Lower Level Components
----------------------
+.. real_arc_int:: Log interface


I think this has to be reworked with respect to Sphinx needs later. https://eclipse-score.github.io/process_description/main/process_areas/architecture_design/architecture_concept.html#metamodel-architectural-design

arsibo · 2025-12-01T17:14:21Z

docs/module/log/requirements/index.rst

 Requirements
 ############

 .. document:: Log Requirements


Feature Requirements need to be mapped (https://github.com/eclipse-score/score/blob/main/docs/features/analysis-infra/logging/docs/requirements/mw-fr_logging_req.rst)

arsibo · 2025-12-01T17:16:48Z

Hint: This is the required check list https://eclipse-score.github.io/process_description/main/folder_templates/modules/module_name/component_name/docs/architecture/chklst_arc_inspection.html#doc__component_name_arc_inspection

pawelrutkaq · 2025-12-02T10:08:39Z

This PR implements #16

arkjedrz self-assigned this Nov 24, 2025

arkjedrz requested a review from pawelrutkaq November 24, 2025 08:54

arkjedrz closed this Nov 24, 2025

arkjedrz reopened this Nov 24, 2025

arkjedrz force-pushed the arkjedrz_mw-log-docs branch 3 times, most recently from ef03b00 to 15459b5 Compare November 24, 2025 11:00

pawelrutkaq requested changes Nov 24, 2025

View reviewed changes

arkjedrz force-pushed the arkjedrz_mw-log-docs branch 2 times, most recently from f9557b6 to 12dd684 Compare November 24, 2025 12:27

arkjedrz requested a review from pawelrutkaq November 24, 2025 12:27

pawelrutkaq requested changes Nov 24, 2025

View reviewed changes

arkjedrz force-pushed the arkjedrz_mw-log-docs branch from 12dd684 to e3d6e4b Compare November 24, 2025 14:43

docs: Log design

8ccef3a

Basic design for Log component.

arkjedrz force-pushed the arkjedrz_mw-log-docs branch 2 times, most recently from 9405782 to d45d05e Compare November 25, 2025 09:07

docs: Log op dyn diagram

7ae9661

Dynamic diagram for Log operation.

arkjedrz force-pushed the arkjedrz_mw-log-docs branch from d45d05e to 7ae9661 Compare November 25, 2025 11:59

arkjedrz marked this pull request as ready for review November 25, 2025 11:59

pawelrutkaq approved these changes Nov 25, 2025

View reviewed changes

MaciejKaszynski suggested changes Nov 27, 2025

View reviewed changes

docs: post-review fixes

905e2ac

Post-review fixes.

arkjedrz requested a review from MaciejKaszynski November 28, 2025 09:10

MaciejKaszynski approved these changes Nov 28, 2025

View reviewed changes

arsibo self-requested a review December 1, 2025 16:20

arsibo approved these changes Dec 1, 2025

View reviewed changes

pawelrutkaq mentioned this pull request Dec 2, 2025

Improvement: PR4 review improvements #17

Open

arsibo merged commit 696d955 into eclipse-score:main Dec 2, 2025
11 checks passed

arkjedrz mentioned this pull request Dec 5, 2025

Initial component design and architecture #16

Closed

arkjedrz deleted the arkjedrz_mw-log-docs branch December 5, 2025 07:32


		.. .. uml:: _assets/TODO.puml
		.. uml:: _assets/static_view.puml

docs: mw_log arch diagrams #4

docs: mw_log arch diagrams #4

Uh oh!

Conversation

arkjedrz commented Nov 24, 2025

Notes for Reviewer

Pre-Review Checklist for the PR Author

Checklist for the PR Reviewer

Post-review Checklist for the PR Author

References

Uh oh!

github-actions bot commented Nov 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

License Check Results

Uh oh!

github-actions bot commented Nov 24, 2025

Uh oh!

pawelrutkaq left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

pawelrutkaq commented Nov 25, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

MaciejKaszynski left a comment

Choose a reason for hiding this comment

Uh oh!

arsibo left a comment

Choose a reason for hiding this comment

Uh oh!

arsibo Dec 1, 2025

Choose a reason for hiding this comment

Uh oh!

arsibo Dec 1, 2025

Choose a reason for hiding this comment

Uh oh!

pawelrutkaq Dec 2, 2025

Choose a reason for hiding this comment

Uh oh!

arsibo Dec 1, 2025 • 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!

arsibo Dec 1, 2025

Choose a reason for hiding this comment

Uh oh!

arsibo Dec 1, 2025

Choose a reason for hiding this comment

Uh oh!

arsibo Dec 1, 2025

Choose a reason for hiding this comment

Uh oh!

arsibo commented Dec 1, 2025

Uh oh!

pawelrutkaq commented Dec 2, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

docs: `mw_log` arch diagrams #4

docs: `mw_log` arch diagrams #4

github-actions bot commented Nov 24, 2025 •

edited

Loading

arsibo Dec 1, 2025 •

edited

Loading