How openbmc/phosphor-logging works
Project Type and Purpose
• This is a system‐level, C++ logging library and daemon (“phosphor-log-manager”) within the OpenBMC ecosystem.
• It provides:
• A structured logging API (lg2::commit, elog, report) for applications.
• An event‐logging daemon exposing D-Bus interfaces.
• Code‐generation tools that produce C++ classes from YAML event definitions.
• Pluggable extensions (e.g., OpenPower PELs) and remote‐logging via rsyslog.
File‐Structure Analysis
• Top‐level executables & service
• log_create_main.cpp, log_manager_main.cpp, log_resolve_main.cpp
• phosphor-rsyslog-config/ – config tool for remote logging
• Core library
• lib/ – lg2 logger implementation, sdjournal integration
• callouts/ – YAML‐based callout generation scripts & templates
• Code generation
• gen/ – Meson build files, D-Bus interface stub generation from YAML
• yaml/ – Interface definitions for D-Bus objects
• Extensions
• extensions/openpower-pels/ – PEL formatting & registration callbacks
• Configuration and packaging
• config/, dist/ – Meson fragments, D-Bus service files, rsyslog defaults
• Tests
• test/, callouts/callout_test.cpp, test/openpower-pels/*
• Build & dependencies
• meson.build, meson.options, subprojects/ – wrapped dependencies (sdbusplus, nlohmann_json, etc.)
Key Components
a. Logging API (libphosphor-logging, lg2)
b. Phosphor‐Log‐Manager Daemon
c. sdbusplus / system D-Bus bus
d. systemd‐journal (sdjournal)
e. Code‐generation module (tools + gen directory)
f. Extensions subsystem (plugin directory + macros)
g. Remote logging client (rsyslog client config)
h. Consumer applications (any OpenBMC service using lg2::commit)
i. Configuration REST interface (settings service for remote logging, boot‐fail)
Relationships & Data Flows
• Consumer apps → call lg2::commit / elog() → writes metadata to systemd-journal → emits D-Bus signal/exception
• Phosphor‐Log‐Manager → listens on D-Bus for commit signals or Create() calls → reads journal metadata → creates D-Bus object under /xyz/openbmc_project/logging/entry/X
• Extensions → REGISTER_EXTENSION_FUNCTION hooks in the daemon → invoked on log create/delete events → may disable caps or write alternate logs (e.g., PELs)
• Rsyslog client → reads systemd-journal via journal-gateway or journal configuration → forwards to external rsyslog server
• Configuration REST calls → update D-Bus Settings interface → daemon picks up new remote server address/port
• Code generation (build time) → gen/* & tools/* → parse YAML → emit C++ headers & meson.build fragments
Architectural Patterns & Principles
• Plugin/extension framework (REGISTER_EXTENSION_FUNCTION, DISABLE_LOG_ENTRY_CAPS)
• Event‐driven, pub/sub via D-Bus and systemd‐journal
• Code‐generation for consistency and interface‐driven design (YAML → C++)
• Clear separation: API layer vs. daemon vs. extensions vs. transport (journal/D-Bus/rsyslog)
Technologies & Frameworks
• C++17, Meson build system
• sdbusplus for D-Bus IPC
• systemd-journal (sdjournal) for persistent event metadata
• Python scripts for codegen (elog-gen.py, callouts.py)
• YAML for D-Bus interface & error/event definitions
• JSON for event‐filter policies and rsyslog templates
• Rsyslog for remote streaming of journal entries