diff options
| author | Gunnar Mills <gmills@us.ibm.com> | 2023-02-22 22:12:57 +0300 |
|---|---|---|
| committer | Gunnar Mills <gmills@us.ibm.com> | 2023-03-09 05:22:19 +0300 |
| commit | 0e88cb374b42224753e78ea1a98b349511fbb9e6 (patch) | |
| tree | 5c631ef4a77bba6d1ce0c00b89cbf2ae81d01f94 /README.md | |
| parent | 8d8c30c32d4040637ee03063cc7c1e6657ad686e (diff) | |
| download | bmcweb-0e88cb374b42224753e78ea1a98b349511fbb9e6.tar.xz | |
Attempt to document logging levels
List the 5 logging levels. Attempt to document what each does and some
example use cases.
We have a use case where we want to log internal bmcweb errors. debug is
way too chatty. Want to be able to select the logging level. This is the
documentation for that end goal.
These are loosely followed today and more patches will come to move some
traces to the appropriate level.
In our use case, we don't want to be blown up by a fuzz tester but do
want internal errors. This is the difference between error logging level
and warning logging level. Warning is used for 4xx (e.g. 404) and error
is used for 5xx.
Plan to write a tool to walk the redfish tree and try random Redfish ids
and/or try a open source fuzzing tool. The logging for these 404s should
be warning.
Moved the ## Debug logging section from the README.md to this
DEVELOPING.md. Wanted the logging all together but didn't think we had
enough for a LOGGING.md and README seems too high level for this detail.
Tested: Pushed to my fork and formatting looked good.
Change-Id: I9713a4e674b3f519fec3f3caac0178af8d8d73a8
Signed-off-by: Gunnar Mills <gmills@us.ibm.com>
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 16 |
1 files changed, 0 insertions, 16 deletions
@@ -63,22 +63,6 @@ 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`. -## Debug logging - -bmcweb by default is compiled with runtime logging disabled, as a performance -consideration. To enable it in a standalone build, add the - -```ascii --Dlogging='enabled' -``` - -option to your configure flags. If building within Yocto, add the following to -your local.conf. - -```bash -EXTRA_OEMESON:pn-bmcweb:append = "-Dbmcweb-logging='enabled'" -``` - ## Use of persistent data bmcweb relies on some on-system data for storage of persistent data that is |