From 50c0081860f3cd1d33ede08cfdcbe78b79e25ab4 Mon Sep 17 00:00:00 2001 From: Maciej Kaszynski Date: Tue, 29 Sep 2026 08:52:50 +0100 Subject: [PATCH 1/6] Adding datarouter reqs checklist Adding Issue link --- .../requirements/chklst_req_inspection.rst | 196 ++++++++++++++++++ .../datarouter/requirements/index.rst | 105 +--------- .../datarouter/requirements/requirements.rst | 116 +++++++++++ 3 files changed, 317 insertions(+), 100 deletions(-) create mode 100644 docs/components/datarouter/requirements/chklst_req_inspection.rst create mode 100644 docs/components/datarouter/requirements/requirements.rst diff --git a/docs/components/datarouter/requirements/chklst_req_inspection.rst b/docs/components/datarouter/requirements/chklst_req_inspection.rst new file mode 100644 index 000000000..8b4af6640 --- /dev/null +++ b/docs/components/datarouter/requirements/chklst_req_inspection.rst @@ -0,0 +1,196 @@ +.. + # ******************************************************************************* + # Copyright (c) 2026 Contributors to the Eclipse Foundation + # + # See the NOTICE file(s) distributed with this work for additional + # information regarding copyright ownership. + # + # This program and the accompanying materials are made available under the + # terms of the Apache License Version 2.0 which is available at + # https://www.apache.org/licenses/LICENSE-2.0 + # + # SPDX-License-Identifier: Apache-2.0 + # ******************************************************************************* + + +.. document:: Datarouter Requirements Inspection Checklist + :id: doc__datarouter_req_inspection + :status: draft + :version: 1 + :safety: ASIL_B + :security: YES + :realizes: wp__requirements_inspect + + +Requirement Inspection Checklist +================================ + +Purpose +------- + +The purpose of this requirement inspection checklist is to collect the topics to be checked during requirements inspection. + +Conduct +------- + +As described in the concept :need:`doc_concept__wp_inspections` the following "inspection roles" are expected to be filled: + +- content responsible (author): +- reviewer: +- moderator: +- test expert: + +Checklist +--------- + +It is mandatory to fill in the "passed" column with "yes" or "no" for each checklist item and additionally to add in the remarks why it is passed or not passed. +In case of "no" an issue link to the issue tracking system has to be added in the last column (if not solved in the same issue). +See also :need:`doc_concept__wp_inspections` for further information about reviews in general and inspection in particular. + + +.. list-table:: Component Requirement Inspection Checklist + :header-rows: 1 + :widths: 10,30,50,6,6,8 + + * - Review ID + - Acceptance Criteria + - Guidance + - Passed + - Remarks + - Issue link + * - REQ_01_01 + - Is the requirement formulation template used? + - see :need:`gd_temp__req_formulation`, this includes the use of "shall". + - No + - :need:`comp_req__data_router__dlt_quota_bw_reduction` not following schema. + :need:`comp_req__data_router__dlt_multiple_channels` first word should be Datarouter. + :need:`comp_req__data_router__dlt_message_filtering` + :need:`comp_req__data_router__dlt_verbose_messages` + - https://github.com/eclipse-score/logging/issues/344 + * - REQ_02_01 + - Is the requirement description *comprehensible* ? + - If you think the requirement is hard to understand, comment here. + - No + - :need:`comp_req__data_router__dlt_server` shall implement the UDP multicast transport of a Dlt server. + :need:`comp_req__data_router__dlt_multiple_channels` define in glossary multi-channel. + :need:`comp_req__data_router__dlt_message_filtering` shall allow for filtering messages + per channel based on application ID, + context ID, log level threshold. + :need:`comp_req__data_router__dlt_verbose_messages` The verbose mode of the original message shall be unmodified. + - https://github.com/eclipse-score/logging/issues/344 + * - REQ_02_02 + - Is the requirement description *unambiguous* ? + - Especially search for "weak words" like "about", "etc.", "relevant" and others (see the internet documentation on this). This check shall be supported by tooling. + - Yes + - + - + * - REQ_02_03 + - Is the requirement description *atomic* ? + - A good way to think about this is to consider if the requirement may be tested by one (positive) test case or needs more of these. The requirement formulation template should also avoid being non-atomic already. Note that there are cases where also non-atomic requirements are the better ones, for example if those are better understandable. + - No + - :need:`comp_req__data_router__dlt_multiple_channels` config files should be another requirement. + :need:`comp_req__data_router__dlt_message_filtering` also has this. + Maybe a central requirement to specify that all parameters shall be + configurable with console or config. e.g. comp_req__log__cfg_precedence on the front end. + :need:`comp_req__data_router__dlt_server` shall be split for the UDP part and link to only :need:`feat_req__logging__log_sinks_network`. + - https://github.com/eclipse-score/logging/issues/344 + * - REQ_02_04 + - Is the requirement description *feasible* ? + - If at the time of the inspection the requirement has already some implementation, the answer is yes. This can be checked via traces, but also :need:`gd_req__req_attr_impl` shows this. In case the requirement has no implementation at the time of inspection (i.e. not implemented at least as "proof-of-concept"), a development expert should be invited to the Pull-Request review to explicitly check this item. + - No + - :need:`comp_req__data_router__dlt_multiple_channels` reword the reference to AUTOSAR? Propse: comparable. + - https://github.com/eclipse-score/logging/issues/344 + * - REQ_02_05 + - Is the requirement description *independent from implementation* ? + - This checkpoint should improve requirements definition in the sense that the "what" is described and not the "how" - the latter should be described in architecture/design derived from the requirement. But there can also be a good reason for this, for example we would require using a file format like JSON and even specify the formatting standard already on stakeholder requirement level because we want to be compatible. A finding in this checkpoint does not mean there is a safety problem in the requirement. + - Yes + - + - + * - REQ_03_01 + - Is the *linkage to the parent requirement* correct? + - Linkage to correct levels and ASIL attributes is checked automatically, but it needs checking if the child requirement implements (at least) a part of the parent requirement. + - Yes + - + - + * - REQ_04_01 + - Is the requirement *internally and externally consistent*? + - Does the requirement contradict other requirements within the same or higher levels? One may restrict the search to the feature for component requirements, for features to other features using same components. Is the description of the requirement consistent with all its attributes (if not already part of another check, e.g. does the title fit?). + - No + - :need:`comp_req__data_router__dlt_multiple_channels` :need:`comp_req__data_router__dlt_message_filtering` :need:`comp_req__data_router__dlt_bw_quota_config` location is unclear. Define a central location. + - https://github.com/eclipse-score/logging/issues/344 + * - REQ_05_01 + - Do the software requirements consider *timing constraints*? + - This checkpoint encourages to think about timing constraints even if those are not explicitly mentioned in the parent requirement. If the reviewer of a requirement already knows or suspects that the code execution will be consuming a lot of time, one should think of the expectation of a "user". + - Yes + - + - + * - REQ_06_01 + - Does the requirement consider *external interfaces*? + - The SW platform's external interfaces (to the user) are defined in the Feature Architecture, so the Feature and Component Requirements should determine the input data use and setting of output data for these interfaces. Are all output values defined? + - Yes + - + - + * - REQ_07_01 + - Is the *safety* attribute set correctly? + - Derived requirements are checked automatically, see :need:`gd_req__req_linkage_safety`. But for the top level requirements (and also all AoU) this needs to be checked manually for correctness. + - Yes + - + - + * - REQ_07_02 + - Is the attribute *security* set correctly? + - For component requirements this checklist item is supported by automated check: "Every requirement which satisfies a feature requirement with security attribute set to YES inherits this". But the component requirements/architecture may additionally also be subject to a :need:`wp__sw_component_security_analysis`. + - Yes + - + - + * - REQ_08_01 + - Is the requirement *verifiable*? + - If at the time of the inspection already tests are created for the requirement, the answer is yes. This can be checked via traces, but also :need:`gd_req__req_attr_test_covered` shows this. In case the requirement is not sufficiently traced to test cases already, a test expert is invited to the inspection to give their opinion whether the requirement is formulated in a way that supports test development and the available test infrastructure is sufficient to perform the test. + - Yes + - + - + * - REQ_08_02 + - Is the requirement verifiable by design or code review in case it is not feasibly testable? + - In very rare cases a requirement may not be verifiable by test cases, for example a specific non-functional requirement. In this case a requirement analysis verifies the requirement by design/code review. If such a requirement is in scope of this inspection, please check this here and link to the respective review record. A test expert is invited to the inspection to confirm their opinion that the requirement is not testable. + - Yes + - + - + * - REQ_09_01 + - Do the requirements that define a safety mechanism specify the error reaction leading to a safe state? + - Alternatively to the safe state there could also be "repair" mechanisms. Also do not forget to consider REQ_05_01 for these. + - Yes + - + - + * - REQ_10_01 + - Is the requirement description *complete* ? + - For every requirement in the inspection, follow to its parent (feature) requirement(s) and then check if this/these are fulfilled completely by its/their linked children (component requirements, including those which are not in scope of the inspection). + - No + - :need:`comp_req__data_router__dlt_verbose_messages` might need a feature requirement. + :need:`comp_req__data_router__dlt_bw_quota_config` should also map to :need:`feat_req__logging__message_loss_handling` & :need:`feat_req__logging__qos_message_handling`. + - https://github.com/eclipse-score/logging/issues/344 + +.. attention:: + The above checklist entries must be filled according to your component requirements in scope. + +Note: If a Review ID is not applicable for your requirement, then state ""n/a" in status and comment accordingly in remarks. + +The following requirements in "valid" state and with "inspected" tag set are in the scope of this inspection: + +.. needtable:: + :filter: "mw_log_backend" in docname and "requirements" in docname and docname is not None and status == "valid" + :style: table + :types: comp_req + :tags: mw_log_backend + :columns: id;status;tags + :colwidths: 25,25,25 + :sort: title + +And also the following AoUs in "valid" state and with "inspected" tag set (for these please answer the questions above as if the AoUs are requirements, except question REQ_03_01): + +.. needtable:: + :filter: "mw_log_backend" in docname and "requirements" in docname and docname is not None and status == "valid" + :style: table + :types: aou_req + :tags: mw_log_backend + :columns: id;status;tags + :colwidths: 25,25,25 + :sort: title diff --git a/docs/components/datarouter/requirements/index.rst b/docs/components/datarouter/requirements/index.rst index 494ccf850..9eea1fc74 100644 --- a/docs/components/datarouter/requirements/index.rst +++ b/docs/components/datarouter/requirements/index.rst @@ -12,105 +12,10 @@ # SPDX-License-Identifier: Apache-2.0 # ******************************************************************************* -Datarouter Component Requirements -################################## +Requirements +############ -.. document:: Datarouter Component Requirements - :id: doc__data_router_requirements - :version: 1 - :status: valid - :safety: QM - :security: NO - :realizes: wp__requirements_comp +.. toctree:: -Datarouter Services -------------------- - -.. comp_req:: Datarouter DLT Server - :id: comp_req__data_router__dlt_server - :version: 1 - :reqtype: Functional - :security: NO - :safety: QM - :derived_from: feat_req__logging__compat_dlt, feat_req__logging__log_sinks_network - :status: valid - :satisfied_by: comp__datarouter - - Datarouter shall implement DLT server component. Datarouter provides the functionality to - send messages using DLT protocol over UDP multicast transport. - -.. comp_req:: DLT Multiple Channel Support - :id: comp_req__data_router__dlt_multiple_channels - :version: 1 - :reqtype: Functional - :security: NO - :safety: QM - :derived_from: feat_req__logging__compat_dlt, feat_req__logging__config_log_filter, feat_req__logging__config_entity_id - :status: valid - :satisfied_by: comp__datarouter - - DLT server shall support multiple log channels as specified in AUTOSAR Diagnostic, Log and - Trace Protocol Specification. The following parameters shall be configurable statically via - a deployment-specific configuration file - (``/./etc/log-channels.json``): Number and names of channels, - Network configuration for channel output, Log level threshold per channel, Log channel - assignments per application/context. - -.. comp_req:: DLT Message Filtering - :id: comp_req__data_router__dlt_message_filtering - :version: 1 - :reqtype: Functional - :security: NO - :safety: QM - :derived_from: feat_req__logging__filtering_log_levels, feat_req__logging__filtering_entity_id, feat_req__logging__config_log_filter - :status: valid - :satisfied_by: comp__datarouter - - DLT server shall support filtering of messages within each channel. The filter shall be - parametrized with application ID, context ID, log level threshold. Initial filter set shall - be part of channel configuration file, located in the following path: - ``/../etc/log-channels.json``. - -.. comp_req:: DLT Verbose Messages - :id: comp_req__data_router__dlt_verbose_messages - :version: 1 - :reqtype: Functional - :security: NO - :safety: QM - :derived_from: feat_req__logging__compat_dlt - :status: valid - :satisfied_by: comp__datarouter - - DLT server shall provide support for verbose DLT messages. Messages sent from mw::log - library shall be sent via DLT using verbose mode. - -DLT Quotas ----------- - -.. comp_req:: DLT Bandwidth Quota Configuration - :id: comp_req__data_router__dlt_bw_quota_config - :version: 1 - :reqtype: Functional - :security: NO - :safety: QM - :derived_from: feat_req__logging__config_buffer_size, feat_req__logging__resource_comm_channel - :status: valid - :satisfied_by: comp__datarouter - - The component shall have the DLT bandwidth quota configuration in the file located at - ``./etc/log-channels.json`` relative to the application specific location ``/opt/``. - -.. comp_req:: DLT Quota Bandwidth Reduction - :id: comp_req__data_router__dlt_quota_bw_reduction - :version: 1 - :reqtype: Functional - :security: NO - :safety: QM - :derived_from: feat_req__logging__message_loss_handling, feat_req__logging__qos_message_handling - :status: valid - :satisfied_by: comp__datarouter - - It shall be possible to configure the action to drop DLT messages when a quota is exceeded. - - Note: The configuration shall be provided as an attribute as part of the DLT quota - configuration file (:need:`comp_req__data_router__dlt_bw_quota_config`). + requirements + chklst_req_inspection diff --git a/docs/components/datarouter/requirements/requirements.rst b/docs/components/datarouter/requirements/requirements.rst new file mode 100644 index 000000000..494ccf850 --- /dev/null +++ b/docs/components/datarouter/requirements/requirements.rst @@ -0,0 +1,116 @@ +.. + # ******************************************************************************* + # Copyright (c) 2026 Contributors to the Eclipse Foundation + # + # See the NOTICE file(s) distributed with this work for additional + # information regarding copyright ownership. + # + # This program and the accompanying materials are made available under the + # terms of the Apache License Version 2.0 which is available at + # https://www.apache.org/licenses/LICENSE-2.0 + # + # SPDX-License-Identifier: Apache-2.0 + # ******************************************************************************* + +Datarouter Component Requirements +################################## + +.. document:: Datarouter Component Requirements + :id: doc__data_router_requirements + :version: 1 + :status: valid + :safety: QM + :security: NO + :realizes: wp__requirements_comp + +Datarouter Services +------------------- + +.. comp_req:: Datarouter DLT Server + :id: comp_req__data_router__dlt_server + :version: 1 + :reqtype: Functional + :security: NO + :safety: QM + :derived_from: feat_req__logging__compat_dlt, feat_req__logging__log_sinks_network + :status: valid + :satisfied_by: comp__datarouter + + Datarouter shall implement DLT server component. Datarouter provides the functionality to + send messages using DLT protocol over UDP multicast transport. + +.. comp_req:: DLT Multiple Channel Support + :id: comp_req__data_router__dlt_multiple_channels + :version: 1 + :reqtype: Functional + :security: NO + :safety: QM + :derived_from: feat_req__logging__compat_dlt, feat_req__logging__config_log_filter, feat_req__logging__config_entity_id + :status: valid + :satisfied_by: comp__datarouter + + DLT server shall support multiple log channels as specified in AUTOSAR Diagnostic, Log and + Trace Protocol Specification. The following parameters shall be configurable statically via + a deployment-specific configuration file + (``/./etc/log-channels.json``): Number and names of channels, + Network configuration for channel output, Log level threshold per channel, Log channel + assignments per application/context. + +.. comp_req:: DLT Message Filtering + :id: comp_req__data_router__dlt_message_filtering + :version: 1 + :reqtype: Functional + :security: NO + :safety: QM + :derived_from: feat_req__logging__filtering_log_levels, feat_req__logging__filtering_entity_id, feat_req__logging__config_log_filter + :status: valid + :satisfied_by: comp__datarouter + + DLT server shall support filtering of messages within each channel. The filter shall be + parametrized with application ID, context ID, log level threshold. Initial filter set shall + be part of channel configuration file, located in the following path: + ``/../etc/log-channels.json``. + +.. comp_req:: DLT Verbose Messages + :id: comp_req__data_router__dlt_verbose_messages + :version: 1 + :reqtype: Functional + :security: NO + :safety: QM + :derived_from: feat_req__logging__compat_dlt + :status: valid + :satisfied_by: comp__datarouter + + DLT server shall provide support for verbose DLT messages. Messages sent from mw::log + library shall be sent via DLT using verbose mode. + +DLT Quotas +---------- + +.. comp_req:: DLT Bandwidth Quota Configuration + :id: comp_req__data_router__dlt_bw_quota_config + :version: 1 + :reqtype: Functional + :security: NO + :safety: QM + :derived_from: feat_req__logging__config_buffer_size, feat_req__logging__resource_comm_channel + :status: valid + :satisfied_by: comp__datarouter + + The component shall have the DLT bandwidth quota configuration in the file located at + ``./etc/log-channels.json`` relative to the application specific location ``/opt/``. + +.. comp_req:: DLT Quota Bandwidth Reduction + :id: comp_req__data_router__dlt_quota_bw_reduction + :version: 1 + :reqtype: Functional + :security: NO + :safety: QM + :derived_from: feat_req__logging__message_loss_handling, feat_req__logging__qos_message_handling + :status: valid + :satisfied_by: comp__datarouter + + It shall be possible to configure the action to drop DLT messages when a quota is exceeded. + + Note: The configuration shall be provided as an attribute as part of the DLT quota + configuration file (:need:`comp_req__data_router__dlt_bw_quota_config`). From bd920b6cf14c63379adf2efd45d29ed6f8a7f949 Mon Sep 17 00:00:00 2001 From: Maciej Kaszynski Date: Mon, 26 Oct 2026 16:42:48 +0000 Subject: [PATCH 2/6] Rewording to follow the format --- .../requirements/chklst_req_inspection.rst | 9 +++------ .../datarouter/requirements/requirements.rst | 12 ++++++------ 2 files changed, 9 insertions(+), 12 deletions(-) diff --git a/docs/components/datarouter/requirements/chklst_req_inspection.rst b/docs/components/datarouter/requirements/chklst_req_inspection.rst index 8b4af6640..17cf7f9d6 100644 --- a/docs/components/datarouter/requirements/chklst_req_inspection.rst +++ b/docs/components/datarouter/requirements/chklst_req_inspection.rst @@ -61,12 +61,9 @@ See also :need:`doc_concept__wp_inspections` for further information about revie * - REQ_01_01 - Is the requirement formulation template used? - see :need:`gd_temp__req_formulation`, this includes the use of "shall". - - No - - :need:`comp_req__data_router__dlt_quota_bw_reduction` not following schema. - :need:`comp_req__data_router__dlt_multiple_channels` first word should be Datarouter. - :need:`comp_req__data_router__dlt_message_filtering` - :need:`comp_req__data_router__dlt_verbose_messages` - - https://github.com/eclipse-score/logging/issues/344 + - Yes + - All requirements use "Datarouter shall ..." formulation. + - * - REQ_02_01 - Is the requirement description *comprehensible* ? - If you think the requirement is hard to understand, comment here. diff --git a/docs/components/datarouter/requirements/requirements.rst b/docs/components/datarouter/requirements/requirements.rst index 494ccf850..88fc15506 100644 --- a/docs/components/datarouter/requirements/requirements.rst +++ b/docs/components/datarouter/requirements/requirements.rst @@ -49,7 +49,7 @@ Datarouter Services :status: valid :satisfied_by: comp__datarouter - DLT server shall support multiple log channels as specified in AUTOSAR Diagnostic, Log and + Datarouter shall support multiple log channels in its DLT server as specified in AUTOSAR Diagnostic, Log and Trace Protocol Specification. The following parameters shall be configurable statically via a deployment-specific configuration file (``/./etc/log-channels.json``): Number and names of channels, @@ -66,7 +66,7 @@ Datarouter Services :status: valid :satisfied_by: comp__datarouter - DLT server shall support filtering of messages within each channel. The filter shall be + Datarouter shall support filtering of DLT messages within each channel. The filter shall be parametrized with application ID, context ID, log level threshold. Initial filter set shall be part of channel configuration file, located in the following path: ``/../etc/log-channels.json``. @@ -81,8 +81,8 @@ Datarouter Services :status: valid :satisfied_by: comp__datarouter - DLT server shall provide support for verbose DLT messages. Messages sent from mw::log - library shall be sent via DLT using verbose mode. + Datarouter shall support verbose DLT messages. Datarouter shall send messages received from + the mw::log library via DLT using verbose mode. DLT Quotas ---------- @@ -97,7 +97,7 @@ DLT Quotas :status: valid :satisfied_by: comp__datarouter - The component shall have the DLT bandwidth quota configuration in the file located at + Datarouter shall have the DLT bandwidth quota configuration in the file located at ``./etc/log-channels.json`` relative to the application specific location ``/opt/``. .. comp_req:: DLT Quota Bandwidth Reduction @@ -110,7 +110,7 @@ DLT Quotas :status: valid :satisfied_by: comp__datarouter - It shall be possible to configure the action to drop DLT messages when a quota is exceeded. + Datarouter shall allow users to configure the action to drop DLT messages when a quota is exceeded. Note: The configuration shall be provided as an attribute as part of the DLT quota configuration file (:need:`comp_req__data_router__dlt_bw_quota_config`). From 84b5665d6b86f7967186892af90e1e3772bb074b Mon Sep 17 00:00:00 2001 From: Maciej Kaszynski Date: Tue, 27 Oct 2026 08:55:27 +0000 Subject: [PATCH 3/6] Adding central config location req --- .../requirements/chklst_req_inspection.rst | 8 ++++---- .../datarouter/requirements/requirements.rst | 20 ++++++++++++------- 2 files changed, 17 insertions(+), 11 deletions(-) diff --git a/docs/components/datarouter/requirements/chklst_req_inspection.rst b/docs/components/datarouter/requirements/chklst_req_inspection.rst index 17cf7f9d6..bf1609c87 100644 --- a/docs/components/datarouter/requirements/chklst_req_inspection.rst +++ b/docs/components/datarouter/requirements/chklst_req_inspection.rst @@ -79,7 +79,7 @@ See also :need:`doc_concept__wp_inspections` for further information about revie - Is the requirement description *unambiguous* ? - Especially search for "weak words" like "about", "etc.", "relevant" and others (see the internet documentation on this). This check shall be supported by tooling. - Yes - - + - - * - REQ_02_03 - Is the requirement description *atomic* ? @@ -112,9 +112,9 @@ See also :need:`doc_concept__wp_inspections` for further information about revie * - REQ_04_01 - Is the requirement *internally and externally consistent*? - Does the requirement contradict other requirements within the same or higher levels? One may restrict the search to the feature for component requirements, for features to other features using same components. Is the description of the requirement consistent with all its attributes (if not already part of another check, e.g. does the title fit?). - - No - - :need:`comp_req__data_router__dlt_multiple_channels` :need:`comp_req__data_router__dlt_message_filtering` :need:`comp_req__data_router__dlt_bw_quota_config` location is unclear. Define a central location. - - https://github.com/eclipse-score/logging/issues/344 + - Yes + - + - * - REQ_05_01 - Do the software requirements consider *timing constraints*? - This checkpoint encourages to think about timing constraints even if those are not explicitly mentioned in the parent requirement. If the reviewer of a requirement already knows or suspects that the code execution will be consuming a lot of time, one should think of the expectation of a "user". diff --git a/docs/components/datarouter/requirements/requirements.rst b/docs/components/datarouter/requirements/requirements.rst index 88fc15506..0479140b1 100644 --- a/docs/components/datarouter/requirements/requirements.rst +++ b/docs/components/datarouter/requirements/requirements.rst @@ -45,14 +45,20 @@ Datarouter Services :reqtype: Functional :security: NO :safety: QM - :derived_from: feat_req__logging__compat_dlt, feat_req__logging__config_log_filter, feat_req__logging__config_entity_id + :derived_from: feat_req__logging__compat_dlt + :status: valid + :satisfied_by: comp__datarouter + + Datarouter shall support multiple log channels in its DLT server as specified + in AUTOSAR Diagnostic, Log and Trace Protocol Specification. + :status: valid :satisfied_by: comp__datarouter Datarouter shall support multiple log channels in its DLT server as specified in AUTOSAR Diagnostic, Log and Trace Protocol Specification. The following parameters shall be configurable statically via - a deployment-specific configuration file - (``/./etc/log-channels.json``): Number and names of channels, + the deployment-specific configuration file + (:need:`comp_req__data_router__config_file`): Number and names of channels, Network configuration for channel output, Log level threshold per channel, Log channel assignments per application/context. @@ -68,8 +74,8 @@ Datarouter Services Datarouter shall support filtering of DLT messages within each channel. The filter shall be parametrized with application ID, context ID, log level threshold. Initial filter set shall - be part of channel configuration file, located in the following path: - ``/../etc/log-channels.json``. + be part of the deployment-specific configuration file + (:need:`comp_req__data_router__config_file`). .. comp_req:: DLT Verbose Messages :id: comp_req__data_router__dlt_verbose_messages @@ -97,8 +103,8 @@ DLT Quotas :status: valid :satisfied_by: comp__datarouter - Datarouter shall have the DLT bandwidth quota configuration in the file located at - ``./etc/log-channels.json`` relative to the application specific location ``/opt/``. + Datarouter shall have the DLT bandwidth quota configuration in the deployment-specific + configuration file (:need:`comp_req__data_router__config_file`). .. comp_req:: DLT Quota Bandwidth Reduction :id: comp_req__data_router__dlt_quota_bw_reduction From 920c3e30a92b17caa39ce7ab159faa3338696d52 Mon Sep 17 00:00:00 2001 From: Maciej Kaszynski Date: Tue, 27 Oct 2026 09:18:27 +0000 Subject: [PATCH 4/6] Fixing abigious reqs --- .../requirements/chklst_req_inspection.rst | 11 +++-------- .../datarouter/requirements/requirements.rst | 16 ++++++---------- 2 files changed, 9 insertions(+), 18 deletions(-) diff --git a/docs/components/datarouter/requirements/chklst_req_inspection.rst b/docs/components/datarouter/requirements/chklst_req_inspection.rst index bf1609c87..4accbf2b4 100644 --- a/docs/components/datarouter/requirements/chklst_req_inspection.rst +++ b/docs/components/datarouter/requirements/chklst_req_inspection.rst @@ -67,14 +67,9 @@ See also :need:`doc_concept__wp_inspections` for further information about revie * - REQ_02_01 - Is the requirement description *comprehensible* ? - If you think the requirement is hard to understand, comment here. - - No - - :need:`comp_req__data_router__dlt_server` shall implement the UDP multicast transport of a Dlt server. - :need:`comp_req__data_router__dlt_multiple_channels` define in glossary multi-channel. - :need:`comp_req__data_router__dlt_message_filtering` shall allow for filtering messages - per channel based on application ID, - context ID, log level threshold. - :need:`comp_req__data_router__dlt_verbose_messages` The verbose mode of the original message shall be unmodified. - - https://github.com/eclipse-score/logging/issues/344 + - Yes + - + - * - REQ_02_02 - Is the requirement description *unambiguous* ? - Especially search for "weak words" like "about", "etc.", "relevant" and others (see the internet documentation on this). This check shall be supported by tooling. diff --git a/docs/components/datarouter/requirements/requirements.rst b/docs/components/datarouter/requirements/requirements.rst index 0479140b1..fca2815cd 100644 --- a/docs/components/datarouter/requirements/requirements.rst +++ b/docs/components/datarouter/requirements/requirements.rst @@ -36,8 +36,8 @@ Datarouter Services :status: valid :satisfied_by: comp__datarouter - Datarouter shall implement DLT server component. Datarouter provides the functionality to - send messages using DLT protocol over UDP multicast transport. + Datarouter shall implement the UDP multicast transport of a DLT server, sending + messages using the DLT packet format. .. comp_req:: DLT Multiple Channel Support :id: comp_req__data_router__dlt_multiple_channels @@ -49,14 +49,10 @@ Datarouter Services :status: valid :satisfied_by: comp__datarouter - Datarouter shall support multiple log channels in its DLT server as specified - in AUTOSAR Diagnostic, Log and Trace Protocol Specification. - - :status: valid - :satisfied_by: comp__datarouter - - Datarouter shall support multiple log channels in its DLT server as specified in AUTOSAR Diagnostic, Log and - Trace Protocol Specification. The following parameters shall be configurable statically via + Datarouter shall support multiple log channels in its DLT server, each with its own + destination and filter settings, as specified in AUTOSAR Diagnostic, Log and Trace + Protocol Specification. + The following parameters shall be configurable statically via the deployment-specific configuration file (:need:`comp_req__data_router__config_file`): Number and names of channels, Network configuration for channel output, Log level threshold per channel, Log channel From d50a445c696075075f61cb5a71829f246233fe80 Mon Sep 17 00:00:00 2001 From: Maciej Kaszynski Date: Tue, 27 Oct 2026 10:06:13 +0000 Subject: [PATCH 5/6] Fixing non-atomic reqs --- .../requirements/chklst_req_inspection.rst | 10 ++-- .../datarouter/requirements/requirements.rst | 51 ++++++++++++++++--- 2 files changed, 46 insertions(+), 15 deletions(-) diff --git a/docs/components/datarouter/requirements/chklst_req_inspection.rst b/docs/components/datarouter/requirements/chklst_req_inspection.rst index 4accbf2b4..3723d09f4 100644 --- a/docs/components/datarouter/requirements/chklst_req_inspection.rst +++ b/docs/components/datarouter/requirements/chklst_req_inspection.rst @@ -79,13 +79,9 @@ See also :need:`doc_concept__wp_inspections` for further information about revie * - REQ_02_03 - Is the requirement description *atomic* ? - A good way to think about this is to consider if the requirement may be tested by one (positive) test case or needs more of these. The requirement formulation template should also avoid being non-atomic already. Note that there are cases where also non-atomic requirements are the better ones, for example if those are better understandable. - - No - - :need:`comp_req__data_router__dlt_multiple_channels` config files should be another requirement. - :need:`comp_req__data_router__dlt_message_filtering` also has this. - Maybe a central requirement to specify that all parameters shall be - configurable with console or config. e.g. comp_req__log__cfg_precedence on the front end. - :need:`comp_req__data_router__dlt_server` shall be split for the UDP part and link to only :need:`feat_req__logging__log_sinks_network`. - - https://github.com/eclipse-score/logging/issues/344 + - Yes + - + - * - REQ_02_04 - Is the requirement description *feasible* ? - If at the time of the inspection the requirement has already some implementation, the answer is yes. This can be checked via traces, but also :need:`gd_req__req_attr_impl` shows this. In case the requirement has no implementation at the time of inspection (i.e. not implemented at least as "proof-of-concept"), a development expert should be invited to the Pull-Request review to explicitly check this item. diff --git a/docs/components/datarouter/requirements/requirements.rst b/docs/components/datarouter/requirements/requirements.rst index fca2815cd..88b0b482c 100644 --- a/docs/components/datarouter/requirements/requirements.rst +++ b/docs/components/datarouter/requirements/requirements.rst @@ -32,12 +32,23 @@ Datarouter Services :reqtype: Functional :security: NO :safety: QM - :derived_from: feat_req__logging__compat_dlt, feat_req__logging__log_sinks_network + :derived_from: feat_req__logging__compat_dlt :status: valid :satisfied_by: comp__datarouter - Datarouter shall implement the UDP multicast transport of a DLT server, sending - messages using the DLT packet format. + Datarouter shall implement a DLT server, sending messages in the DLT packet format. + +.. comp_req:: DLT Server UDP Multicast Transport + :id: comp_req__data_router__dlt_udp_multicast + :version: 1 + :reqtype: Functional + :security: NO + :safety: QM + :derived_from: feat_req__logging__log_sinks_network + :status: valid + :satisfied_by: comp__datarouter + + Datarouter shall transmit the DLT messages of its DLT server over UDP multicast. .. comp_req:: DLT Multiple Channel Support :id: comp_req__data_router__dlt_multiple_channels @@ -52,11 +63,35 @@ Datarouter Services Datarouter shall support multiple log channels in its DLT server, each with its own destination and filter settings, as specified in AUTOSAR Diagnostic, Log and Trace Protocol Specification. - The following parameters shall be configurable statically via - the deployment-specific configuration file - (:need:`comp_req__data_router__config_file`): Number and names of channels, - Network configuration for channel output, Log level threshold per channel, Log channel - assignments per application/context. + +.. comp_req:: Datarouter Configuration File + :id: comp_req__data_router__config_file + :version: 1 + :reqtype: Functional + :security: NO + :safety: QM + :derived_from: feat_req__logging__config_log_filter + :status: valid + :satisfied_by: comp__datarouter + + Datarouter shall be able to read a deployment-specific configuration file located at + ``/../etc/log-channels.json``. + +.. comp_req:: DLT Channel Configuration + :id: comp_req__data_router__dlt_channel_config + :version: 1 + :reqtype: Functional + :security: NO + :safety: QM + :derived_from: feat_req__logging__config_log_filter, feat_req__logging__config_entity_id + :status: valid + :satisfied_by: comp__datarouter + + The following parameters of the DLT log channels + (:need:`comp_req__data_router__dlt_multiple_channels`) shall be configurable statically via + the deployment-specific configuration file (:need:`comp_req__data_router__config_file`): + Number and names of channels, Network configuration for channel output, Log level + threshold per channel, Log channel assignments per application/context. .. comp_req:: DLT Message Filtering :id: comp_req__data_router__dlt_message_filtering From f5eb22678f14a0cc88d835ade355bce3a257e508 Mon Sep 17 00:00:00 2001 From: Maciej Kaszynski Date: Tue, 27 Oct 2026 10:22:57 +0000 Subject: [PATCH 6/6] Fixing last finding --- .../datarouter/requirements/chklst_req_inspection.rst | 9 ++++----- docs/components/datarouter/requirements/requirements.rst | 2 +- 2 files changed, 5 insertions(+), 6 deletions(-) diff --git a/docs/components/datarouter/requirements/chklst_req_inspection.rst b/docs/components/datarouter/requirements/chklst_req_inspection.rst index 3723d09f4..8f1a8c84e 100644 --- a/docs/components/datarouter/requirements/chklst_req_inspection.rst +++ b/docs/components/datarouter/requirements/chklst_req_inspection.rst @@ -17,7 +17,7 @@ :id: doc__datarouter_req_inspection :status: draft :version: 1 - :safety: ASIL_B + :safety: QM :security: YES :realizes: wp__requirements_inspect @@ -151,10 +151,9 @@ See also :need:`doc_concept__wp_inspections` for further information about revie * - REQ_10_01 - Is the requirement description *complete* ? - For every requirement in the inspection, follow to its parent (feature) requirement(s) and then check if this/these are fulfilled completely by its/their linked children (component requirements, including those which are not in scope of the inspection). - - No - - :need:`comp_req__data_router__dlt_verbose_messages` might need a feature requirement. - :need:`comp_req__data_router__dlt_bw_quota_config` should also map to :need:`feat_req__logging__message_loss_handling` & :need:`feat_req__logging__qos_message_handling`. - - https://github.com/eclipse-score/logging/issues/344 + - Yes + - + - .. attention:: The above checklist entries must be filled according to your component requirements in scope. diff --git a/docs/components/datarouter/requirements/requirements.rst b/docs/components/datarouter/requirements/requirements.rst index 88b0b482c..16682dd0a 100644 --- a/docs/components/datarouter/requirements/requirements.rst +++ b/docs/components/datarouter/requirements/requirements.rst @@ -130,7 +130,7 @@ DLT Quotas :reqtype: Functional :security: NO :safety: QM - :derived_from: feat_req__logging__config_buffer_size, feat_req__logging__resource_comm_channel + :derived_from: feat_req__logging__config_buffer_size, feat_req__logging__resource_comm_channel, feat_req__logging__message_loss_handling, feat_req__logging__qos_message_handling :status: valid :satisfied_by: comp__datarouter