| Adriana Kobylak | 88eb109 | 2016-11-07 12:17:23 -0600 | [diff] [blame] | 1 | description: > |
| Patrick Williams | 26919f0 | 2022-12-08 06:12:43 -0600 | [diff] [blame] | 2 | Implement to provide event/error logging management features. This interface |
| 3 | should be instantiated for the phosphor::logging namespace, and only one is |
| 4 | required. |
| Adriana Kobylak | 88eb109 | 2016-11-07 12:17:23 -0600 | [diff] [blame] | 5 | methods: |
| 6 | - name: Commit |
| 7 | description: > |
| 8 | Write the requested error/event entry with its associated metadata |
| Deepak Kodihalli | 6fd9dc4 | 2018-04-03 02:08:42 -0500 | [diff] [blame] | 9 | fields to flash. The "level" of the committed error log is same as the |
| 10 | level defined in error YAML definitions. |
| Adriana Kobylak | 88eb109 | 2016-11-07 12:17:23 -0600 | [diff] [blame] | 11 | parameters: |
| Patrick Williams | 26919f0 | 2022-12-08 06:12:43 -0600 | [diff] [blame] | 12 | - name: transactionId |
| 13 | type: uint64 |
| 14 | description: > |
| 15 | The unique identifier of the journal entry(ies) to be committed. |
| 16 | - name: errMsg |
| 17 | type: string |
| 18 | description: > |
| 19 | The error exception message associated with the error event log |
| 20 | to be committed. |
| Lei YU | b50c705 | 2021-01-21 16:02:26 +0800 | [diff] [blame] | 21 | returns: |
| Patrick Williams | 26919f0 | 2022-12-08 06:12:43 -0600 | [diff] [blame] | 22 | - name: entryID |
| 23 | type: uint32 |
| 24 | description: > |
| 25 | The ID of the entry. |
| Deepak Kodihalli | 6fd9dc4 | 2018-04-03 02:08:42 -0500 | [diff] [blame] | 26 | - name: CommitWithLvl |
| 27 | description: > |
| 28 | Write the requested error/event entry with its associated metadata |
| 29 | fields to flash. This interface allows the caller to override the |
| 30 | error level specified in the error YAML definition. |
| 31 | parameters: |
| Patrick Williams | 26919f0 | 2022-12-08 06:12:43 -0600 | [diff] [blame] | 32 | - name: transactionId |
| 33 | type: uint64 |
| 34 | description: > |
| 35 | The unique identifier of the journal entry(ies) to be committed. |
| 36 | - name: errMsg |
| 37 | type: string |
| 38 | description: > |
| 39 | The error exception message associated with the error event log |
| 40 | to be committed. |
| 41 | - name: errLvl |
| 42 | type: uint32 |
| 43 | description: > |
| 44 | The error level/severity indicator. |
| Lei YU | b50c705 | 2021-01-21 16:02:26 +0800 | [diff] [blame] | 45 | returns: |
| Patrick Williams | 26919f0 | 2022-12-08 06:12:43 -0600 | [diff] [blame] | 46 | - name: entryID |
| 47 | type: uint32 |
| 48 | description: > |
| 49 | The ID of the entry. |