README
¶
golarm
Fire alarms with system events
Usage
golarm.AddAlarm(golarm.SystemLoad(golarm.OneMinPeriod).Above(0.8).Run(func() {
fmt.Println("System load >0.8 !!")
smtp.SendMail(smtpHost, emailConf.Port, "System load >0.8 !!")
}))
Options
- SystemLoad
// checks if the system load is lower or equal to 0.5
golarm.AddAlarm(golarm.SystemLoad(golarm.OneMinPeriod).AboveEqual(0.5).Run(func() {
fmt.Println("System load >=0.5 !!")
}))
- SystemUptime
// checks if the system has been running for less than 1 minute
golarm.AddAlarm(golarm.SystemUptime().Below(1).Run(func() {
fmt.Println("System just started !!")
}))
- SystemMemory / SystemSwap [Free, Used]
// checks if used memory is higher that 90%
golarm.AddAlarm(golarm.SystemMemory().Used().Above(90).Percent().Run(func() {
fmt.Println("Used system memory > 90% !!")
}))
// checks if free memory is lower that 500MB
golarm.AddAlarm(golarm.SystemMemory().Free().BelowEqual(500).Run(func() {
fmt.Println("Free memory <= 500MB !!")
}))
- SystemProc [Status, RunningTime, Used (Memory)]
// checks if the process 72332 has changed to zombie status
golarm.AddAlarm(golarm.SystemProc(72332).Status(golarm.Zombie).Run(func() {
fmt.Println("Our process with PID 72332 became Zombie !!")
}))
// checks if the process 72332 has been running for more than 20 minutes
golarm.AddAlarm(golarm.SystemProc(72332).RunningTime().Above(20).Run(func() {
fmt.Println("Our process with PID 72332 exceeded 20 minutes running !!")
}))
TODO
- Kilobytes / Megabytes / Gigabytes
(currently megabytes by default) - Minutes / Hours / Days
(currently minutes by default)
License
Distributed under MIT license. See LICENSE for more information.
Documentation
¶
Index ¶
- Constants
- Variables
- func AddAlarm(a *Alarm) error
- type Alarm
- func (j *Alarm) Above(v float64) *Alarm
- func (j *Alarm) AboveEqual(v float64) *Alarm
- func (j *Alarm) Below(v float64) *Alarm
- func (j *Alarm) BelowEqual(v float64) *Alarm
- func (j *Alarm) Equal(v float64) *Alarm
- func (j *Alarm) Free() *Alarm
- func (j *Alarm) Percent() *Alarm
- func (j *Alarm) Run(f func()) *Alarm
- func (j *Alarm) RunningTime() *Alarm
- func (j *Alarm) SetMetricsManager(m sigarMetrics)
- func (j *Alarm) Status(s state) *Alarm
- func (j *Alarm) Used() *Alarm
Constants ¶
const ( Sleeping state = iota + 1 Running Stopped Zombie Idle Unknown )
Linux process states to be used with status alarms
const ( OneMinPeriod period = iota + 1 FiveMinPeriod FifteenMinPeriod )
Load average can be calculated for the last one minute, five minutes and fifteen minutes respectively. Load average is an indication of whether the system resources (mainly the CPU) are adequately available for the processes (system load) that are running, runnable or in uninterruptible sleep states during the previous n minutes.
Variables ¶
var ( ErrAlarmTypeNotDefined = errors.New("Bad chain. Alarm type not defined") ErrComparisonNotDefined = errors.New("Bad chain. Alarm comparison not defined") ErrExpectedNumWhenPercentage = errors.New("Bad chain. A number is needed for applying a percentage") ErrIncorrectTypeForFree = errors.New("Alarm type not set or trying to use Free with something different than memory or swap memory") ErrIncorrectTypeForUsed = errors.New("Alarm type not set or trying to use Free with something different than memory, swap memory or memory used by a proc") ErrIncorrectTypeForTime = errors.New("Alarm type not set or trying to use RunningTime with something different than uptime or uptime by a proc") ErrIncorrectTypeForStatus = errors.New("Alarm type not set or trying to use Status with something different than SysteProcAlarm") ErrMultipleComparisonDefined = errors.New("Alarm comparison already defined") ErrIncorrectTypeForAbove = errors.New("Alarm type not set or trying to use Above with a status metric") ErrIncorrectTypeForBelow = errors.New("Alarm type not set or trying to use Below with a status metric") ErrIncorrectTypeForPercentage = errors.New("Couldn't apply percentage to uptime/status Alarms") ErrIncorrectValuesWithPercentage = errors.New("Couldn't apply percentage") ErrInexistentPid = errors.New("Pid does not exist") ErrIncorrectTypeForComparison = errors.New("Alarm type not set or trying to use an incorrect comparison with this type of Alarm") ErrIncorrectTypeForMetric = errors.New("Alarm type not set or trying to use an incorrect metric with this type of Alarm") )
Error codes returned by failures when trying to create the alert chain
var Alarms = make([]*Alarm, 0)
alarms pool
var Duration = 5
check interval set to 5 seconds as default
Functions ¶
Types ¶
type Alarm ¶
type Alarm struct {
Err error
// contains filtered or unexported fields
}
Alarm defines a running alarm
func SystemLoad ¶
func SystemLoad(p period) *Alarm
SystemLoad creates an alarm based on load metric P is the period needed for calculating the load, and it could be OneMinPeriod, FiveMinPeriod or FifteenMinPeriod
func SystemMemory ¶
func SystemMemory() *Alarm
SystemMemory creates an alarm based on memory metrics
func SystemProc ¶
SystemProc creates an alarm based on a process specified by PID
func (*Alarm) AboveEqual ¶
AboveEqual compares if the specified alarm is greater or equal than the number set
func (*Alarm) BelowEqual ¶
BelowEqual compares if the specified alarm is lower or equal than the number set
func (*Alarm) Free ¶
Free allows to specify that the created alarm will use the free memory as main metric
func (*Alarm) Run ¶
Run allows a func to be specified. This callback will be executed when the alarm is fired
func (*Alarm) RunningTime ¶
RunningTime gets the time a process has been running
func (*Alarm) SetMetricsManager ¶
func (j *Alarm) SetMetricsManager(m sigarMetrics)
SetMetricsManager allows to set a specific sigar manager
Source Files
Directories