-
Notifications
You must be signed in to change notification settings - Fork 938
feat: add support for RDB current file size metric #1095
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
Open
akshaykumar-vijapur
wants to merge
7
commits into
oliver006:master
Choose a base branch
from
akshaykumar-vijapur:aks/addrdbsize
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+472
−1
Open
Changes from 3 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
a4cdc84
feat: add support for RDB current file size metric
akshaykumar-vijapur 11d06b1
Merge branch 'master' into aks/addrdbsize
akshaykumar-vijapur e6d7516
Merge branch 'master' into aks/addrdbsize
akshaykumar-vijapur f9061f8
Merge branch 'master' into aks/addrdbsize
akshaykumar-vijapur ca4dc78
Fix RDB metric extraction and test issues
akshaykumar-vijapur 6a22782
Merge branch 'master' into aks/addrdbsize
akshaykumar-vijapur 5b57f63
chore: add unit test cases
akshaykumar-vijapur 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
Some comments aren't visible on the classic Files Changed page.
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| package exporter | ||
|
|
||
| import ( | ||
| "os" | ||
| "path/filepath" | ||
|
|
||
| "github.com/gomodule/redigo/redis" | ||
| "github.com/prometheus/client_golang/prometheus" | ||
| log "github.com/sirupsen/logrus" | ||
| ) | ||
|
|
||
| func (e *Exporter) extractRdbFileSizeMetric(ch chan<- prometheus.Metric, c redis.Conn) { | ||
| result, err := redis.Values(doRedisCmd(c, e.options.ConfigCommandName, "GET", "dir", "dbfilename")) | ||
akshaykumar-vijapur marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| if err != nil || len(result) < 4 { | ||
| log.Debugf("Failed to get RDB config from CONFIG GET dir dbfilename: %s", err) | ||
| return | ||
| } | ||
|
|
||
| dir, err := redis.String(result[1], nil) | ||
| if err != nil { | ||
| log.Debugf("Failed to parse RDB directory: %s", err) | ||
| return | ||
| } | ||
| dbfilename, err := redis.String(result[3], nil) | ||
| if err != nil { | ||
| log.Debugf("Failed to parse RDB filename: %s", err) | ||
| return | ||
| } | ||
|
|
||
| rdbPath := filepath.Join(dir, dbfilename) | ||
| log.Debugf("RDB file path: %s", rdbPath) | ||
|
|
||
| fileInfo, err := os.Stat(rdbPath) | ||
| if err != nil { | ||
| if os.IsNotExist(err) { | ||
| log.Debugf("RDB file does not exist: %s", rdbPath) | ||
| // File doesn't exist, report 0 | ||
akshaykumar-vijapur marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| e.registerConstMetricGauge(ch, "rdb_current_size_bytes", 0) | ||
| return | ||
| } | ||
| log.Debugf("Failed to stat RDB file %s: %s", rdbPath, err) | ||
| return | ||
| } | ||
|
|
||
| fileSize := float64(fileInfo.Size()) | ||
akshaykumar-vijapur marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| log.Debugf("RDB file size: %d bytes", fileInfo.Size()) | ||
| e.registerConstMetricGauge(ch, "rdb_current_size_bytes", fileSize) | ||
| } | ||
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,117 @@ | ||
| package exporter | ||
|
|
||
| import ( | ||
| "os" | ||
| "strings" | ||
| "testing" | ||
|
|
||
| "github.com/prometheus/client_golang/prometheus" | ||
| dto "github.com/prometheus/client_model/go" | ||
| ) | ||
|
|
||
| func TestExtractRdbFileSizeMetric(t *testing.T) { | ||
| if os.Getenv("TEST_REDIS_URI") == "" { | ||
| t.Skipf("TEST_REDIS_URI not set - skipping") | ||
| } | ||
|
|
||
| addr := os.Getenv("TEST_REDIS_URI") | ||
| e, err := NewRedisExporter(addr, Options{ | ||
| Namespace: "test", | ||
| InclRdbFileSizeMetric: true, | ||
| ConfigCommandName: "CONFIG", | ||
| }) | ||
| if err != nil { | ||
| t.Fatalf("NewRedisExporter() failed: %s", err) | ||
| } | ||
|
|
||
| c, err := e.connectToRedis() | ||
| if err != nil { | ||
| t.Fatalf("connectToRedis() failed: %s", err) | ||
| } | ||
| defer c.Close() | ||
|
|
||
| ch := make(chan prometheus.Metric, 100) | ||
| e.extractRdbFileSizeMetric(ch, c) | ||
| close(ch) | ||
|
|
||
| found := false | ||
| for m := range ch { | ||
| if strings.Contains(m.Desc().String(), "rdb_current_size_bytes") { | ||
| found = true | ||
| d := &dto.Metric{} | ||
| if err := m.Write(d); err == nil && d.GetGauge() != nil { | ||
| metricValue := d.GetGauge().GetValue() | ||
| if metricValue < 0 { | ||
| t.Errorf("rdb_current_size_bytes should not be negative, got %f", metricValue) | ||
| } | ||
| } | ||
| break | ||
| } | ||
| } | ||
|
|
||
| if !found { | ||
| t.Error("rdb_current_size_bytes metric should be present") | ||
| } | ||
| } | ||
|
|
||
| func TestExtractRdbFileSizeMetricDisabled(t *testing.T) { | ||
| if os.Getenv("TEST_REDIS_URI") == "" { | ||
| t.Skipf("TEST_REDIS_URI not set - skipping") | ||
| } | ||
|
|
||
| addr := os.Getenv("TEST_REDIS_URI") | ||
|
|
||
| e, err := NewRedisExporter(addr, Options{ | ||
| Namespace: "test", | ||
| InclRdbFileSizeMetric: false, | ||
| ConfigCommandName: "CONFIG", | ||
| }) | ||
| if err != nil { | ||
| t.Fatalf("NewRedisExporter() failed: %s", err) | ||
| } | ||
|
|
||
| ch := make(chan prometheus.Metric, 100) | ||
| go func() { | ||
| e.Collect(ch) | ||
| close(ch) | ||
| }() | ||
|
|
||
| for m := range ch { | ||
| if strings.Contains(m.Desc().String(), "rdb_current_size_bytes") { | ||
| t.Error("rdb_current_size_bytes metric should NOT be present when disabled") | ||
| } | ||
| } | ||
| } | ||
|
|
||
| func TestExtractRdbFileSizeMetricConfigDisabled(t *testing.T) { | ||
| if os.Getenv("TEST_REDIS_URI") == "" { | ||
| t.Skipf("TEST_REDIS_URI not set - skipping") | ||
| } | ||
|
|
||
| addr := os.Getenv("TEST_REDIS_URI") | ||
|
|
||
| e, err := NewRedisExporter(addr, Options{ | ||
| Namespace: "test", | ||
| InclRdbFileSizeMetric: true, | ||
| ConfigCommandName: "-", | ||
| }) | ||
| if err != nil { | ||
| t.Fatalf("NewRedisExporter() failed: %s", err) | ||
| } | ||
|
|
||
| c, err := e.connectToRedis() | ||
| if err != nil { | ||
| t.Fatalf("connectToRedis() failed: %s", err) | ||
| } | ||
| defer c.Close() | ||
|
|
||
| ch := make(chan prometheus.Metric, 100) | ||
| e.extractRdbFileSizeMetric(ch, c) | ||
akshaykumar-vijapur marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| close(ch) | ||
|
|
||
| for m := range ch { | ||
| if strings.Contains(m.Desc().String(), "rdb_current_size_bytes") { | ||
| t.Error("rdb_current_size_bytes metric should NOT be present when CONFIG command is disabled") | ||
| } | ||
| } | ||
| } | ||
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
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.
Uh oh!
There was an error while loading. Please reload this page.