README.md
changeset 20 00a38d493f2c
parent 17 e4f0fd44734d
child 25 6217282f6070
equal deleted inserted replaced
19:77084121952b 20:00a38d493f2c
    21 
    21 
    22  - Disk space capacity
    22  - Disk space capacity
    23  - System CPU utilization
    23  - System CPU utilization
    24  - Memory and swap usage
    24  - Memory and swap usage
    25  - Running process checks
    25  - Running process checks
       
    26  - UPS battery checks
    26 
    27 
    27 It tries to provide sane defaults, while allowing fine grained settings
    28 It tries to provide sane defaults, while allowing fine grained settings
    28 per resource node.  Both Windows and UCD-SNMP systems are supported.
    29 per resource node.  Both Windows and UCD-SNMP systems are supported.
    29 
    30 
    30 
    31 
    73     processes:
    74     processes:
    74       check: []
    75       check: []
    75     memory:
    76     memory:
    76       physical_warn_at: 
    77       physical_warn_at: 
    77       swap_warn_at: 60
    78       swap_warn_at: 60
       
    79     ups:
       
    80       battery:
       
    81         capacity_warn_at: 60
       
    82         temperature_warn_at: 50
    78 ```
    83 ```
    79 
    84 
    80 The `warn_at` keys imply usage capacity as a percentage. ie:  "Warn me
    85 The `warn_at` keys imply usage capacity as a percentage. ie:  "Warn me
    81 when a disk mount point is at 90 percent utilization."
    86 when a disk mount point is at 90 percent utilization."
    82 
    87 
   141 resource is set to a `down` state.
   146 resource is set to a `down` state.
   142 
   147 
   143 A single property is set on the node, a "counts" key that contains the
   148 A single property is set on the node, a "counts" key that contains the
   144 current number of running processes.
   149 current number of running processes.
   145 
   150 
       
   151 
       
   152 #### UPS
       
   153 
       
   154 ##### Battery
       
   155 
       
   156   * **capacity_warn_at**: Set the node to a `warning` state when the battery capacity is at or below this percentage.
       
   157   * **temperature_warn_at**: Set the node to a `warning` state when the battery temperature is at or above this
       
   158                              temperature (in Celcius).
       
   159 
       
   160 This check warns when the UPS is on battery, and reports the UPS' own
       
   161 estimated time remaining.
       
   162 
       
   163 A warning state will also be triggered based on battery status - low,
       
   164 depleted, or unknown.
   146 
   165 
   147 Examples
   166 Examples
   148 --------
   167 --------
   149 
   168 
   150 In the simplest form, using default behaviors and settings, here's an
   169 In the simplest form, using default behaviors and settings, here's an
   252 ```
   271 ```
   253 
   272 
   254 
   273 
   255 ## License
   274 ## License
   256 
   275 
   257 Copyright (c) 2016-2018 Michael Granger and Mahlon E. Smith
   276 Copyright (c) 2016-2019 Michael Granger and Mahlon E. Smith
   258 All rights reserved.
   277 All rights reserved.
   259 
   278 
   260 Redistribution and use in source and binary forms, with or without
   279 Redistribution and use in source and binary forms, with or without
   261 modification, are permitted provided that the following conditions are met:
   280 modification, are permitted provided that the following conditions are met:
   262 
   281