-
Notifications
You must be signed in to change notification settings - Fork 2.4k
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
Add new collector and metrics for watchdog #2880
Merged
SuperQ
merged 1 commit into
prometheus:master
from
gavinkflam:2309-add-watchdog-collector
Mar 9, 2024
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 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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,133 @@ | ||
| // Copyright 2023 The Prometheus Authors | ||
| // 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. | ||
|
|
||
| //go:build linux && !nowatchdog | ||
| // +build linux,!nowatchdog | ||
|
|
||
| package collector | ||
|
|
||
| import ( | ||
| "fmt" | ||
|
|
||
| "github.com/go-kit/log" | ||
| "github.com/prometheus/client_golang/prometheus" | ||
| "github.com/prometheus/procfs/sysfs" | ||
| ) | ||
|
|
||
| type watchdogCollector struct { | ||
| fs sysfs.FS | ||
| logger log.Logger | ||
| } | ||
|
|
||
| func init() { | ||
| registerCollector("watchdog", defaultDisabled, NewWatchdogCollector) | ||
| } | ||
|
|
||
| // NewWatchdogCollector returns a new Collector exposing watchdog stats. | ||
| func NewWatchdogCollector(logger log.Logger) (Collector, error) { | ||
| fs, err := sysfs.NewFS(*sysPath) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("failed to open procfs: %w", err) | ||
| } | ||
|
|
||
| return &watchdogCollector{ | ||
| fs: fs, | ||
| logger: logger, | ||
| }, nil | ||
| } | ||
|
|
||
| var ( | ||
| watchdogBootstatusDesc = prometheus.NewDesc( | ||
| prometheus.BuildFQName(namespace, "watchdog", "bootstatus"), | ||
| "Value of /sys/class/watchdog/<watchdog>/bootstatus", | ||
| []string{"name"}, nil, | ||
| ) | ||
| watchdogFwVersionDesc = prometheus.NewDesc( | ||
| prometheus.BuildFQName(namespace, "watchdog", "fw_version"), | ||
| "Value of /sys/class/watchdog/<watchdog>/fw_version", | ||
| []string{"name"}, nil, | ||
| ) | ||
| watchdogNowayoutDesc = prometheus.NewDesc( | ||
| prometheus.BuildFQName(namespace, "watchdog", "nowayout"), | ||
| "Value of /sys/class/watchdog/<watchdog>/nowayout", | ||
| []string{"name"}, nil, | ||
| ) | ||
| watchdogTimeleftDesc = prometheus.NewDesc( | ||
| prometheus.BuildFQName(namespace, "watchdog", "timeleft_seconds"), | ||
| "Value of /sys/class/watchdog/<watchdog>/timeleft", | ||
| []string{"name"}, nil, | ||
| ) | ||
| watchdogTimeoutDesc = prometheus.NewDesc( | ||
| prometheus.BuildFQName(namespace, "watchdog", "timeout_seconds"), | ||
| "Value of /sys/class/watchdog/<watchdog>/timeout", | ||
| []string{"name"}, nil, | ||
| ) | ||
| watchdogPretimeoutDesc = prometheus.NewDesc( | ||
| prometheus.BuildFQName(namespace, "watchdog", "pretimeout_seconds"), | ||
| "Value of /sys/class/watchdog/<watchdog>/pretimeout", | ||
| []string{"name"}, nil, | ||
| ) | ||
| watchdogAccessCs0Desc = prometheus.NewDesc( | ||
| prometheus.BuildFQName(namespace, "watchdog", "access_cs0"), | ||
| "Value of /sys/class/watchdog/<watchdog>/access_cs0", | ||
| []string{"name"}, nil, | ||
| ) | ||
| watchdogInfoDesc = prometheus.NewDesc( | ||
| prometheus.BuildFQName(namespace, "watchdog", "info"), | ||
| "Info of /sys/class/watchdog/<watchdog>", | ||
| []string{"name", "options", "identity", "state", "status", "pretimeout_governor"}, nil, | ||
| ) | ||
| ) | ||
|
|
||
| func toLabelValue(ptr *string) string { | ||
| if ptr == nil { | ||
| return "" | ||
| } | ||
| return *ptr | ||
| } | ||
|
|
||
| func (c *watchdogCollector) Update(ch chan<- prometheus.Metric) error { | ||
| watchdogClass, err := c.fs.WatchdogClass() | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| for _, wd := range watchdogClass { | ||
| if wd.Bootstatus != nil { | ||
| ch <- prometheus.MustNewConstMetric(watchdogBootstatusDesc, prometheus.GaugeValue, float64(*wd.Bootstatus), wd.Name) | ||
| } | ||
| if wd.FwVersion != nil { | ||
| ch <- prometheus.MustNewConstMetric(watchdogFwVersionDesc, prometheus.GaugeValue, float64(*wd.FwVersion), wd.Name) | ||
| } | ||
| if wd.Nowayout != nil { | ||
| ch <- prometheus.MustNewConstMetric(watchdogNowayoutDesc, prometheus.GaugeValue, float64(*wd.Nowayout), wd.Name) | ||
| } | ||
| if wd.Timeleft != nil { | ||
| ch <- prometheus.MustNewConstMetric(watchdogTimeleftDesc, prometheus.GaugeValue, float64(*wd.Timeleft), wd.Name) | ||
| } | ||
| if wd.Timeout != nil { | ||
| ch <- prometheus.MustNewConstMetric(watchdogTimeoutDesc, prometheus.GaugeValue, float64(*wd.Timeout), wd.Name) | ||
| } | ||
| if wd.Pretimeout != nil { | ||
| ch <- prometheus.MustNewConstMetric(watchdogPretimeoutDesc, prometheus.GaugeValue, float64(*wd.Pretimeout), wd.Name) | ||
| } | ||
| if wd.AccessCs0 != nil { | ||
| ch <- prometheus.MustNewConstMetric(watchdogAccessCs0Desc, prometheus.GaugeValue, float64(*wd.AccessCs0), wd.Name) | ||
| } | ||
|
|
||
| ch <- prometheus.MustNewConstMetric(watchdogInfoDesc, prometheus.GaugeValue, 1.0, | ||
| wd.Name, toLabelValue(wd.Options), toLabelValue(wd.Identity), toLabelValue(wd.State), toLabelValue(wd.Status), toLabelValue(wd.PretimeoutGovernor)) | ||
| } | ||
|
|
||
| return nil | ||
| } | ||
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,92 @@ | ||
| // Copyright 2023 The Prometheus Authors | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file ewcept 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. | ||
|
|
||
| //go:build !nowatchdog | ||
| // +build !nowatchdog | ||
|
|
||
| package collector | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "os" | ||
| "strings" | ||
| "testing" | ||
|
|
||
| "github.com/go-kit/log" | ||
| "github.com/prometheus/client_golang/prometheus" | ||
| "github.com/prometheus/client_golang/prometheus/testutil" | ||
| ) | ||
|
|
||
| type testWatchdogCollector struct { | ||
| wc Collector | ||
| } | ||
|
|
||
| func (c testWatchdogCollector) Collect(ch chan<- prometheus.Metric) { | ||
| c.wc.Update(ch) | ||
| } | ||
|
|
||
| func (c testWatchdogCollector) Describe(ch chan<- *prometheus.Desc) { | ||
| prometheus.DescribeByCollect(c, ch) | ||
| } | ||
|
|
||
| func TestWatchdogStats(t *testing.T) { | ||
| testcase := `# HELP node_watchdog_access_cs0 Value of /sys/class/watchdog/<watchdog>/access_cs0 | ||
| # TYPE node_watchdog_access_cs0 gauge | ||
| node_watchdog_access_cs0{name="watchdog0"} 0 | ||
| # HELP node_watchdog_bootstatus Value of /sys/class/watchdog/<watchdog>/bootstatus | ||
| # TYPE node_watchdog_bootstatus gauge | ||
| node_watchdog_bootstatus{name="watchdog0"} 1 | ||
| # HELP node_watchdog_fw_version Value of /sys/class/watchdog/<watchdog>/fw_version | ||
| # TYPE node_watchdog_fw_version gauge | ||
| node_watchdog_fw_version{name="watchdog0"} 2 | ||
| # HELP node_watchdog_info Info of /sys/class/watchdog/<watchdog> | ||
| # TYPE node_watchdog_info gauge | ||
| node_watchdog_info{identity="",name="watchdog1",options="",pretimeout_governor="",state="",status=""} 1 | ||
| node_watchdog_info{identity="Software Watchdog",name="watchdog0",options="0x8380",pretimeout_governor="noop",state="active",status="0x8000"} 1 | ||
| # HELP node_watchdog_nowayout Value of /sys/class/watchdog/<watchdog>/nowayout | ||
| # TYPE node_watchdog_nowayout gauge | ||
| node_watchdog_nowayout{name="watchdog0"} 0 | ||
| # HELP node_watchdog_pretimeout_seconds Value of /sys/class/watchdog/<watchdog>/pretimeout | ||
| # TYPE node_watchdog_pretimeout_seconds gauge | ||
| node_watchdog_pretimeout_seconds{name="watchdog0"} 120 | ||
| # HELP node_watchdog_timeleft_seconds Value of /sys/class/watchdog/<watchdog>/timeleft | ||
| # TYPE node_watchdog_timeleft_seconds gauge | ||
| node_watchdog_timeleft_seconds{name="watchdog0"} 300 | ||
| # HELP node_watchdog_timeout_seconds Value of /sys/class/watchdog/<watchdog>/timeout | ||
| # TYPE node_watchdog_timeout_seconds gauge | ||
| node_watchdog_timeout_seconds{name="watchdog0"} 60 | ||
| ` | ||
| *sysPath = "fixtures/sys" | ||
|
|
||
| logger := log.NewLogfmtLogger(os.Stderr) | ||
| c, err := NewWatchdogCollector(logger) | ||
| if err != nil { | ||
| t.Fatal(err) | ||
| } | ||
| reg := prometheus.NewRegistry() | ||
| reg.MustRegister(&testWatchdogCollector{wc: c}) | ||
|
|
||
| sink := make(chan prometheus.Metric) | ||
| go func() { | ||
| err = c.Update(sink) | ||
| if err != nil { | ||
| panic(fmt.Errorf("failed to update collector: %s", err)) | ||
| } | ||
| close(sink) | ||
| }() | ||
|
|
||
| err = testutil.GatherAndCompare(reg, strings.NewReader(testcase)) | ||
| if err != nil { | ||
| t.Fatal(err) | ||
| } | ||
| } |
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 |
|---|---|---|
|
|
@@ -49,6 +49,7 @@ enabled_collectors=$(cat << COLLECTORS | |
| thermal_zone | ||
| udp_queues | ||
| vmstat | ||
| watchdog | ||
| wifi | ||
| xfrm | ||
| xfs | ||
|
|
||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This seems low cardinality enough, and useful enough, we could consider enabling this by default.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, I have submitted a PR for this. #2953