debug_action.go

package main

import (
	//"bytes"
	"fmt"

	"github.com/go-kit/log"
	"github.com/go-kit/log/level"
)

// ***************************************************************************************
// ***************************************************************************************
// debug action
// ***************************************************************************************
// ***************************************************************************************

// ****************************

type DebugActionConfig struct {
	MsgVal string `yaml:"msg"`

	msg *Field

	// Catches all undefined fields and must be empty after parsing.
	XXX map[string]interface{} `yaml:",inline" json:"-"`
}

// UnmarshalYAML implements the yaml.Unmarshaler interface for DebugActionConfig.
func (dc *DebugActionConfig) UnmarshalYAML(unmarshal func(interface{}) error) error {
	type plain DebugActionConfig
	var err error
	if err := unmarshal((*plain)(dc)); err != nil {
		return err
	}
	// Check required fields
	dc.msg, err = NewField(dc.MsgVal, nil)
	if err != nil {
		return fmt.Errorf("invalid template for debug message %q: %s", dc.MsgVal, err)
	}

	return checkOverflow(dc.XXX, "debug action")
}

// ****************************
type DebugAction struct {
	Name    *Field              `yaml:"name,omitempty"`
	With    []any               `yaml:"with,omitempty"`
	When    []*exporterTemplate `yaml:"when,omitempty"`
	LoopVar string              `yaml:"loop_var,omitempty"`
	Vars    map[string]any      `yaml:"vars,omitempty"`
	Until   []*exporterTemplate `yaml:"until,omitempty"`

	Debug *DebugActionConfig `yaml:"debug"`
	vars  [][]any
}

func (a *DebugAction) Type() int {
	return debug_action
}

func (a *DebugAction) GetName(symtab map[string]any, logger log.Logger) string {
	str, err := a.Name.GetValueString(symtab, nil, false)
	if err != nil {
		level.Warn(logger).Log(
			"collid", CollectorId(symtab, logger),
			"script", ScriptName(symtab, logger),
			"msg", fmt.Sprintf("invalid action name: %v", err))
		return ""
	}
	return str
}

func (a *DebugAction) GetNameField() *Field {
	return a.Name
}
func (a *DebugAction) SetNameField(name *Field) {
	a.Name = name
}

func (a *DebugAction) GetWidh() []any {
	return a.With
}
func (a *DebugAction) SetWidth(with []any) {
	a.With = with
}

func (a *DebugAction) GetWhen() []*exporterTemplate {
	return a.When

}
func (a *DebugAction) SetWhen(when []*exporterTemplate) {
	a.When = when
}

func (a *DebugAction) GetLoopVar() string {
	return a.LoopVar
}
func (a *DebugAction) SetLoopVar(loopvar string) {
	a.LoopVar = loopvar
}

func (a *DebugAction) GetVars() [][]any {
	return a.vars
}
func (a *DebugAction) SetVars(vars [][]any) {
	a.vars = vars
}

func (a *DebugAction) GetUntil() []*exporterTemplate {
	return a.Until
}
func (a *DebugAction) SetUntil(until []*exporterTemplate) {
	a.Until = until
}

// func (a *DebugAction) GetBaseAction() *BaseAction {
// 	return nil
// }

func (a *DebugAction) setBasicElement(
	nameField *Field,
	vars [][]any,
	with []any,
	loopVar string,
	when []*exporterTemplate,
	until []*exporterTemplate) error {
	return setBasicElement(a, nameField, vars, with, loopVar, when, until)
}

func (a *DebugAction) PlayAction(script *YAMLScript, symtab map[string]any, logger log.Logger) error {
	return PlayBaseAction(script, symtab, logger, a, a.CustomAction)
}

// only for MetricsAction
func (a *DebugAction) GetMetrics() []*GetMetricsRes {
	return nil
}

// only for MetricAction
func (a *DebugAction) GetMetric() *MetricConfig {
	return nil
}
func (a *DebugAction) SetMetricFamily(*MetricFamily) {
}

// only for PlayAction
func (a *DebugAction) SetPlayAction(scripts map[string]*YAMLScript) error {
	return nil
}

// specific behavior for the DebugAction
func (a *DebugAction) CustomAction(script *YAMLScript, symtab map[string]any, logger log.Logger) error {
	level.Debug(logger).Log(
		"collid", CollectorId(symtab, logger),
		"script", ScriptName(symtab, logger),
		"name", a.GetName(symtab, logger),
		"msg", "[Type: DebugAction]")

	str, err := a.Debug.msg.GetValueString(symtab, nil, false)
	if err != nil {
		str = a.Debug.MsgVal
		level.Warn(logger).Log(
			"collid", CollectorId(symtab, logger),
			"script", ScriptName(symtab, logger),
			"name", a.GetName(symtab, logger),
			"msg", fmt.Sprintf("invalid template for debug message '%s': %v", str, err))
	}

	level.Debug(logger).Log(
		"collid", CollectorId(symtab, logger),
		"script", ScriptName(symtab, logger),
		"name", a.GetName(symtab, logger),
		"msg", fmt.Sprintf("    message: %s", str))

	return nil
}

func (a *DebugAction) AddCustomTemplate(customTemplate *exporterTemplate) error {

	if err := AddCustomTemplate(a, customTemplate); err != nil {
		return err
	}
	if a.Debug.msg != nil {
		if err := a.Debug.msg.AddDefaultTemplate(customTemplate); err != nil {
			return err
		}
	}

	return nil
}

// ***************************************************************************************