summaryrefslogtreecommitdiffstats
path: root/xyz/openbmc_project/Logging/Internal/Manager.interface.yaml
blob: 4c1c8cede221efc09b97c3041c3fe3ec2f962f07 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
description: >
    Implement to provide event/error logging management features.
    This interface should be instantiated for the phosphor::logging namespace,
    and only one is required.
methods:
    - name: Commit
      description: >
          Write the requested error/event entry with its associated metadata
          fields to flash. The "level" of the committed error log is same as the
          level defined in error YAML definitions.
      parameters:
        - name: transactionId
          type: uint64
          description: >
              The unique identifier of the journal entry(ies) to be committed.
        - name: errMsg
          type: string
          description: >
              The error exception message associated with the error
              event log to be committed.
    - name: CommitWithLvl
      description: >
          Write the requested error/event entry with its associated metadata
          fields to flash. This interface allows the caller to override the
          error level specified in the error YAML definition.
      parameters:
        - name: transactionId
          type: uint64
          description: >
              The unique identifier of the journal entry(ies) to be committed.
        - name: errMsg
          type: string
          description: >
              The error exception message associated with the error
              event log to be committed.
        - name: errLvl
          type: uint32
          description: >
              The error level/severity indicator.
OpenPOWER on IntegriCloud