Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix: correct shelf metrics in 7mode #2245

Merged
merged 5 commits into from
Aug 4, 2023
Merged

fix: correct shelf metrics in 7mode #2245

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
5c7b2be
fix: correct shelf metrics in 7mode
Hardikl Jul 31, 2023
266e7e9
fix: handled review comments
Hardikl Aug 2, 2023
d58fab4
fix: handled review comment
Hardikl Aug 3, 2023
9c61d6a
fix: handled review comment
Hardikl Aug 3, 2023
e28693e
Merge remote-tracking branch 'origin/main' into hl_7mode_shelf
Hardikl Aug 4, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
136 changes: 122 additions & 14 deletions cmd/collectors/zapi/plugins/shelf/shelf.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,22 @@ const BatchSize = "500"

type Shelf struct {
*plugin.AbstractPlugin
data map[string]*matrix.Matrix
instanceKeys map[string]string
instanceLabels map[string]*dict.Dict
batchSize string
client *zapi.Client
query string
data map[string]*matrix.Matrix
shelfData *matrix.Matrix
instanceKeys map[string]string
instanceLabels map[string]*dict.Dict
shelfInstanceKeys []string
shelfInstanceLabels []shelfInstanceLabel
batchSize string
client *zapi.Client
query string
}

type shelfInstanceLabel struct {
label string
labelDisplay string
isChild bool
parent string
}

func New(p *plugin.AbstractPlugin) plugin.Plugin {
Expand Down Expand Up @@ -50,6 +60,27 @@ func (my *Shelf) Init() error {

my.Logger.Debug().Msg("plugin connected!")

my.shelfData = matrix.New(my.Parent+".Shelf", "shelf", "shelf")
my.shelfInstanceKeys = make([]string, 0)
my.shelfInstanceLabels = []shelfInstanceLabel{}
shelfExportOptions := node.NewS("export_options")
shelfInstanceKeys := shelfExportOptions.NewChildS("instance_keys", "")
shelfInstanceLabels := shelfExportOptions.NewChildS("instance_labels", "")

if counters := my.ParentParams.GetChildS("counters"); counters != nil {
if channelInfo := counters.GetChildS("shelf-environ-channel-info"); channelInfo != nil {
if shelfList := channelInfo.GetChildS("shelf-environ-shelf-list"); shelfList != nil {
if shelfInfo := shelfList.GetChildS("shelf-environ-shelf-info"); shelfInfo != nil {
my.parseShelfTemplate(shelfInfo, shelfInstanceKeys, shelfInstanceLabels, false, "")
}
}
}
}

shelfInstanceKeys.NewChildS("", "channel")
shelfInstanceKeys.NewChildS("", "shelf")
my.shelfData.SetExportOptions(shelfExportOptions)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it better to move all of this code in a seperate method? This may avoid lots of argument pass in parseShelfTemplate.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

moved couple of code line to other function. And reduce extra args, But we still need this parseTemplate as we do call it in recursion.


my.data = make(map[string]*matrix.Matrix)
my.instanceKeys = make(map[string]string)
my.instanceLabels = make(map[string]*dict.Dict)
Expand Down Expand Up @@ -154,20 +185,23 @@ func (my *Shelf) Run(dataMap map[string]*matrix.Matrix) ([]*matrix.Matrix, error
return nil, err
}

output, err = my.handle7Mode(result)
output, err = my.handle7Mode(data, result)

if err != nil {
return output, err
}

my.Logger.Debug().Msgf("Shelves instance count: %d", len(my.shelfData.GetInstances()))
Hardikl marked this conversation as resolved.
Show resolved Hide resolved
output = append(output, my.shelfData)
return output, nil
}

func (my *Shelf) handle7Mode(result []*node.Node) ([]*matrix.Matrix, error) {
func (my *Shelf) handle7Mode(data *matrix.Matrix, result []*node.Node) ([]*matrix.Matrix, error) {
var (
shelves []*node.Node
channels []*node.Node
output []*matrix.Matrix
shelves []*node.Node
channels []*node.Node
output []*matrix.Matrix
channelInstance *matrix.Instance
)

// Result would be the zapi response itself with only one record.
Expand All @@ -189,21 +223,70 @@ func (my *Shelf) handle7Mode(result []*node.Node) ([]*matrix.Matrix, error) {
data1.Reset()
}

// Purge and reset data
my.shelfData.PurgeInstances()
my.shelfData.Reset()

my.shelfData.SetGlobalLabels(data.GetGlobalLabels())
for _, instance := range data.GetInstances() {
instance.SetExportable(false)
}

for _, channel := range channels {
channelName := channel.GetChildContentS("channel-name")
shelves = channel.SearchChildren([]string{"shelf-environ-shelf-list", "shelf-environ-shelf-info"})
channelInstances := data.GetInstancesByPrefix(channelName)

if len(channelInstances) >= 1 {
channelInstance = channelInstances[0]
} else {
my.Logger.Debug().Msg("no channel found")
continue
}

if len(shelves) == 0 {
my.Logger.Debug().Str("channel", channelName).Msg("no shelves found")
continue
}

for _, shelf := range shelves {

uid := shelf.GetChildContentS("shelf-id")
shelfName := uid // no shelf name in 7mode
shelfID := uid

shelfInstanceKey := shelfID + "." + channelName
newShelfInstance, err := my.shelfData.NewInstance(shelfInstanceKey)
if err != nil {
my.Logger.Error().Msgf("Error while creating shelf instance: %v", err)
return nil, err
}

for _, key := range my.shelfInstanceKeys {
newShelfInstance.SetLabel(key, shelf.GetChildContentS(key))
}
for _, shelfLabelData := range my.shelfInstanceLabels {
if !shelfLabelData.isChild {
newShelfInstance.SetLabel(shelfLabelData.labelDisplay, shelf.GetChildContentS(shelfLabelData.label))
} else {
child := shelf.GetChildS(shelfLabelData.parent)
newShelfInstance.SetLabel(shelfLabelData.labelDisplay, child.GetChildContentS(shelfLabelData.label))
}
}

newShelfInstance.SetLabel("channel", channelInstance.GetLabel("channel"))
newShelfInstance.SetLabel("shelf", newShelfInstance.GetLabel("shelf_id"))

// populate numeric data
for metricKey, m := range my.shelfData.GetMetrics() {
if value := strings.Split(shelf.GetChildContentS(metricKey), " ")[0]; value != "" {
if err := m.SetValueString(newShelfInstance, value); err != nil {
my.Logger.Debug().Msgf("(%s) failed to parse value (%s): %v", metricKey, value, err)
} else {
my.Logger.Debug().Msgf("(%s) added value (%s)", metricKey, value)
}
}
}

for attribute, data1 := range my.data {
if statusMetric := data1.GetMetric("status"); statusMetric != nil {

Expand Down Expand Up @@ -252,7 +335,6 @@ func (my *Shelf) handle7Mode(result []*node.Node) ([]*matrix.Matrix, error) {

// populate numeric data
for metricKey, m := range data1.GetMetrics() {

if value := strings.Split(obj.GetChildContentS(metricKey), " ")[0]; value != "" {
if err := m.SetValueString(instance, value); err != nil {
my.Logger.Debug().Msgf("(%s) failed to parse value (%s): %v", metricKey, value, err)
Expand All @@ -261,7 +343,6 @@ func (my *Shelf) handle7Mode(result []*node.Node) ([]*matrix.Matrix, error) {
}
}
}

} else {
my.Logger.Debug().Msgf("instance without [%s], skipping", my.instanceKeys[attribute])
}
Expand All @@ -274,3 +355,30 @@ func (my *Shelf) handle7Mode(result []*node.Node) ([]*matrix.Matrix, error) {
}
return output, nil
}

func (my *Shelf) parseShelfTemplate(shelfInfo *node.Node, shelfInstanceKeys, shelfInstanceLabels *node.Node, isChild bool, parent string) {
for _, shelfProp := range shelfInfo.GetChildren() {
if len(shelfProp.GetChildren()) > 0 {
my.parseShelfTemplate(shelfInfo.GetChildS(shelfProp.GetNameS()), shelfInstanceKeys, shelfInstanceLabels, true, shelfProp.GetNameS())
} else {
metricName, display, kind, _ := util.ParseMetric(shelfProp.GetContentS())
switch kind {
case "key":
my.shelfInstanceKeys = append(my.shelfInstanceKeys, metricName)
my.shelfInstanceLabels = append(my.shelfInstanceLabels, shelfInstanceLabel{label: metricName, labelDisplay: display, isChild: isChild, parent: parent})
shelfInstanceKeys.NewChildS("", display)
my.Logger.Debug().Msgf("added instance key: [%s]", display)
Hardikl marked this conversation as resolved.
Show resolved Hide resolved
case "label":
my.shelfInstanceLabels = append(my.shelfInstanceLabels, shelfInstanceLabel{label: metricName, labelDisplay: display, isChild: isChild, parent: parent})
shelfInstanceLabels.NewChildS("", display)
my.Logger.Debug().Msgf("added instance label: [%s]", display)
Hardikl marked this conversation as resolved.
Show resolved Hide resolved
case "float":
_, err := my.shelfData.NewMetricFloat64(metricName, display)
if err != nil {
my.Logger.Error().Stack().Err(err).Msg("add metric")
Hardikl marked this conversation as resolved.
Show resolved Hide resolved
}
my.Logger.Debug().Msgf("added metric: [%s]", display)
Hardikl marked this conversation as resolved.
Show resolved Hide resolved
}
}
}
}
12 changes: 12 additions & 0 deletions pkg/matrix/matrix.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -225,6 +225,18 @@ func (m *Matrix) GetInstancesBySuffix(subKey string) []*Instance {
return instances
}

func (m *Matrix) GetInstancesByPrefix(subKey string) []*Instance {
var instances []*Instance
if subKey != "" {
for key, instance := range m.instances {
if strings.HasPrefix(key, subKey) {
instances = append(instances, instance)
}
}
}
return instances
}

func (m *Matrix) GetInstances() map[string]*Instance {
return m.instances
}
Expand Down
Loading