docs:monitor: Fill in nonfunc_rotor_error_delay details
The `nonfunc_rotor_error_delay` attribute contains the amount of time(in
seconds) to delay logging an error against the fan when any of its
sensors are deemed nonfunctional. When this attribute is not given, and
the `fault_handling` configuration section does not exist, the default
is to not log an error for any nonfunctional fan sensors. If the
`fault_handling` section exists but this attribute is not given, then it
defaults to immediately log an error for any nonfunctional fan sensors.
Signed-off-by: Matthew Barth <msbarth@us.ibm.com>
Change-Id: Ia39f4ad0b987b2752d2b7820aab5025c1181ab7d
diff --git a/docs/monitor/nonfunc_rotor_error_delay.md b/docs/monitor/nonfunc_rotor_error_delay.md
index a9c13ef..420cd27 100644
--- a/docs/monitor/nonfunc_rotor_error_delay.md
+++ b/docs/monitor/nonfunc_rotor_error_delay.md
@@ -1,9 +1,43 @@
# nonfunc_rotor_error_delay
## Description
+The amount of time(in seconds) to delay logging an error against the fan when
+any of its sensors are deemed nonfunctional. This attribute is optional and
+defaults to **no error** being logged when the attribute is not given and a
+sensor is nonfunctional.
+**Note: The default of this changes to 0(immediately log an error) if the
+`fault_handling` section of the configuration is given.**
## Attribute Value(s)
-
+integer (default = do not create an error log)
## Example
+<pre><code>
+{
+ "fans": [
+ {
+ "inventory": "/system/chassis/motherboard/fan0",
+ "allowed_out_of_range_time": 30,
+ "functional_delay": 5,
+ "deviation": 15,
+ "num_sensors_nonfunc_for_fan_nonfunc": 1,
+ "monitor_start_delay": 30,
+ "fan_missing_error_delay": 20,
+ <b><i>"nonfunc_rotor_error_delay": 0</i></b>,
+ "sensors": [
+ {
+ "name": "fan0_0",
+ "has_target": true
+ },
+ {
+ "name": "fan0_1",
+ "has_target": false,
+ "factor": 1.45,
+ "offset": -909
+ }
+ ]
+ }
+ ]
+}
+</code></pre>