xref: /openbmc/phosphor-logging/yaml/xyz/openbmc_project/Logging/Internal/Manager.interface.yaml (revision 26919f07088bc9335e9280c19c94ec147a2d5e5e)
1f2131442SPatrick Williamsdescription: >
2*26919f07SPatrick Williams    Implement to provide event/error logging management features. This interface
3*26919f07SPatrick Williams    should be instantiated for the phosphor::logging namespace, and only one is
4*26919f07SPatrick Williams    required.
5f2131442SPatrick Williamsmethods:
6f2131442SPatrick Williams    - name: Commit
7f2131442SPatrick Williams      description: >
8f2131442SPatrick Williams          Write the requested error/event entry with its associated metadata
9f2131442SPatrick Williams          fields to flash. The "level" of the committed error log is same as the
10f2131442SPatrick Williams          level defined in error YAML definitions.
11f2131442SPatrick Williams      parameters:
12f2131442SPatrick Williams          - name: transactionId
13f2131442SPatrick Williams            type: uint64
14f2131442SPatrick Williams            description: >
15f2131442SPatrick Williams                The unique identifier of the journal entry(ies) to be committed.
16f2131442SPatrick Williams          - name: errMsg
17f2131442SPatrick Williams            type: string
18f2131442SPatrick Williams            description: >
19*26919f07SPatrick Williams                The error exception message associated with the error event log
20*26919f07SPatrick Williams                to be committed.
21f2131442SPatrick Williams      returns:
22f2131442SPatrick Williams          - name: entryID
23f2131442SPatrick Williams            type: uint32
24f2131442SPatrick Williams            description: >
25f2131442SPatrick Williams                The ID of the entry.
26f2131442SPatrick Williams    - name: CommitWithLvl
27f2131442SPatrick Williams      description: >
28f2131442SPatrick Williams          Write the requested error/event entry with its associated metadata
29f2131442SPatrick Williams          fields to flash. This interface allows the caller to override the
30f2131442SPatrick Williams          error level specified in the error YAML definition.
31f2131442SPatrick Williams      parameters:
32f2131442SPatrick Williams          - name: transactionId
33f2131442SPatrick Williams            type: uint64
34f2131442SPatrick Williams            description: >
35f2131442SPatrick Williams                The unique identifier of the journal entry(ies) to be committed.
36f2131442SPatrick Williams          - name: errMsg
37f2131442SPatrick Williams            type: string
38f2131442SPatrick Williams            description: >
39*26919f07SPatrick Williams                The error exception message associated with the error event log
40*26919f07SPatrick Williams                to be committed.
41f2131442SPatrick Williams          - name: errLvl
42f2131442SPatrick Williams            type: uint32
43f2131442SPatrick Williams            description: >
44f2131442SPatrick Williams                The error level/severity indicator.
45f2131442SPatrick Williams      returns:
46f2131442SPatrick Williams          - name: entryID
47f2131442SPatrick Williams            type: uint32
48f2131442SPatrick Williams            description: >
49f2131442SPatrick Williams                The ID of the entry.
50