Lines Matching full:logging
1 # phosphor-logging
3 The phosphor logging repository provides mechanisms for event and journal
4 logging.
9 - [Structured Logging](#structured-logging)
12 - [Remote Logging](#remote-logging-via-rsyslog)
22 ## Structured Logging
24 phosphor-logging provides APIs to add program logging information to the
25 systemd-journal and it is preferred that this logging data is formatted in a
28 See [Structured Logging](./docs/structured-logging.md) for more details on this
34 phosphor-log-manager that reside at `/xyz/openbmc_project/logging/entry/X`,
39 - [xyz.openbmc_project.Logging.Entry]
56 The logging daemon has the ability to add `callout` associations to an event log
66 [Logging.Cleared][logging-cleared] event, which will generate a C++ class for
71 lg2::commit(sdbusplus::event::xyz::openbmc_project::Logging::Cleared(
84 Vendors customizing phosphor-logging for their platforms may decide that they
98 …https://github.com/openbmc/phosphor-logging/blob/master/tools/phosphor-logging/default-eventfilter…
100 …https://github.com/openbmc/phosphor-logging/blob/master/tools/phosphor-logging/schemas/eventfilter…
109 https://github.com/openbmc/docs/blob/master/designs/event-logging.md#phosphor-logging
110 [logging-cleared]:
111 …faces/blob/6a8507d06e172d8d29c0459f0a0d078553d2ecc7/yaml/xyz/openbmc_project/Logging.events.yaml#L4
115 Event logs can be created by using phosphor-logging APIs to commit sdbusplus
117 method on the logging daemon to create the event log using the information it
120 The APIs are found in `<phosphor-logging/elog.hpp>`:
128 Any errors passed into these APIs must be known to phosphor-logging, usually by
129 being defined in `<phosphor-logging/elog-errors.hpp>`. The errors must also be
136 #include <phosphor-logging/elog-errors.hpp>
137 #include <phosphor-logging/elog.hpp>
145 phosphor::logging::report<InternalFailure>();
155 phosphor::logging::elog<InternalFailure>();
159 phosphor::logging::commit<InternalFailure>();
165 `xyz.openbmc_project.Logging.Entry` interface. Metadata is passed in via the
173 #include <phosphor-logging/elog-errors.hpp>
174 #include <phosphor-logging/elog.hpp>
180 phosphor::logging::xyz::openbmc_project::Control::Device::WriteFailure;
184 phosphor::logging::report<WriteFailure>(metadata::CALLOUT_ERRNO(5),
199 As mentioned above, both sdbusplus and phosphor-logging must know about the
204 repository. During the build, phosphor-logging generates the elog-errors.hpp
222 3. Tell phosphor-logging about the error:
223 1. Run phosphor-logging's `elog-gen.py` script on the local yaml to generate
227 phosphor-logging can find it during the build. See sample [LED
234 - Service: xyz.openbmc_project.Logging
235 - Object Path: /xyz/openbmc_project/logging
236 - Interface: xyz.openbmc_project.Logging.Create
240 `xyz.openbmc_project.Logging.Entry` interface.
242 `xyz.openbmc_project.Logging.Entry` interface. An
243 `xyz.openbmc_project.Logging.Entry.Level` enum value.
245 `xyz.openbmc_project.Logging.Entry` interface, but in a map instead of in
257 log, the logging daemon doesn't have to know about it ahead of time either.
282 [xyz.openbmc_project.logging.entry]:
283 …https://github.com/openbmc/phosphor-dbus-interfaces/blob/master/yaml/xyz/openbmc_project/Logging/E…
298 …https://github.com/openbmc/phosphor-dbus-interfaces/blob/master/yaml/xyz/openbmc_project/Logging/C…
303 logs besides phosphor-logging's event logs to still reside in the
333 In addition, an extension has the option of disabling phosphor-logging's default
415 ## Remote Logging via Rsyslog
427 ### Configuring rsyslog server for remote logging
441 https://<BMC IP address>/xyz/openbmc_project/logging/config/remote/attr/Address
449 https://<BMC IP address>/xyz/openbmc_project/logging/config/remote/attr/Port
456 https://<BMC IP address>/xyz/openbmc_project/logging/config/remote
471 #### Disabling remote logging argument
473 Remote logging can be disabled by writing 0 to the port, or an empty string("")
483 phosphor-logging supports a setting, which when set, will result in the software
484 looking at new phosphor-logging entries being created, and if a CALLOUT\* is
495 …rty xyz.openbmc_project.Settings /xyz/openbmc_project/logging/settings xyz.openbmc_project.Logging…