metrics: use proper counter name for 'open_files'

Renamed to proper counter name 'smb_openfiles_total' instead of the
buggy and misleading name of locked-files.

Signed-off-by: Shachar Sharon <[email protected]>

Author: synarete

internal/metrics/collectors.go

@@ -87,13 +87,13 @@ func (col *smbActivityCollector) Collect(ch chan<- prometheus.Metric) {
 	totalSessions := 0
 	totalTreeCons := 0
 	totalConnectedUsers := 0
-	totalLockedFiles := 0
+	totalOpenFiles := 0
 	smbInfo, err := NewUpdatedSMBInfo()
 	if err == nil {
 		totalSessions = smbInfo.TotalSessions()
 		totalTreeCons = smbInfo.TotalTreeCons()
 		totalConnectedUsers = smbInfo.TotalConnectedUsers()
-		totalLockedFiles = smbInfo.TotalLockedFiles()
+		totalOpenFiles = smbInfo.TotalOpenFiles()
 	}
 	ch <- prometheus.MustNewConstMetric(col.dsc[0],
 		prometheus.GaugeValue, float64(totalSessions))
@@ -105,7 +105,7 @@ func (col *smbActivityCollector) Collect(ch chan<- prometheus.Metric) {
 		prometheus.GaugeValue, float64(totalConnectedUsers))
 
 	ch <- prometheus.MustNewConstMetric(col.dsc[3],
-		prometheus.GaugeValue, float64(totalLockedFiles))
+		prometheus.GaugeValue, float64(totalOpenFiles))
 }
 
 func (sme *smbMetricsExporter) newSMBActivityCollector() prometheus.Collector {
@@ -128,8 +128,8 @@ func (sme *smbMetricsExporter) newSMBActivityCollector() prometheus.Collector {
 			[]string{}, nil),
 
 		prometheus.NewDesc(
-			collectorName("locks", "total"),
-			"Number of currently active file-locks",
+			collectorName("openfiles", "total"),
+			"Number of currently open files",
 			[]string{}, nil),
 	}
 	return col

internal/metrics/smbinfo.go

@@ -36,8 +36,8 @@ func (smbinfo *SMBInfo) TotalTreeCons() int {
 	return len(smbinfo.smbstat.TCons)
 }
 
-func (smbinfo *SMBInfo) TotalLockedFiles() int {
-	return len(smbinfo.smbstat.LockedFiles)
+func (smbinfo *SMBInfo) TotalOpenFiles() int {
+	return len(smbinfo.smbstat.OpenFiles)
 }
 
 func (smbinfo *SMBInfo) TotalConnectedUsers() int {

internal/metrics/smbstatus.go

@@ -68,8 +68,8 @@ type SMBStatusFileID struct {
 	Extid int32 `json:"extid"`
 }
 
-// SMBStatusLockedFile represents a locked-file output field
-type SMBStatusLockedFile struct {
+// SMBStatusOpenFile represents a open-file output field
+type SMBStatusOpenFile struct {
 	ServicePath       string          `json:"service_path"`
 	Filename          string          `json:"filename"`
 	FileID            SMBStatusFileID `json:"fileid"`
@@ -78,20 +78,20 @@ type SMBStatusLockedFile struct {
 
 // SMBStatus represents output of 'smbstatus --json'
 type SMBStatus struct {
-	Timestamp   string                         `json:"timestamp"`
-	Version     string                         `json:"version"`
-	SmbConf     string                         `json:"smb_conf"`
-	Sessions    map[string]SMBStatusSession    `json:"sessions"`
-	TCons       map[string]SMBStatusTreeCon    `json:"tcons"`
-	LockedFiles map[string]SMBStatusLockedFile `json:"locked_files"`
+	Timestamp string                       `json:"timestamp"`
+	Version   string                       `json:"version"`
+	SmbConf   string                       `json:"smb_conf"`
+	Sessions  map[string]SMBStatusSession  `json:"sessions"`
+	TCons     map[string]SMBStatusTreeCon  `json:"tcons"`
+	OpenFiles map[string]SMBStatusOpenFile `json:"open_files"`
 }
 
 // SMBStatusLocks represents output of 'smbstatus -L --json'
 type SMBStatusLocks struct {
-	Timestamp string                         `json:"timestamp"`
-	Version   string                         `json:"version"`
-	SmbConf   string                         `json:"smb_conf"`
-	OpenFiles map[string]SMBStatusLockedFile `json:"open_files"`
+	Timestamp string                       `json:"timestamp"`
+	Version   string                       `json:"version"`
+	SmbConf   string                       `json:"smb_conf"`
+	OpenFiles map[string]SMBStatusOpenFile `json:"open_files"`
 }
 
 // LocateSMBStatus finds the local executable of 'smbstatus' on host.
@@ -155,16 +155,16 @@ func parseSMBStatusTreeCons(dat string) ([]SMBStatusTreeCon, error) {
 }
 
 // RunSMBStatusLocks executes 'smbstatus --locks --json' on host
-func RunSMBStatusLocks() ([]SMBStatusLockedFile, error) {
+func RunSMBStatusLocks() ([]SMBStatusOpenFile, error) {
 	dat, err := executeSMBStatusCommand("--locks --json")
 	if err != nil {
-		return []SMBStatusLockedFile{}, err
+		return []SMBStatusOpenFile{}, err
 	}
 	return parseSMBStatusLockedFiles(dat)
 }
 
-func parseSMBStatusLockedFiles(dat string) ([]SMBStatusLockedFile, error) {
-	lockedFiles := []SMBStatusLockedFile{}
+func parseSMBStatusLockedFiles(dat string) ([]SMBStatusOpenFile, error) {
+	lockedFiles := []SMBStatusOpenFile{}
 	res, err := parseSMBStatusLocks(dat)
 	if err != nil {
 		return lockedFiles, err
@@ -230,12 +230,12 @@ func parseSMBStatusLocks(data string) (*SMBStatusLocks, error) {
 // NewSMBStatus returns non-populated SMBStatus object
 func NewSMBStatus() *SMBStatus {
 	smbStatus := SMBStatus{
-		Timestamp:   "",
-		Version:     "",
-		SmbConf:     "",
-		Sessions:    map[string]SMBStatusSession{},
-		TCons:       map[string]SMBStatusTreeCon{},
-		LockedFiles: map[string]SMBStatusLockedFile{},
+		Timestamp: "",
+		Version:   "",
+		SmbConf:   "",
+		Sessions:  map[string]SMBStatusSession{},
+		TCons:     map[string]SMBStatusTreeCon{},
+		OpenFiles: map[string]SMBStatusOpenFile{},
 	}
 	return &smbStatus
 }

internal/metrics/smbstatus_test.go

@@ -147,7 +147,7 @@ var (
 		}
 	  }
 	},
-	"locked_files": {
+	"open_files": {
 	  "/home/janger/testfolder/hallo": {
 		"service_path": "/home/janger/testfolder",
 		"filename": "hallo",
@@ -267,7 +267,7 @@ var (
 		}
 	  }
 	},
-	"locked_files": {
+	"open_files": {
 	  "/mnt/96dd85fd-6c60-409c-bc1c-15f98eb358ee/a/y": {
 		"service_path": "/mnt/96dd85fd-6c60-409c-bc1c-15f98eb358ee",
 		"filename": "a/y",
@@ -584,11 +584,11 @@ func TestParseSMBStatusAll(t *testing.T) {
 	assert.NoError(t, err)
 	assert.Equal(t, len(dat.Sessions), 1)
 	assert.Equal(t, len(dat.TCons), 1)
-	assert.Equal(t, len(dat.LockedFiles), 1)
+	assert.Equal(t, len(dat.OpenFiles), 1)
 
 	dat2, err := parseSMBStatus(smbstatusOutput4)
 	assert.NoError(t, err)
-	assert.Equal(t, len(dat2.LockedFiles), 2)
+	assert.Equal(t, len(dat2.OpenFiles), 2)
 }
 
 func TestParseSMBStatusLocks(t *testing.T) {