Skip to content

Implementation completion log backend - #363

Merged
rmaddikery merged 6 commits into
eclipse-score:mainfrom
qorix-group:a.b/implementation_completion_log_backend
Oct 28, 2026
Merged

rmaddikery merged 6 commits into
eclipse-score:mainfrom
qorix-group:a.b/implementation_completion_log_backend

Conversation

@AdamBienkunski

Copy link
Copy Markdown
Contributor

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 #328

@github-actions

github-actions Bot commented Oct 16, 2026 •

Copy link
Copy Markdown
Contributor

License Check Results

🚀 The license check job ran with the Bazel command:

bazel run --lockfile_mode=error //:license-check

Status: ⚠️ Needs Review

Click to expand output
[License Check Output]
Extracting Bazel installation...
Starting local Bazel server (8.6.0) and connecting to it...
INFO: Invocation ID: b44db038-186d-43d9-979c-4fbf8b79559d
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
WARNING: For repository 'rules_cc', the root module requires module version rules_cc@0.2.17, but got rules_cc@0.2.25 in the resolved dependency graph. Please update the version in your MODULE.bazel or set --check_direct_dependencies=off
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Loading: 
Loading: 4 packages loaded
DEBUG: /home/runner/.bazel/external/score_docs_as_code+/docs.bzl:716:14: INFO: ⚠️ DEPRECATED: Passing a Needs inventory through docs(data = [...]) is deprecated!!! Move it to external_needs = [...] instead.
WARNING: Target pattern parsing failed.
ERROR: Skipping '//:license-check': no such target '//:license-check': target 'license-check' not declared in package '' defined by /home/runner/work/logging/logging/BUILD
ERROR: no such target '//:license-check': target 'license-check' not declared in package '' defined by /home/runner/work/logging/logging/BUILD
INFO: Elapsed time: 17.205s
INFO: 0 processes.
ERROR: Build did NOT complete successfully
ERROR: Build failed. Not running target

@rmaddikery rmaddikery left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Moving existing files will hamper the exports from internal repo. Please use symlinks if required until we have migrated entirely to score.

@AdamBienkunski

Copy link
Copy Markdown
Contributor Author

Moving existing files will hamper the exports from internal repo. Please use symlinks if required until we have migrated entirely to score.

Resolved: Changed to symlinks .

@@ -0,0 +1,59 @@
' *******************************************************************************

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

a puml saying design is not accurate. Also same. Does not require a puml when the code is self explanatory unless we can highlight the constraints, edge cases and limits - can be a follow-up if required.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Dropped from the changed as src is self explanatory

Comment thread scripts/dependency_reports/mw_log_backend.json Outdated
Comment thread docs/components/mw_log/detailed_design/dependencies.rst Outdated
@github-actions

Copy link
Copy Markdown
Contributor

Documentation preview for this pull request is available at:
pr-363: https://eclipse-score.github.io/logging/pr-363/

@github-project-automation github-project-automation Bot moved this from Backlog to On Hold in LOG - Logging FT Oct 28, 2026
- Correct the file output text and diagrams after the implementation
  and set the document safety level to QM.
- Correct the recorder diagram and the slot release in the syslog
  sequence.
- Remove the SlotDrainer diagrams that were loaded from score_baselibs
  by URL.
- Link the diagrams into the docs folder by symbolic links. The files
  stay in score/mw/log/design/backend.

Signed-off-by: Adam Bienkunski <Adam.Bienkunski.Ext@qorix.ai>
- Correct the datarouter class, IPC, recorder, shared memory reader
  and write factory diagrams.
- Rewrite the verbose logging, shared memory read and write and the
  connect to datarouter sequences after the code.
- Rewrite the unit diagram so that every sequence participant is a
  unit, as the architectural_design validation requires.
- Reference all datarouter diagrams in the design text, seven were
  not used before.
- Replace the described rate limit by the implemented limits.
- Link the diagrams into the docs folder by symbolic links. The files
  stay in score/mw/log/design/backend.

Signed-off-by: Adam Bienkunski <Adam.Bienkunski.Ext@qorix.ai>
- Structure the detailed design as in the module template: description,
  design decisions with diagram references, constraints per building
  block, external dependencies, units and interfaces.
- Map the architecture interfaces to the source code interfaces and
  describe boundaries, use and extension.
- Drop the syslog backend design page, which only restated the code.
  The syslog backend is a simple unit like slog, only its sequence
  diagram stays in the index.

Signed-off-by: Adam Bienkunski <Adam.Bienkunski.Ext@qorix.ai>
The syslog backend is not reachable through the //score/mw/log facade,
so it was not measured.

Signed-off-by: Adam Bienkunski <Adam.Bienkunski.Ext@qorix.ai>
Link the existing tests with RecordProperty("PartiallyVerifies", ...)
to the requirements they verify. They were tested but not linked.

- comp_req__log__send_to_datarouter: backend log level test and the
  message client connect and acquire tests.
- comp_req__log__inactive_logstream: the recorder log level test.

Signed-off-by: Adam Bienkunski <Adam.Bienkunski.Ext@qorix.ai>
Fill in the implementation inspection checklist of the log backend for
issue eclipse-score#328 (parent eclipse-score#317).

- Add the passed value and the remarks for each checklist item.
- Record the findings with their tickets (eclipse-score#318 coverage, eclipse-score#319
  requirement traceability, eclipse-score#336 CodeQL) and mark the findings that
  still need a ticket.
- Refer to the generated verification report and the dependency page
  instead of repeating analysis results.

Signed-off-by: Adam Bienkunski <Adam.Bienkunski.Ext@qorix.ai>
@AdamBienkunski
AdamBienkunski force-pushed the a.b/implementation_completion_log_backend branch from 3258eec to ec2e740 Compare October 28, 2026 10:14
@rmaddikery
rmaddikery merged commit 80ac19a into eclipse-score:main Oct 28, 2026
16 checks passed
@github-project-automation github-project-automation Bot moved this from On Hold to Done in LOG - Logging FT Oct 28, 2026

This branch was previously deployed

1 inactive deployment
workflow-approval — ec2e7402 Deployed Oct 28, 2026 by AdamBienkunski via approval #1004
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

[comp log_backend] Implementation completion

2 participants