Skip to content

docs: Adds DR-002 for DLT network transport - #299

Open
rmaddikery wants to merge 2 commits into
mainfrom
rama_adds_dr_002
Open

docs: Adds DR-002 for DLT network transport#299
rmaddikery wants to merge 2 commits into
mainfrom
rama_adds_dr_002

Conversation

@rmaddikery

@rmaddikery rmaddikery commented Sep 4, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Rendered page: https://eclipse-score.github.io/logging/pr-299/features/logging/architecture/DR-002-dlt-network-transport.html

  • GTL adpotion
  • DLTv2 support (for ipv4 fragmentation)
  • DLT header construction/transmission into a dedicated network-stack module

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 #

@rmaddikery
rmaddikery deployed to workflow-approval September 4, 2026 07:18 — with GitHub Actions Active
@rmaddikery rmaddikery changed the title docs: Adds DR-002 decision record for DLT network transport docs: Adds DR-002 for DLT network transport Sep 4, 2026
@github-actions

github-actions Bot commented Sep 4, 2026 •
edited
Loading

Copy link
Copy Markdown

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: 9c07e529-00b8-4f18-89b2-f8c3348b491f
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
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
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: 14.102s
INFO: 0 processes.
ERROR: Build did NOT complete successfully
ERROR: Build failed. Not running target

@github-actions

github-actions Bot commented Sep 4, 2026

Copy link
Copy Markdown

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

@rmaddikery
rmaddikery deployed to workflow-approval September 4, 2026 08:01 — with GitHub Actions Active
@rmaddikery
docs: Adds DR-002 for DLT network transport
fad3259 
- GTL adpotion
- DLTv2 seam support
- DLT header construction/transmission into a dedicated
network-stack module
@rmaddikery
rmaddikery deployed to workflow-approval September 4, 2026 09:22 — with GitHub Actions Active
@rmaddikery
rmaddikery deployed to workflow-approval September 4, 2026 13:04 — with GitHub Actions Active
@rmaddikery
rmaddikery marked this pull request as ready for review September 4, 2026 13:08
@pawelrutkaq

pawelrutkaq commented Sep 7, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Few questions

  • so its about LSM logging module for iosock in QNX ?
  • What is te GTL standing for ? (Generic trac lib from baselibs ?)
  • What IPC will be used in a way into LSM (especially knowing LSM have specific requirements, like You cannot use malloc so ie "standard" C++ containers will not work etc)?
  • Document mentions trace but the mw::log does not have "standard" trace API, will this be added or mean something else ?

MaciejKaszynski
MaciejKaszynski reviewed Sep 7, 2026
View reviewed changes
Comment thread docs/features/logging/architecture/DR-002-dlt-network-transport.rst
network stack, shared with all other networked services.

A second, feature-flagged client backend (`shm_dma_enabled`)
would allow forwarding of records through a GTL client into a

@MaciejKaszynski MaciejKaszynski Sep 4, 2026

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.

I think it would be nice to add all the acronyms to a glossary.

Comment thread docs/features/logging/architecture/_assets/lsm_plugin.puml
' SPDX-License-Identifier: Apache-2.0
' *******************************************************************************

@startuml network_stack_plugin

@MaciejKaszynski MaciejKaszynski Sep 7, 2026

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.

I think the diagram and text don't make the plugin approach clear, do you think we could add a dummy block for the datarouter to make this clear?

Comment thread docs/features/logging/architecture/_assets/lsm_plugin.puml
gtl -r-> shmpayload
gtl -r-> shmmeta
gtl -r-> shmctrl
mwlog -r-> ctrlchannel

@MaciejKaszynski MaciejKaszynski Sep 7, 2026

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.

Is this a signal that there is messages in the shared memory? Might be good to label the edge to make this clear

Comment thread docs/features/logging/architecture/_assets/lsm_plugin.puml
interface "shm\n(control block)" as shmctrl
interface "DLT QNX\nControl Channel" as ctrlchannel

gtl -r-> shmpayload

@MaciejKaszynski MaciejKaszynski Sep 7, 2026

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.

We would later define a format for these log messages, is that right?

Comment thread docs/features/logging/architecture/DR-002-dlt-network-transport.rst
directly by the network stack, running on a second, dedicated
network-stack instance used exclusively for log and trace traffic:

- Removes the second IPC hop (and its associated copy) between the

@MaciejKaszynski MaciejKaszynski Sep 7, 2026

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.

I might be misunderstanding this but we would still have 2 copies of the log message right?
user -> mw::log: copy the data into the shared memory
network stack plugin -> io-sock: from shared memory, add the headers and copy into io-sock

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@MaciejKaszynski MaciejKaszynski MaciejKaszynski left review comments
@antonkri antonkri Awaiting requested review from antonkri antonkri is a code owner
@pawelrutkaq pawelrutkaq Awaiting requested review from pawelrutkaq pawelrutkaq is a code owner
@arsibo arsibo Awaiting requested review from arsibo arsibo is a code owner

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

None yet

Projects

LOG - Logging FT
Status: Backlog

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@rmaddikery @pawelrutkaq @MaciejKaszynski