-
Notifications
You must be signed in to change notification settings - Fork 692
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: Jan-Otto Kröpke <mail@jkroepke.de>
- Loading branch information
Showing
9 changed files
with
234 additions
and
0 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
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,36 @@ | ||
| # filetime collector | ||
|
|
||
| The filetime collector exposes modified timestamps of files in the filesystem. | ||
|
|
||
| The collector | ||
|
|
||
| ||| | ||
| -|- | ||
| Metric name prefix | `filetime` | ||
| Enabled by default? | No | ||
|
|
||
| ## Flags | ||
|
|
||
| ### `--collectors.filetime.file-patterns` | ||
| Comma-separated list of file patterns. Each pattern is a glob pattern that can contain `*`, `?`, and `**` (recursive). | ||
| See https://github.com/bmatcuk/doublestar#patterns for an extended description of the pattern syntax. | ||
|
|
||
| ## Metrics | ||
|
|
||
| Name | Description | Type | Labels | ||
| -----|-------------|------|------- | ||
| `windows_filetime_mtime_timestamp_seconds` | File modification time | gauge | `file` | ||
|
|
||
| ### Example metric | ||
|
|
||
| ``` | ||
| # HELP windows_filetime_mtime_timestamp_seconds File modification time | ||
| # TYPE windows_filetime_mtime_timestamp_seconds gauge | ||
| windows_filetime_mtime_timestamp_seconds{file="C:\\Users\\admin\\Desktop\\Dashboard.lnk"} 1.726434517e+09 | ||
| ``` | ||
|
|
||
| ## Useful queries | ||
| _This collector does not yet have any useful queries added, we would appreciate your help adding them!_ | ||
|
|
||
| ## Alerting examples | ||
| _This collector does not yet have alerting examples, we would appreciate your help adding them!_ |
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,175 @@ | ||
| //go:build windows | ||
|
|
||
| package filetime | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "log/slog" | ||
| "os" | ||
| "path/filepath" | ||
| "strings" | ||
| "sync" | ||
|
|
||
| "github.com/alecthomas/kingpin/v2" | ||
| "github.com/bmatcuk/doublestar/v4" | ||
| "github.com/prometheus-community/windows_exporter/pkg/types" | ||
| "github.com/prometheus/client_golang/prometheus" | ||
| "github.com/yusufpapurcu/wmi" | ||
| ) | ||
|
|
||
| const Name = "filetime" | ||
|
|
||
| type Config struct { | ||
| filePatterns []string | ||
| } | ||
|
|
||
| var ConfigDefaults = Config{ | ||
| filePatterns: []string{}, | ||
| } | ||
|
|
||
| // A Collector is a Prometheus Collector for collecting file times. | ||
| type Collector struct { | ||
| config Config | ||
|
|
||
| fileMTime *prometheus.Desc | ||
| } | ||
|
|
||
| func New(config *Config) *Collector { | ||
| if config == nil { | ||
| config = &ConfigDefaults | ||
| } | ||
|
|
||
| if config.filePatterns == nil { | ||
| config.filePatterns = ConfigDefaults.filePatterns | ||
| } | ||
|
|
||
| c := &Collector{ | ||
| config: *config, | ||
| } | ||
|
|
||
| return c | ||
| } | ||
|
|
||
| func NewWithFlags(app *kingpin.Application) *Collector { | ||
| c := &Collector{ | ||
| config: ConfigDefaults, | ||
| } | ||
| c.config.filePatterns = make([]string, 0) | ||
|
|
||
| var filePatterns string | ||
|
|
||
| app.Flag( | ||
| "collectors.filetime.file-patterns", | ||
| "Comma-separated list of file patterns. Each pattern is a glob pattern that can contain `*`, `?`, and `**` (recursive). See https://github.com/bmatcuk/doublestar#patterns", | ||
| ).Default(strings.Join(ConfigDefaults.filePatterns, ",")).StringVar(&filePatterns) | ||
|
|
||
| app.Action(func(*kingpin.ParseContext) error { | ||
| // doublestar.Glob() requires forward slashes | ||
| c.config.filePatterns = strings.Split(filepath.ToSlash(filePatterns), ",") | ||
|
|
||
| return nil | ||
| }) | ||
|
|
||
| return c | ||
| } | ||
|
|
||
| func (c *Collector) GetName() string { | ||
| return Name | ||
| } | ||
|
|
||
| func (c *Collector) GetPerfCounter(_ *slog.Logger) ([]string, error) { | ||
| return []string{}, nil | ||
| } | ||
|
|
||
| func (c *Collector) Close(_ *slog.Logger) error { | ||
| return nil | ||
| } | ||
|
|
||
| func (c *Collector) Build(logger *slog.Logger, _ *wmi.Client) error { | ||
| logger.Info("filetime collector is in an experimental state! It may subject to change.", | ||
| slog.String("collector", Name), | ||
| ) | ||
|
|
||
| c.fileMTime = prometheus.NewDesc( | ||
| prometheus.BuildFQName(types.Namespace, Name, "mtime_timestamp_seconds"), | ||
| "File modification time", | ||
| []string{"file"}, | ||
| nil, | ||
| ) | ||
|
|
||
| for _, filePattern := range c.config.filePatterns { | ||
| basePath, pattern := doublestar.SplitPattern(filePattern) | ||
|
|
||
| _, err := doublestar.Glob(os.DirFS(basePath), pattern, doublestar.WithFilesOnly()) | ||
| if err != nil { | ||
| return fmt.Errorf("invalid glob pattern: %w", err) | ||
| } | ||
| } | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| // Collect sends the metric values for each metric | ||
| // to the provided prometheus Metric channel. | ||
| func (c *Collector) Collect(_ *types.ScrapeContext, logger *slog.Logger, ch chan<- prometheus.Metric) error { | ||
| logger = logger.With(slog.String("collector", Name)) | ||
|
|
||
| return c.collectGlob(logger, ch) | ||
| } | ||
|
|
||
| // collectWin32 collects file times for each file path in the config. It using Win32 FindFirstFile and FindNextFile. | ||
| func (c *Collector) collectGlob(logger *slog.Logger, ch chan<- prometheus.Metric) error { | ||
| wg := sync.WaitGroup{} | ||
|
|
||
| for _, filePattern := range c.config.filePatterns { | ||
| wg.Add(1) | ||
|
|
||
| go func(filePattern string) { | ||
| defer wg.Done() | ||
|
|
||
| if err := c.collectGlobFilePath(logger, ch, filePattern); err != nil { | ||
| logger.Error("failed collecting metrics for filepath", | ||
| slog.String("filepath", filePattern), | ||
| slog.Any("err", err), | ||
| ) | ||
| } | ||
| }(filePattern) | ||
| } | ||
|
|
||
| wg.Wait() | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| func (c *Collector) collectGlobFilePath(logger *slog.Logger, ch chan<- prometheus.Metric, filePattern string) error { | ||
| basePath, pattern := doublestar.SplitPattern(filePattern) | ||
| basePathFS := os.DirFS(basePath) | ||
|
|
||
| matches, err := doublestar.Glob(basePathFS, pattern, doublestar.WithFilesOnly()) | ||
| if err != nil { | ||
| return fmt.Errorf("failed to glob: %w", err) | ||
| } | ||
|
|
||
| for _, match := range matches { | ||
| filePath := filepath.Join(basePath, match) | ||
|
|
||
| fileInfo, err := os.Stat(filePath) | ||
| if err != nil { | ||
| logger.Warn("failed to state file", | ||
| slog.String("file", filePath), | ||
| slog.Any("err", err), | ||
| ) | ||
|
|
||
| continue | ||
| } | ||
|
|
||
| ch <- prometheus.MustNewConstMetric( | ||
| c.fileMTime, | ||
| prometheus.GaugeValue, | ||
| float64(fileInfo.ModTime().UTC().Unix()), | ||
| filePath, | ||
| ) | ||
| } | ||
|
|
||
| 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,12 @@ | ||
| package filetime_test | ||
|
|
||
| import ( | ||
| "testing" | ||
|
|
||
| "github.com/prometheus-community/windows_exporter/pkg/collector/filetime" | ||
| "github.com/prometheus-community/windows_exporter/pkg/testutils" | ||
| ) | ||
|
|
||
| func BenchmarkCollector(b *testing.B) { | ||
| testutils.FuncBenchmarkCollector(b, filetime.Name, filetime.NewWithFlags) | ||
| } |
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