docs/architecture/redfish-logging-in-bmcweb.md

6 Redfish Message Objects can be represented in different ways. In bmcweb, we have
7 chosen to use Message Registries with Message Objects that are referenced using
13 ## Message Registries
15 The first step when adding a new message to the Redfish event log is to find or
16 add an appropriate message in a Message Registry.
18 The bmcweb Message Registries are located under
22 If an appropriate message exists, note the
24 1. Title of the Message Object (required as the MessageKey in the MessageId).
25 2. Args (notated as "%x") in the "Message" field (required for the MessageArgs).
27 If an appropriate message does not exist, new messages can be added as follows:
29 1. Choose a Message Registry for the new message
30 2. Choose a MessageKey to use as the title for the new Message entry
31 3. Insert a new Message entry (preferably with the title in alphabetical order)
34 6. Define the `message` with any necessary args
35 7. Set the `numberOfArgs` and `paramTypes` to match the message args
46 bmcweb will search the specified Message Registry for the MessageKey, construct
47 the final message using the MessageArgs, and display that in the event log.
66 [Resource Event Message Registry](https://redfish.dmtf.org/registries/ResourceEvent.1.0.0.json)
67 holds the ResourceCreated message:
74         "Message": "The resource has been created successfully.",
82 Since there are no parameters, no MessageArgs are required, so this message can
95 sd_journal_send("MESSAGE=%s", "journal text", "PRIORITY=%i", <LOG_LEVEL>,
103 [Resource Event Message Registry](https://redfish.dmtf.org/registries/ResourceEvent.1.0.0.json)
104 holds the ResourceErrorThresholdExceeded message:
112         "Message": "The resource property %1 has exceeded error
125 This message has two parameters, `%1` and `%2`, as indicated in the
127 from the `"Message"` and `"ParamTypes"` fields in the Message Registry.
133 this message can be logged to the journal as follows:
147 sd_journal_send("MESSAGE=%s", "journal text", "PRIORITY=%i", <LOG_LEVEL>,