Files
mgmt/lang/core/sys/load_fact.go
2024-03-05 01:05:50 -05:00

126 lines
4.0 KiB
Go

// Mgmt
// Copyright (C) 2013-2024+ James Shubin and the project contributors
// Written by James Shubin <james@shubin.ca> and the project contributors
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program. If not, see <https://www.gnu.org/licenses/>.
//
// Additional permission under GNU GPL version 3 section 7
//
// If you modify this program, or any covered work, by linking or combining it
// with embedded mcl code and modules (and that the embedded mcl code and
// modules which link with this program, contain a copy of their source code in
// the authoritative form) containing parts covered by the terms of any other
// license, the licensors of this program grant you additional permission to
// convey the resulting work. Furthermore, the licensors of this program grant
// the original author, James Shubin, additional permission to update this
// additional permission if he deems it necessary to achieve the goals of this
// additional permission.
package coresys
import (
"context"
"time"
"github.com/purpleidea/mgmt/lang/funcs/facts"
"github.com/purpleidea/mgmt/lang/types"
"github.com/purpleidea/mgmt/util/errwrap"
)
const (
// LoadFuncName is the name this fact is registered as. It's still a
// Func Name because this is the name space the fact is actually using.
LoadFuncName = "load"
loadSignature = "struct{x1 float; x5 float; x15 float}"
)
func init() {
facts.ModuleRegister(ModuleName, LoadFuncName, func() facts.Fact { return &LoadFact{} }) // must register the fact and name
}
// LoadFact is a fact which returns the current system load.
type LoadFact struct {
init *facts.Init
}
// String returns a simple name for this fact. This is needed so this struct can
// satisfy the pgraph.Vertex interface.
func (obj *LoadFact) String() string {
return LoadFuncName
}
// Validate makes sure we've built our struct properly. It is usually unused for
// normal facts that users can use directly.
//func (obj *LoadFact) Validate() error {
// return nil
//}
// Info returns some static info about itself.
func (obj *LoadFact) Info() *facts.Info {
return &facts.Info{
Output: types.NewType(loadSignature),
}
}
// Init runs some startup code for this fact.
func (obj *LoadFact) Init(init *facts.Init) error {
obj.init = init
return nil
}
// Stream returns the changing values that this fact has over time.
func (obj *LoadFact) Stream(ctx context.Context) error {
defer close(obj.init.Output) // always signal when we're done
// it seems the different values only update once every 5
// seconds, so that's as often as we need to refresh this!
// TODO: lookup this value if it's something configurable
ticker := time.NewTicker(time.Duration(5) * time.Second)
// streams must generate an initial event on startup
startChan := make(chan struct{}) // start signal
close(startChan) // kick it off!
defer ticker.Stop()
for {
select {
case <-startChan: // kick the loop once at start
startChan = nil // disable
case <-ticker.C: // received the timer event
// pass
case <-ctx.Done():
return nil
}
x1, x5, x15, err := load()
if err != nil {
return errwrap.Wrapf(err, "could not read load values")
}
st := types.NewStruct(types.NewType(loadSignature))
for k, v := range map[string]float64{"x1": x1, "x5": x5, "x15": x15} {
if err := st.Set(k, &types.FloatValue{V: v}); err != nil {
return errwrap.Wrapf(err, "struct could not set key: `%s`", k)
}
}
select {
case obj.init.Output <- st:
// send
case <-ctx.Done():
return nil
}
}
}