-
Notifications
You must be signed in to change notification settings - Fork 676
Add ExcludeInterfaceRegexp to Net Dev monitor #675
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.
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
Merged
k8s-ci-robot
merged 1 commit into
kubernetes:master
from
mmiranda96:feat/net-monitor-groupings
Jun 29, 2022
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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 hidden or 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,190 @@ | ||
package systemstatsmonitor | ||
|
||
import ( | ||
"io/ioutil" | ||
"os" | ||
"path" | ||
"regexp" | ||
"testing" | ||
|
||
ssmtypes "k8s.io/node-problem-detector/pkg/systemstatsmonitor/types" | ||
"k8s.io/node-problem-detector/pkg/util/metrics" | ||
) | ||
|
||
var defaultMetricsConfig = map[string]ssmtypes.MetricConfig{ | ||
string(metrics.NetDevRxBytes): ssmtypes.MetricConfig{DisplayName: string(metrics.NetDevRxBytes)}, | ||
string(metrics.NetDevRxPackets): ssmtypes.MetricConfig{DisplayName: string(metrics.NetDevRxPackets)}, | ||
string(metrics.NetDevRxErrors): ssmtypes.MetricConfig{DisplayName: string(metrics.NetDevRxErrors)}, | ||
string(metrics.NetDevRxDropped): ssmtypes.MetricConfig{DisplayName: string(metrics.NetDevRxDropped)}, | ||
string(metrics.NetDevRxFifo): ssmtypes.MetricConfig{DisplayName: string(metrics.NetDevRxFifo)}, | ||
string(metrics.NetDevRxFrame): ssmtypes.MetricConfig{DisplayName: string(metrics.NetDevRxFrame)}, | ||
string(metrics.NetDevRxCompressed): ssmtypes.MetricConfig{DisplayName: string(metrics.NetDevRxCompressed)}, | ||
string(metrics.NetDevRxMulticast): ssmtypes.MetricConfig{DisplayName: string(metrics.NetDevRxMulticast)}, | ||
string(metrics.NetDevTxBytes): ssmtypes.MetricConfig{DisplayName: string(metrics.NetDevTxBytes)}, | ||
string(metrics.NetDevTxPackets): ssmtypes.MetricConfig{DisplayName: string(metrics.NetDevTxPackets)}, | ||
string(metrics.NetDevTxErrors): ssmtypes.MetricConfig{DisplayName: string(metrics.NetDevTxErrors)}, | ||
string(metrics.NetDevTxDropped): ssmtypes.MetricConfig{DisplayName: string(metrics.NetDevTxDropped)}, | ||
string(metrics.NetDevTxFifo): ssmtypes.MetricConfig{DisplayName: string(metrics.NetDevTxFifo)}, | ||
string(metrics.NetDevTxCollisions): ssmtypes.MetricConfig{DisplayName: string(metrics.NetDevTxCollisions)}, | ||
string(metrics.NetDevTxCarrier): ssmtypes.MetricConfig{DisplayName: string(metrics.NetDevTxCarrier)}, | ||
string(metrics.NetDevTxCompressed): ssmtypes.MetricConfig{DisplayName: string(metrics.NetDevTxCompressed)}, | ||
} | ||
|
||
// To get a similar output, run `cat /proc/net/dev` on a Linux machine | ||
// docker: 1500 100 8 7 0 0 0 0 9000 450 565 200 20 30 0 0 | ||
const fakeNetProcContent = `Inter-| Receive | Transmit | ||
face |bytes packets errs drop fifo frame compressed multicast|bytes packets errs drop fifo colls carrier compressed | ||
eth0: 5000 100 0 0 0 0 0 0 2500 30 0 0 0 0 0 0 | ||
docker0: 1000 90 8 7 0 0 0 0 0 0 0 0 0 0 0 0 | ||
docker1: 500 10 0 0 0 0 0 0 3000 150 15 0 20 30 0 0 | ||
docker2: 0 0 0 0 0 0 0 0 6000 300 550 200 0 0 0 0 | ||
` | ||
|
||
// newFakeInt64Metric is a wrapper around metrics.NewFakeInt64Metric | ||
func newFakeInt64Metric(metricID metrics.MetricID, viewName string, description string, unit string, aggregation metrics.Aggregation, tagNames []string) (metrics.Int64MetricInterface, error) { | ||
return metrics.NewFakeInt64Metric(viewName, aggregation, tagNames), nil | ||
} | ||
|
||
// testCollectAux is a test auxiliary function used for testing netCollector.Collect | ||
func testCollectAux(t *testing.T, name string, excludeInterfaceRegexp ssmtypes.NetStatsInterfaceRegexp, validate func(*testing.T, *netCollector)) { | ||
// mkdir /tmp/proc-X | ||
procDir, err := ioutil.TempDir(os.TempDir(), "proc-") | ||
if err != nil { | ||
t.Fatalf("Failed to create temp proc directory: %v", err) | ||
} | ||
// rm -r /tmp/proc-X | ||
defer os.RemoveAll(procDir) | ||
// mkdir -C /tmp/proc-X/net | ||
procNetDir := path.Join(procDir, "net") | ||
if err := os.Mkdir(procNetDir, 0777); err != nil { | ||
t.Fatalf("Failed to create directory %q: %v", procNetDir, err) | ||
} | ||
|
||
// touch /tmp/proc-X/net/dev | ||
filename := path.Join(procNetDir, "dev") | ||
f, err := os.Create(filename) | ||
if err != nil { | ||
t.Fatalf("Failed to create file %q: %v", filename, err) | ||
} | ||
// echo $FILE_CONTENT > /tmp/proc-X/net/dev | ||
if _, err = f.WriteString(fakeNetProcContent); err != nil { | ||
t.Fatalf("Failed to write to file %q: %v", filename, err) | ||
} | ||
if err = f.Close(); err != nil { | ||
t.Fatalf("Failed to close file %q: %v", filename, err) | ||
} | ||
|
||
// Build the netCollector | ||
config := &ssmtypes.NetStatsConfig{ | ||
ExcludeInterfaceRegexp: excludeInterfaceRegexp, | ||
MetricsConfigs: defaultMetricsConfig, | ||
} | ||
netCollector := &netCollector{ | ||
config: config, | ||
procPath: procDir, | ||
recorder: newIfaceStatRecorder(newFakeInt64Metric), | ||
} | ||
netCollector.initOrDie() | ||
netCollector.collect() | ||
validate(t, netCollector) | ||
} | ||
|
||
func TestCollect(t *testing.T) { | ||
tcs := []struct { | ||
Name string | ||
ExcludeInterfaceRegexp ssmtypes.NetStatsInterfaceRegexp | ||
Validate func(t *testing.T, nc *netCollector) | ||
}{ | ||
{ | ||
Name: "NoFilterMatch", | ||
ExcludeInterfaceRegexp: ssmtypes.NetStatsInterfaceRegexp{R: regexp.MustCompile(`^fake$`)}, | ||
Validate: func(t *testing.T, nc *netCollector) { | ||
// We just validate two metrics, no need to check all of them | ||
expectedValues := map[metrics.MetricID]map[string]int64{ | ||
metrics.NetDevRxBytes: map[string]int64{ | ||
"eth0": 5000, | ||
"docker0": 1000, | ||
"docker1": 500, | ||
"docker2": 0, | ||
}, | ||
metrics.NetDevTxBytes: map[string]int64{ | ||
"eth0": 2500, | ||
"docker0": 0, | ||
"docker1": 3000, | ||
"docker2": 6000, | ||
}, | ||
} | ||
for metricID, interfaceValues := range expectedValues { | ||
collector, ok := nc.recorder.collectors[metricID] | ||
if !ok { | ||
t.Errorf("Failed to get collector of metric %s", metricID) | ||
continue | ||
} | ||
fakeInt64Metric, ok := collector.metric.(*metrics.FakeInt64Metric) | ||
if !ok { | ||
t.Fatalf("Failed to convert metric %s to fakeMetric", string(metricID)) | ||
} | ||
for _, repr := range fakeInt64Metric.ListMetrics() { | ||
interfaceName, ok := repr.Labels[interfaceNameLabel] | ||
if !ok { | ||
t.Fatalf("Failed to get label %q for ", interfaceNameLabel) | ||
} | ||
expectedValue, ok := interfaceValues[interfaceName] | ||
if !ok { | ||
t.Fatalf("Failed to get metric value for interface %q", interfaceName) | ||
} | ||
if repr.Value != expectedValue { | ||
t.Errorf("Mismatch in metric %q for interface %q: expected %d, got %d", metricID, interfaceName, expectedValue, repr.Value) | ||
} | ||
} | ||
} | ||
}, | ||
}, | ||
{ | ||
Name: "FilterMatch", | ||
ExcludeInterfaceRegexp: ssmtypes.NetStatsInterfaceRegexp{R: regexp.MustCompile(`docker\d+`)}, | ||
Validate: func(t *testing.T, nc *netCollector) { | ||
// We just validate two metrics, no need to check all of them | ||
expectedValues := map[metrics.MetricID]map[string]int64{ | ||
metrics.NetDevRxBytes: map[string]int64{ | ||
"eth0": 5000, | ||
}, | ||
metrics.NetDevTxBytes: map[string]int64{ | ||
"eth0": 2500, | ||
}, | ||
} | ||
for metricID, interfaceValues := range expectedValues { | ||
collector, ok := nc.recorder.collectors[metricID] | ||
if !ok { | ||
t.Errorf("Failed to get collector of metric %s", metricID) | ||
continue | ||
} | ||
fakeInt64Metric, ok := collector.metric.(*metrics.FakeInt64Metric) | ||
if !ok { | ||
t.Fatalf("Failed to convert metric %s to fakeMetric", string(metricID)) | ||
} | ||
for _, repr := range fakeInt64Metric.ListMetrics() { | ||
interfaceName, ok := repr.Labels[interfaceNameLabel] | ||
if !ok { | ||
t.Fatalf("Failed to get label %q for ", interfaceNameLabel) | ||
} | ||
expectedValue, ok := interfaceValues[interfaceName] | ||
if !ok { | ||
t.Fatalf("Failed to get metric value for interface %q", interfaceName) | ||
} | ||
if repr.Value != expectedValue { | ||
t.Errorf("Mismatch in metric %q for interface %q: expected %d, got %d", metricID, interfaceName, expectedValue, repr.Value) | ||
} | ||
} | ||
} | ||
}, | ||
}, | ||
} | ||
for _, tc := range tcs { | ||
tc := tc | ||
t.Run(tc.Name, func(t *testing.T) { | ||
t.Parallel() | ||
testCollectAux(t, tc.Name, tc.ExcludeInterfaceRegexp, tc.Validate) | ||
}) | ||
} | ||
} |
This file contains hidden or 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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.