commit | c6fecdabd58b4c380caf1b83801ad4eb54922fff | [log] [tgz] |
---|---|---|
author | Claire Weinan <cweinan@google.com> | Fri Jul 15 10:43:25 2022 -0700 |
committer | Ed Tanous <ed@tanous.net> | Fri Sep 09 03:00:53 2022 +0000 |
tree | 2090c899b199c624bf9da0be25921430a3ef9193 | |
parent | 6936afe4e687c8e94b7b1281fa9796101202871a [diff] |
LogService: Increase Fault Log timestamp precision https://gerrit.openbmc.org/c/openbmc/bmcweb/+/55837 introduced support for microsecond-precision timestamps in bmcweb. Here we modify the Fault Log LogService (/redfish/v1/Managers/bmc/LogServices/FaultLog) to use microsecond-precision "Created" timestamps for its log entries. The motivation for increased precision is to increase the chance of having unique timestamps in case faults happen in quick succession. Unique timestamps are helpful for data center tools to keep log entries in chronological order and to track which entries have been seen before. The "Created" timestamp is based on the "Elapsed" property of the D-Bus interface xyz.openbmc_project.Time.EpochTime [1]. Dump entries must implement xyz.openbmc_project.Time.EpochTime [2]. Note: our intention is to increase timestamp precision to microseconds for all dump types. However at the moment the BMC dump and System dump managers (in phosphor-debug-collector module) are not populating EpochTime with microsecond precision as they should. So for now this patchset only increases precision for the FaultLog dump type. Changes to the Redfish tree: Clients will now see microsecond-precision instead of second-precision "Created" timestamps for fault log entries. Tested: Verified that Fault Log entries include microsecond-precision "Created" timestamps both when entries are retrieved individually and as a collection. Example commands: ``` curl -k -H "X-Auth-Token: $token" -X GET http://${bmc}/redfish/v1/Managers/bmc/LogServices/FaultLog/Entries curl -k -H "X-Auth-Token: $token" -X GET http://${bmc}/redfish/v1/Managers/bmc/LogServices/FaultLog/Entries/1 ``` Example timestamp output: "Created": "2022-07-12T15:56:33.017346+00:00", Also verified that BMC dump and System dump "Created" timestamps remain unchanged (they still use second-precision). Example commands: ``` curl -k -H "X-Auth-Token: $token" -X GET http://${bmc}/redfish/v1/Managers/bmc/LogServices/Dump/Entries curl -k -H "X-Auth-Token: $token" -X GET http://${bmc}/redfish/v1/Systems/system/LogServices/Dump/Entries ``` Redfish Service Validator succeeded on the following URI trees: /redfish/v1/Managers/bmc/LogServices/FaultLog /redfish/v1/Managers/bmc/LogServices/Dump [1] https://github.com/openbmc/phosphor-dbus-interfaces/blob/master/yaml/xyz/openbmc_project/Time/EpochTime.interface.yaml [2] https://github.com/openbmc/phosphor-dbus-interfaces/blob/master/yaml/xyz/openbmc_project/Dump/Entry.interface.yaml Signed-off-by: Claire Weinan <cweinan@google.com> Change-Id: I400a24def8dbeff1046b93f0bb64e04ae5038e9a
This component attempts to be a "do everything" embedded webserver for OpenBMC.
The webserver implements a few distinct interfaces:
bmcweb at a protocol level supports http and https. TLS is supported through OpenSSL.
Bmcweb supports multiple authentication protocols:
Each of these types of authentication is able to be enabled or disabled both via runtime policy changes (through the relevant Redfish APIs) or via configure time options. All authentication mechanisms supporting username/password are routed to libpam, to allow for customization in authentication implementations.
All authorization in bmcweb is determined at routing time, and per route, and conform to the Redfish PrivilegeRegistry.
*Note: Non-Redfish functions are mapped to the closest equivalent Redfish privilege level.
bmcweb is configured per the meson build files. Available options are documented in meson_options.txt
meson builddir ninja -C builddir
If any of the dependencies are not found on the host system during configuration, meson will automatically download them via its wrap dependencies mentioned in bmcweb/subprojects
.
bmcweb by default is compiled with runtime logging disabled, as a performance consideration. To enable it in a standalone build, add the
-Dlogging='enabled'
option to your configure flags. If building within Yocto, add the following to your local.conf.
EXTRA_OEMESON:pn-bmcweb:append = "-Dbmcweb-logging='enabled'"
bmcweb relies on some on-system data for storage of persistent data that is internal to the process. Details on the exact data stored and when it is read/written can seen from the persistent_data namespace.
When SSL support is enabled and a usable certificate is not found, bmcweb will generate a self-signed a certificate before launching the server. Please see the bmcweb source code for details on the parameters this certificate is built with.