Improve keyspace parsing with expired keys (#32)

Author: kinoute

exporter/exporter.go

@@ -104,7 +104,6 @@ func NewKvrocksExporter(kvrocksURI string, opts Options) (*Exporter, error) {
 			"monitor_clients":   "monitor_clients",
 
 			// # Memory
-
 			"used_memory":     "memory_used_bytes",
 			"used_memory_rss": "memory_used_rss_bytes",
 			"used_memory_lua": "memory_used_lua_bytes",
@@ -186,6 +185,7 @@ func NewKvrocksExporter(kvrocksURI string, opts Options) (*Exporter, error) {
 		"db_avg_ttl_seconds":                   {txt: "Avg TTL in seconds", lbls: []string{"db"}},
 		"db_keys":                              {txt: "Total number of keys by DB", lbls: []string{"db"}},
 		"db_keys_expiring":                     {txt: "Total number of expiring keys by DB", lbls: []string{"db"}},
+		"db_keys_expired":                      {txt: "Total number of expired keys by DB", lbls: []string{"db"}},
 		"exporter_last_scrape_error":           {txt: "The last scrape error status.", lbls: []string{"err"}},
 		"instance_info":                        {txt: "Information about the kvrocks instance", lbls: []string{"role", "version", "git_sha1", "os", "tcp_port", "gcc_version", "process_id"}},
 		"last_slow_execution_duration_seconds": {txt: `The amount of time needed for last slow execution, in seconds`},

exporter/info.go

@@ -36,7 +36,7 @@ func (e *Exporter) extractInfoMetrics(ch chan<- prometheus.Metric, info string,
 		line = strings.TrimSpace(line)
 		log.Debugf("info: %s", line)
 		if len(line) > 0 && strings.HasPrefix(line, "# ") {
-			if strings.HasPrefix(line, "# Last scan db time") {
+			if strings.HasPrefix(line, "# Last DBSIZE SCAN") {
 				continue
 			}
 			fieldClass = line[2:]
@@ -77,11 +77,12 @@ func (e *Exporter) extractInfoMetrics(ch chan<- prometheus.Metric, info string,
 			continue
 
 		case "Keyspace":
-			if keysTotal, keysEx, avgTTL, ok := parseDBKeyspaceString(fieldKey, fieldValue); ok {
+			if keysTotal, keysEx, avgTTL, keysExpired, ok := parseDBKeyspaceString(fieldKey, fieldValue); ok {
 				dbName := fieldKey
 
 				e.registerConstMetricGauge(ch, "db_keys", keysTotal, dbName)
 				e.registerConstMetricGauge(ch, "db_keys_expiring", keysEx, dbName)
+				e.registerConstMetricGauge(ch, "db_keys_expired", keysExpired, dbName)
 
 				if avgTTL > -1 {
 					e.registerConstMetricGauge(ch, "db_avg_ttl_seconds", avgTTL, dbName)
@@ -105,6 +106,7 @@ func (e *Exporter) extractInfoMetrics(ch chan<- prometheus.Metric, info string,
 		if _, exists := handledDBs[dbName]; !exists {
 			e.registerConstMetricGauge(ch, "db_keys", 0, dbName)
 			e.registerConstMetricGauge(ch, "db_keys_expiring", 0, dbName)
+			e.registerConstMetricGauge(ch, "db_keys_expired", 0, dbName)
 		}
 	}
 
@@ -127,9 +129,11 @@ func (e *Exporter) extractInfoMetrics(ch chan<- prometheus.Metric, info string,
 }
 
 /*
-valid example: db0:keys=1,expires=0,avg_ttl=0
+valid examples:
+  - db0:keys=1,expires=0,avg_ttl=0
+  - db0:keys=1,expires=10,avg_ttl=0,expired=2
 */
-func parseDBKeyspaceString(inputKey string, inputVal string) (keysTotal float64, keysExpiringTotal float64, avgTTL float64, ok bool) {
+func parseDBKeyspaceString(inputKey string, inputVal string) (keysTotal float64, keysExpiringTotal float64, avgTTL float64, keysExpiredTotal float64, ok bool) {
 	log.Debugf("parseDBKeyspaceString inputKey: [%s] inputVal: [%s]", inputKey, inputVal)
 
 	if !strings.HasPrefix(inputKey, "db") {
@@ -138,7 +142,7 @@ func parseDBKeyspaceString(inputKey string, inputVal string) (keysTotal float64,
 	}
 
 	split := strings.Split(inputVal, ",")
-	if len(split) != 3 {
+	if len(split) < 2 || len(split) > 4 {
 		log.Debugf("parseDBKeyspaceString strings.Split(inputVal) invalid: %#v", split)
 		return
 	}
@@ -162,6 +166,14 @@ func parseDBKeyspaceString(inputKey string, inputVal string) (keysTotal float64,
 		avgTTL /= 1000
 	}
 
+	keysExpiredTotal = 0
+	if len(split) > 3 {
+		if keysExpiredTotal, err = extractVal(split[3]); err != nil {
+			log.Debugf("parseDBKeyspaceString extractVal(split[3]) invalid, err: %s", err)
+			return
+		}
+	}
+
 	ok = true
 	return
 }

exporter/info_test.go

@@ -14,10 +14,10 @@ import (
 
 func TestKeyspaceStringParser(t *testing.T) {
 	tsts := []struct {
-		db                        string
-		stats                     string
-		keysTotal, keysEx, avgTTL float64
-		ok                        bool
+		db                                     string
+		stats                                  string
+		keysTotal, keysEx, avgTTL, keysExpired float64
+		ok                                     bool
 	}{
 		{db: "xxx", stats: "", ok: false},
 		{db: "xxx", stats: "keys=1,expires=0,avg_ttl=0", ok: false},
@@ -28,20 +28,20 @@ func TestKeyspaceStringParser(t *testing.T) {
 		{db: "db3", stats: "keys=abcde,expires=0", ok: false},
 		{db: "db3", stats: "keys=213,expires=xxx", ok: false},
 		{db: "db3", stats: "keys=123,expires=0,avg_ttl=zzz", ok: false},
-
-		{db: "db0", stats: "keys=1,expires=0,avg_ttl=0", keysTotal: 1, keysEx: 0, avgTTL: 0, ok: true},
+		{db: "db0", stats: "keys=22113592,expires=21683101,avg_ttl=3816396,expired=340250", keysTotal: 22113592, keysEx: 21683101, avgTTL: 3816.396, keysExpired: 340250, ok: true},
+		{db: "db0", stats: "keys=1,expires=0,avg_ttl=0", keysTotal: 1, keysEx: 0, avgTTL: 0, keysExpired: 0, ok: true},
 	}
 
 	for _, tst := range tsts {
-		if kt, kx, ttl, ok := parseDBKeyspaceString(tst.db, tst.stats); true {
+		if kt, kx, ttl, kexp, ok := parseDBKeyspaceString(tst.db, tst.stats); true {
 
 			if ok != tst.ok {
 				t.Errorf("failed for: db:%s stats:%s", tst.db, tst.stats)
 				continue
 			}
 
-			if ok && (kt != tst.keysTotal || kx != tst.keysEx || ttl != tst.avgTTL) {
-				t.Errorf("values not matching, db:%s stats:%s   %f %f %f", tst.db, tst.stats, kt, kx, ttl)
+			if ok && (kt != tst.keysTotal || kx != tst.keysEx || ttl != tst.avgTTL || kexp != tst.keysExpired) {
+				t.Errorf("values not matching, db:%s stats:%s   %f %f %f", tst.db, tst.stats, kt, kx, ttl, kexp)
 			}
 		}
 	}