Log Requirements
status: valid
security: NO
safety: ASIL_B
tags: log
version: 1
realizes: wp__requirements_comp
doc__log_requirements
Generic Document

Log Frontend Requirements#

Configuration#

Logging Configuration File Location
status: valid
security: NO
safety: ASIL_B
tags: logging
reqtype: Functional
version: 1
derived from: feat_req__logging__config_fallback
satisfied by: comp__log

The application specific file shall be the first valid configuration file from the following locations.

  1. location pointed to by the environmental variable MW_LOG_CONFIG_FILE

  2. <cwd>/etc/logging.json

  3. <cwd>/logging.json

  4. <binary path>/../etc/logging.json
comp_req__log__cfg_file_loc
Component Requirement
Logging Global Configuration File
status: valid
security: NO
safety: ASIL_B
tags: logging
reqtype: Functional
version: 1
derived from: feat_req__logging__config_fallback
satisfied by: comp__log

mw::log shall load configurations from a global configuration file.

The global configuration shall be loaded from /etc/ecu_logging_config.json
comp_req__log__global_config
Component Requirement
Logging Configuration File Defaults
status: valid
security: NO
safety: ASIL_B
tags: logging
reqtype: Functional
version: 1
derived from: feat_req__logging__config_fallback
satisfied by: comp__log

mw::log shall fall back to a default value for a configuration item that is not available from the configuration files.

These are hard-coded in the library.
comp_req__log__cfg_defaults
Component Requirement
Logging Configuration Precedence
status: valid
security: NO
safety: ASIL_B
tags: logging
reqtype: Functional
version: 1
derived from: feat_req__logging__config_fallback
satisfied by: comp__log

For each configuration field, mw::log shall resolve values using the following precedence order:

  1. Application configuration file

  2. Global configuration file

  3. Defaults
comp_req__log__cfg_precedence
Component Requirement
Logging Configuration Syntax Errors Handling
status: valid
security: NO
safety: ASIL_B
tags: logging
reqtype: Functional
version: 1
derived from: feat_req__logging__error_handling_recoverable
satisfied by: comp__log

mw::log shall discard any configuration files with syntax errors and continue using other sources of configuration.
comp_req__log__cfg_syntax_err
Component Requirement
Logging Configuration Invalid Settings Handling
status: valid
security: NO
safety: ASIL_B
tags: logging
reqtype: Functional
version: 1
derived from: feat_req__logging__error_handling_recoverable
satisfied by: comp__log

mw::log shall discard any invalid configuration fields.

Invalid meaning that the value is not in the expected range or format.
comp_req__log__cfg_invalid
Component Requirement

Configuration Fields#

Logging Configuration Log Storage Device
status: valid
security: NO
safety: ASIL_B
tags: logging
reqtype: Functional
version: 1
derived from: feat_req__logging__sink_device
satisfied by: comp__log

mw::log shall support configuration of a file path specifying where log are written.
comp_req__log__cfg_sink_device
Component Requirement
Logging Configuration Internal Buffer Size
status: valid
security: NO
safety: ASIL_B
tags: logging
reqtype: Functional
version: 1
derived from: feat_req__logging__config_buffer_size
satisfied by: comp__log

mw::log shall allow configuration of the size of the internal buffer.
comp_req__log__cfg_buffer_size
Component Requirement
Logging Configuration Log ECU Identifier
status: valid
security: NO
safety: ASIL_B
tags: logging
reqtype: Functional
version: 1
derived from: feat_req__logging__config_entity_id, feat_req__logging__entity_identifier
satisfied by: comp__log

mw::log shall support configuration of an ECU log identifier, which shall be a DLT-style ASCII uppercase 4 character string.
comp_req__log__cfg_log_ecu_id
Component Requirement
Logging Configuration Log Application Identifier
status: valid
security: NO
safety: ASIL_B
tags: logging
reqtype: Functional
version: 1
derived from: feat_req__logging__config_entity_id, feat_req__logging__entity_identifier
satisfied by: comp__log

mw::log shall support configuration of an application log identifier, which shall be a DLT-style ASCII uppercase 4 character string.
comp_req__log__cfg_log_app_id
Component Requirement

Log Handling#

Message Loss Detection
status: valid
security: NO
safety: ASIL_B
tags: logging
reqtype: Functional
version: 1
derived from: feat_req__logging__message_loss_detection
satisfied by: comp__log

mw::log shall detect and report any message loss.
comp_req__log__log_loss_detect
Component Requirement
Custom Log Types
status: valid
security: NO
safety: ASIL_B
tags: logging
reqtype: Functional
version: 1
derived from: feat_req__logging__config_custom_types
satisfied by: comp__log
fulfilled by: comp_arc_dyn__log__log_op, comp_arc_sta__log__class_diagram

mw::log shall allow extensions for custom log types.
comp_req__log__cfg_custom_types
Component Requirement

Log Message Format#

Local Timestamp
status: valid
security: NO
safety: ASIL_B
tags: logging
reqtype: Functional
version: 1
derived from: feat_req__logging__timestamping_local
satisfied by: comp__log

mw::log shall attach a local timestamp to each log entry.
comp_req__log__timestamp_local
Component Requirement

System Backend#

System Logger Backend
status: valid
security: NO
safety: ASIL_B
tags: logging
reqtype: Functional
version: 1
derived from: feat_req__logging__early_startup
satisfied by: comp__log

mw::log shall support logging of slog backed for QNX deployments.
comp_req__log__system_logger
Component Requirement

Console Backend#

Console Backend Stdout Sink
status: valid
security: NO
safety: ASIL_B
tags: logging
reqtype: Functional
version: 1
derived from: feat_req__logging__log_sinks_stdout
satisfied by: comp__log

mw::log shall support output log messages to stdout when running unit tests.
comp_req__log__console_backend
Component Requirement

Compatibility#

Compatibility Supported Operating Systems
status: valid
security: NO
safety: ASIL_B
tags: logging
reqtype: Interface
version: 1
derived from: feat_req__logging__compat_os
satisfied by: comp__log

mw::log shall support QNX and Linux operating systems, encapsulated via OSAL.
comp_req__log__compat_os
Component Requirement
Compatibility Supported Programming Languages
status: valid
security: NO
safety: ASIL_B
tags: logging
reqtype: Interface
version: 1
derived from: feat_req__logging__compat_languages
satisfied by: comp__log
fulfilled by: comp_arc_dyn__log__log_op, comp_arc_dyn__log__log_to_level, comp_arc_sta__log__class_diagram, comp_arc_sta__log__static_view

mw::log shall provide a logging API for C++ and Rust.
comp_req__log__compat_languages
Component Requirement