Svc/PassiveConsoleTextLogger/docs/sdd.md
The Svc::PassiveConsoleTextLogger is a passive component that prints the text version of events to stdout. It supports per-severity filtering and event ID filtering.
| Requirement | Description | Verification Method |
|---|---|---|
| ISF-PTL-001 | The Svc::PassiveConsoleTextLogger component shall print received log texts to standard output. | Inspection |
| ISF-PTL-002 | The Svc::PassiveConsoleTextLogger component shall support per-severity event filtering via a public setSeverityFilter() method. | Unit Test |
| ISF-PTL-003 | The Svc::PassiveConsoleTextLogger component shall never filter FATAL events regardless of filter configuration. | Unit Test |
The Svc::PassiveConsoleTextLogger component has one synchronous input port for receiving text events. All processing occurs in the caller's thread.
| Port Data Type | Name | Direction | Kind | Usage |
|---|---|---|---|---|
Fw::LogText | TextLogger | Input | Synchronous | Logging port |
The Svc::PassiveConsoleTextLogger prints formatted event text to stdout via Fw::Logger::log.
The component supports per-severity event filtering via the setSeverityFilter(Fw::LogSeverity, bool) method. Each of the six filterable severity levels (WARNING_HI, WARNING_LO, COMMAND, ACTIVITY_HI, ACTIVITY_LO, DIAGNOSTIC) can be independently enabled or disabled. When a severity is disabled, events at that level are silently dropped. FATAL events are never filtered regardless of configuration.
Default filter states are configured via constants in PassiveTextLoggerCfg.hpp. By default, all severities pass through except DIAGNOSTIC, which is filtered out.
The filtering logic is provided by the shared Svc::EventSeverityFilter utility class.
Not applicable
To see unit test coverage run fprime-util check --coverage
| Date | Description |
|---|---|
| 4/20/2017 | Initial Version |
| 2026 | Added severity filtering documentation, requirements, and unit tests |