xref: /openbmc/phosphor-dbus-interfaces/yaml/xyz/openbmc_project/Metric/Value.interface.yaml (revision 921791c73008a3edfc6507afb5bc15e48963d295)
1800f7080SPatrick Williamsdescription: >
2800f7080SPatrick Williams    This interface provides the Board Manager Metric values for resource
3800f7080SPatrick Williams    utilization.
4800f7080SPatrick Williams
5800f7080SPatrick Williamsproperties:
6800f7080SPatrick Williams    - name: Value
7800f7080SPatrick Williams      type: double
8800f7080SPatrick Williams      description: >
9800f7080SPatrick Williams          The current metric value.
10800f7080SPatrick Williams      flags:
11800f7080SPatrick Williams          - readonly
12800f7080SPatrick Williams    - name: MaxValue
13800f7080SPatrick Williams      type: double
14800f7080SPatrick Williams      default: infinity
15800f7080SPatrick Williams      flags:
16800f7080SPatrick Williams          - readonly
17800f7080SPatrick Williams      description: >
18800f7080SPatrick Williams          The maximum supported metric value.
19800f7080SPatrick Williams    - name: MinValue
20800f7080SPatrick Williams      type: double
21800f7080SPatrick Williams      default: -infinity
22800f7080SPatrick Williams      flags:
23800f7080SPatrick Williams          - readonly
24800f7080SPatrick Williams      description: >
25800f7080SPatrick Williams          The minimum supported metric value.
26800f7080SPatrick Williams    - name: Unit
27800f7080SPatrick Williams      type: enum[self.Unit]
28800f7080SPatrick Williams      description: >
29800f7080SPatrick Williams          The unit for metric value. For example, memory in bytes, CPU in
30800f7080SPatrick Williams          percent, reboots in count.
31800f7080SPatrick Williams      flags:
32800f7080SPatrick Williams          - const
33800f7080SPatrick Williams
34800f7080SPatrick Williamsenumerations:
35800f7080SPatrick Williams    - name: Unit
36800f7080SPatrick Williams      description: >
37800f7080SPatrick Williams          Metric value unit.
38800f7080SPatrick Williams      values:
39800f7080SPatrick Williams          - name: Bytes
40800f7080SPatrick Williams            description: >
41800f7080SPatrick Williams                Unit to indicate bytes.
42800f7080SPatrick Williams          - name: Count
43800f7080SPatrick Williams            description: >
44800f7080SPatrick Williams                Unit to indicate counts.
45800f7080SPatrick Williams          - name: Percent
46800f7080SPatrick Williams            description: >
47800f7080SPatrick Williams                Unit to indicate percentage.
48800f7080SPatrick Williams
49800f7080SPatrick Williamsassociations:
50800f7080SPatrick Williams    - name: measuring
51800f7080SPatrick Williams      description: >
52800f7080SPatrick Williams          Metrics measure the inventory item's resource utilization, therefore
53800f7080SPatrick Williams          implement an association to the inventory item.
54800f7080SPatrick Williams      reverse_names:
55800f7080SPatrick Williams          - measured_by
56800f7080SPatrick Williams      required_endpoint_interfaces:
57800f7080SPatrick Williams          - xyz.openbmc_project.Inventory.Item
58800f7080SPatrick Williams
59800f7080SPatrick Williamspaths:
60800f7080SPatrick Williams    - namespace: /xyz/openbmc_project/metric
61800f7080SPatrick Williams      description: >
62800f7080SPatrick Williams          The root path for all Metrics.
63800f7080SPatrick Williams      segments:
64800f7080SPatrick Williams          - name: TotalMemory
65800f7080SPatrick Williams            description: >
66800f7080SPatrick Williams                The total memory metric.
67800f7080SPatrick Williams            value: memory/total
68800f7080SPatrick Williams          - name: FreeMemory
69800f7080SPatrick Williams            description: >
70800f7080SPatrick Williams                The free memory metric.
71800f7080SPatrick Williams            value: memory/free
72800f7080SPatrick Williams          - name: AvailableMemory
73800f7080SPatrick Williams            description: >
74800f7080SPatrick Williams                The available memory metric.
75800f7080SPatrick Williams            value: memory/available
76800f7080SPatrick Williams          - name: SharedMemory
77800f7080SPatrick Williams            description: >
78800f7080SPatrick Williams                The shared memory utilization.
79800f7080SPatrick Williams            value: memory/shared
80800f7080SPatrick Williams          - name: BufferedAndCachedMemory
81800f7080SPatrick Williams            description: >
82800f7080SPatrick Williams                The buffered and cached memory memory utilization.
83800f7080SPatrick Williams            value: memory/buffered_and_cached
84800f7080SPatrick Williams          - name: KernelCPU
85800f7080SPatrick Williams            description: >
86800f7080SPatrick Williams                The kernel CPU utilization.
87800f7080SPatrick Williams            value: cpu/kernel
88800f7080SPatrick Williams          - name: UserCPU
89800f7080SPatrick Williams            description: >
90800f7080SPatrick Williams                The user CPU utilization.
91800f7080SPatrick Williams            value: cpu/user
92cc4ce70dSJagpal Singh Gill          - name: TotalCPU
93cc4ce70dSJagpal Singh Gill            description: >
94cc4ce70dSJagpal Singh Gill                The total CPU utilization.
95cc4ce70dSJagpal Singh Gill            value: cpu/total
96abec9d54SJagpal Singh Gill          - name: Storage
97abec9d54SJagpal Singh Gill            description: >
98abec9d54SJagpal Singh Gill                The different types of available storage, such as tmp, var etc.
99abec9d54SJagpal Singh Gill                Each storage type will have path relative to storage/, for
100abec9d54SJagpal Singh Gill                example storage/tmp for temporary storage.
101abec9d54SJagpal Singh Gill            value: storage
102157c864eSJagpal Singh Gill          - name: ReadWriteStorage
103157c864eSJagpal Singh Gill            description: >
104abec9d54SJagpal Singh Gill                The available read write storage. This storage path has been
105*921791c7SManojkiran Eda                explicitly added to the interface file as it gets used in BMCWeb
106abec9d54SJagpal Singh Gill                and free storage metric gets exposed via Redfish.
107157c864eSJagpal Singh Gill            value: storage/rw
108800f7080SPatrick Williams          - name: RebootCount
109800f7080SPatrick Williams            description: >
110800f7080SPatrick Williams                Reboot statistic to track number of times device rebooted
111800f7080SPatrick Williams                without failure.
112800f7080SPatrick Williams            value: reboot/count
113800f7080SPatrick Williams          - name: RebootCountWithFailure
114800f7080SPatrick Williams            description: >
115800f7080SPatrick Williams                Reboot statistic to track number of times device rebooted
116800f7080SPatrick Williams                because of a failure.
117800f7080SPatrick Williams            value: reboot/count_with_failure
118c2636e89SJagpal Singh Gill    - name: BMC
119c2636e89SJagpal Singh Gill      description: >
120c2636e89SJagpal Singh Gill          The BMC metrics.
121c2636e89SJagpal Singh Gill      value: /xyz/openbmc_project/metric/bmc
122