This repository has been archived by the owner on Nov 5, 2021. It is now read-only.
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Make target based additional labels easier to identify.
= Enclose target based labels within '@@', for example: @target.label.zone@. = Add support for adding a label based on target's name, using the keyword @target.name@. While here also standardize on how we export label through sysvars -- use "label_<labelname>" instead of "labels_<labelname>. PiperOrigin-RevId: 324673535
- Loading branch information
Showing
5 changed files
with
214 additions
and
125 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,110 @@ | ||
| // Copyright 2017-2020 Google Inc. | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package options | ||
|
|
||
| import ( | ||
| "regexp" | ||
| "strings" | ||
|
|
||
| configpb "github.com/google/cloudprober/probes/proto" | ||
| ) | ||
|
|
||
| // TargetLabelType for target based additional labels | ||
| type TargetLabelType int | ||
|
|
||
| // TargetLabelType enum values. | ||
| const ( | ||
| NotTargetLabel TargetLabelType = iota | ||
| TargetLabel | ||
| TargetName | ||
| ) | ||
|
|
||
| var targetLabelRegex = regexp.MustCompile(`@target.label.(.*)@`) | ||
|
|
||
| // AdditionalLabel encapsulates additional labels to attach to probe results. | ||
| type AdditionalLabel struct { | ||
| Key string | ||
|
|
||
| Value string // static value | ||
| TargetLabelKey string // from target | ||
| TargetLabelType TargetLabelType | ||
|
|
||
| // This map will allow for quick label lookup for a target. It will be | ||
| // updated by the probe while updating targets. | ||
| LabelForTarget map[string]string | ||
| } | ||
|
|
||
| // UpdateForTarget updates target-based label's value. | ||
| func (al *AdditionalLabel) UpdateForTarget(tname string, tLabels map[string]string) { | ||
| if al.TargetLabelType == NotTargetLabel { | ||
| return | ||
| } | ||
|
|
||
| if al.LabelForTarget == nil { | ||
| al.LabelForTarget = make(map[string]string) | ||
| } | ||
|
|
||
| switch al.TargetLabelType { | ||
| case TargetLabel: | ||
| al.LabelForTarget[tname] = tLabels[al.TargetLabelKey] | ||
| case TargetName: | ||
| al.LabelForTarget[tname] = tname | ||
| } | ||
| } | ||
|
|
||
| // KeyValueForTarget returns key, value pair for the given target. | ||
| func (al *AdditionalLabel) KeyValueForTarget(targetName string) (key, val string) { | ||
| if al.Value != "" { | ||
| return al.Key, al.Value | ||
| } | ||
| return al.Key, al.LabelForTarget[targetName] | ||
| } | ||
|
|
||
| func parseAdditionalLabels(p *configpb.ProbeDef) []*AdditionalLabel { | ||
| var aLabels []*AdditionalLabel | ||
|
|
||
| for _, pb := range p.GetAdditionalLabel() { | ||
| al := &AdditionalLabel{ | ||
| Key: pb.GetKey(), | ||
| } | ||
| aLabels = append(aLabels, al) | ||
|
|
||
| val := pb.GetValue() | ||
| if !strings.Contains(val, "@") { | ||
| al.Value = val | ||
| continue | ||
| } | ||
|
|
||
| if val == "@target.name@" { | ||
| al.TargetLabelType = TargetName | ||
| al.LabelForTarget = make(map[string]string) | ||
| continue | ||
| } | ||
|
|
||
| matches := targetLabelRegex.FindStringSubmatch(val) | ||
| if len(matches) == 2 { | ||
| al.TargetLabelType = TargetLabel | ||
| al.TargetLabelKey = matches[1] | ||
| al.LabelForTarget = make(map[string]string) | ||
| continue | ||
| } | ||
|
|
||
| // If a match is not found and target contains an "@" character, use it | ||
| // as it is. | ||
| al.Value = val | ||
| } | ||
|
|
||
| return aLabels | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,99 @@ | ||
| // Copyright 2017-2020 Google Inc. | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package options | ||
|
|
||
| import ( | ||
| "reflect" | ||
| "testing" | ||
|
|
||
| "github.com/golang/protobuf/proto" | ||
| configpb "github.com/google/cloudprober/probes/proto" | ||
| ) | ||
|
|
||
| var configWithAdditionalLabels = &configpb.ProbeDef{ | ||
| AdditionalLabel: []*configpb.AdditionalLabel{ | ||
| { | ||
| Key: proto.String("src_zone"), | ||
| Value: proto.String("zoneA"), | ||
| }, | ||
| { | ||
| Key: proto.String("dst_zone"), | ||
| Value: proto.String("@target.label.zone@"), | ||
| }, | ||
| { | ||
| Key: proto.String("dst_name"), | ||
| Value: proto.String("@target.name@"), | ||
| }, | ||
| }, | ||
| } | ||
|
|
||
| func TestParseAdditionalLabel(t *testing.T) { | ||
| expectedAdditionalLabels := []*AdditionalLabel{ | ||
| { | ||
| Key: "src_zone", | ||
| Value: "zoneA", | ||
| }, | ||
| { | ||
| Key: "dst_zone", | ||
| TargetLabelType: TargetLabel, | ||
| TargetLabelKey: "zone", | ||
| LabelForTarget: make(map[string]string), | ||
| }, | ||
| { | ||
| Key: "dst_name", | ||
| TargetLabelType: TargetName, | ||
| LabelForTarget: make(map[string]string), | ||
| }, | ||
| } | ||
|
|
||
| aLabels := parseAdditionalLabels(configWithAdditionalLabels) | ||
|
|
||
| // Verify that we got the correct additional lables and also update them while | ||
| // iterating over them. | ||
| for i, al := range aLabels { | ||
| if !reflect.DeepEqual(al, expectedAdditionalLabels[i]) { | ||
| t.Errorf("Additional labels not parsed correctly. Got=%v, Wanted=%v", al, expectedAdditionalLabels[i]) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| func TestUpdateAdditionalLabel(t *testing.T) { | ||
| aLabels := parseAdditionalLabels(configWithAdditionalLabels) | ||
|
|
||
| // Verify that we got the correct additional lables and also update them while | ||
| // iterating over them. | ||
| for _, al := range aLabels { | ||
| al.UpdateForTarget("target1", map[string]string{}) | ||
| al.UpdateForTarget("target2", map[string]string{"zone": "zoneB"}) | ||
| } | ||
|
|
||
| expectedLabels := map[string][][2]string{ | ||
| "target1": {{"src_zone", "zoneA"}, {"dst_zone", ""}, {"dst_name", "target1"}}, | ||
| "target2": {{"src_zone", "zoneA"}, {"dst_zone", "zoneB"}, {"dst_name", "target2"}}, | ||
| } | ||
|
|
||
| for target, labels := range expectedLabels { | ||
| var gotLabels [][2]string | ||
|
|
||
| for _, al := range aLabels { | ||
| k, v := al.KeyValueForTarget(target) | ||
| gotLabels = append(gotLabels, [2]string{k, v}) | ||
| } | ||
|
|
||
| if !reflect.DeepEqual(gotLabels, labels) { | ||
| t.Errorf("Didn't get expected labels for the target: %s. Got=%v, Expected=%v", target, gotLabels, labels) | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters