Skip to content

Run with profile mode by default #17

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.

Sign up for GitHub

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

Merged
merged 4 commits into from
Feb 10, 2025
Merged

Run with profile mode by default #17

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5ea6d66
metrics: do not export profile if not provided by smbd
synarete Feb 6, 2025
0f0ad57
main: run with profile-mode on by default
synarete Feb 6, 2025
e7c8ca5
README: profile enabled by default
synarete Feb 6, 2025
f90f6c7
metrics: proper logging upon error in call to smbstatus
synarete Feb 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
131 changes: 68 additions & 63 deletions internal/metrics/collectors.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,70 +151,75 @@ type smbProfileCollector struct {
smbCollector
}

//nolint:funlen
func (col *smbProfileCollector) Collect(ch chan<- prometheus.Metric) {
if col.sme.profile {
smbProfileInfo, err := NewUpdatedSMBProfileInfo()
if err == nil {
smb2Calls := smbProfileInfo.profileStatus.SMB2Calls
ch <- col.smb2RequestMetric(&smb2Calls.NegProt, "negprot")
ch <- col.smb2RequestMetric(&smb2Calls.SessSetup, "sesssetup")
ch <- col.smb2RequestMetric(&smb2Calls.LogOff, "logoff")
ch <- col.smb2RequestMetric(&smb2Calls.Tcon, "tcon")
ch <- col.smb2RequestMetric(&smb2Calls.Tdis, "tdis")
ch <- col.smb2RequestMetric(&smb2Calls.Create, "create")
ch <- col.smb2RequestMetric(&smb2Calls.Close, "close")
ch <- col.smb2RequestMetric(&smb2Calls.Flush, "flush")
ch <- col.smb2RequestMetric(&smb2Calls.Read, "read")
ch <- col.smb2RequestMetric(&smb2Calls.Write, "write")
ch <- col.smb2RequestMetric(&smb2Calls.Lock, "lock")
ch <- col.smb2RequestMetric(&smb2Calls.Ioctl, "ioctl")
ch <- col.smb2RequestMetric(&smb2Calls.Cancel, "cancel")
ch <- col.smb2RequestMetric(&smb2Calls.KeepAlive, "keepalive")
ch <- col.smb2RequestMetric(&smb2Calls.Find, "find")
ch <- col.smb2RequestMetric(&smb2Calls.Notify, "notify")
ch <- col.smb2RequestMetric(&smb2Calls.GetInfo, "getinfo")
ch <- col.smb2RequestMetric(&smb2Calls.SetInfo, "setinfo")
ch <- col.smb2RequestMetric(&smb2Calls.Break, "break")

sysCalls := smbProfileInfo.profileStatus.SystemCalls
ch <- col.vfsIORequestMetric(&sysCalls.PRead, "pread")
ch <- col.vfsIORequestMetric(&sysCalls.AsysPRead, "asys_pread")
ch <- col.vfsIORequestMetric(&sysCalls.PWrite, "pwrite")
ch <- col.vfsIORequestMetric(&sysCalls.AsysPWrite, "asys_pwrite")
ch <- col.vfsIORequestMetric(&sysCalls.AsysFSync, "asys_fsync")

ch <- col.vfsRequestMetric(&sysCalls.Opendir, "opendir")
ch <- col.vfsRequestMetric(&sysCalls.FDOpendir, "fdopendir")
ch <- col.vfsRequestMetric(&sysCalls.Readdir, "readdir")
ch <- col.vfsRequestMetric(&sysCalls.Rewinddir, "rewinddir")
ch <- col.vfsRequestMetric(&sysCalls.Mkdirat, "mkdirat")
ch <- col.vfsRequestMetric(&sysCalls.Closedir, "closedir")
ch <- col.vfsRequestMetric(&sysCalls.Open, "open")
ch <- col.vfsRequestMetric(&sysCalls.OpenAt, "openat")
ch <- col.vfsRequestMetric(&sysCalls.CreateFile, "createfile")
ch <- col.vfsRequestMetric(&sysCalls.Close, "close")
ch <- col.vfsRequestMetric(&sysCalls.Lseek, "lseek")
ch <- col.vfsRequestMetric(&sysCalls.RenameAt, "renameat")
ch <- col.vfsRequestMetric(&sysCalls.Stat, "stat")
ch <- col.vfsRequestMetric(&sysCalls.FStat, "fstat")
ch <- col.vfsRequestMetric(&sysCalls.LStat, "lstat")
ch <- col.vfsRequestMetric(&sysCalls.FStatAt, "fstatat")
ch <- col.vfsRequestMetric(&sysCalls.UnlinkAt, "unlinkat")
ch <- col.vfsRequestMetric(&sysCalls.Chmod, "chmod")
ch <- col.vfsRequestMetric(&sysCalls.FChmod, "fchmod")
ch <- col.vfsRequestMetric(&sysCalls.FChown, "fchown")
ch <- col.vfsRequestMetric(&sysCalls.LChown, "lchown")
ch <- col.vfsRequestMetric(&sysCalls.Chdir, "chdir")
ch <- col.vfsRequestMetric(&sysCalls.GetWD, "getwd")
ch <- col.vfsRequestMetric(&sysCalls.Fntimes, "fntimes")
ch <- col.vfsRequestMetric(&sysCalls.FTruncate, "ftruncate")
ch <- col.vfsRequestMetric(&sysCalls.FAllocate, "fallocate")
ch <- col.vfsRequestMetric(&sysCalls.ReadLinkAt, "readlinkat")
ch <- col.vfsRequestMetric(&sysCalls.SymLinkAt, "symlinkat")
ch <- col.vfsRequestMetric(&sysCalls.LinkAt, "linkat")
ch <- col.vfsRequestMetric(&sysCalls.MknodAt, "mknodat")
ch <- col.vfsRequestMetric(&sysCalls.RealPath, "realpath")
}
if !col.sme.profile {
return
}
smbProfileInfo, err := NewUpdatedSMBProfileInfo()
if err != nil {
return
}
smb2Calls := smbProfileInfo.profileStatus.SMB2Calls
if smb2Calls != nil {
ch <- col.smb2RequestMetric(&smb2Calls.NegProt, "negprot")
ch <- col.smb2RequestMetric(&smb2Calls.SessSetup, "sesssetup")
ch <- col.smb2RequestMetric(&smb2Calls.LogOff, "logoff")
ch <- col.smb2RequestMetric(&smb2Calls.Tcon, "tcon")
ch <- col.smb2RequestMetric(&smb2Calls.Tdis, "tdis")
ch <- col.smb2RequestMetric(&smb2Calls.Create, "create")
ch <- col.smb2RequestMetric(&smb2Calls.Close, "close")
ch <- col.smb2RequestMetric(&smb2Calls.Flush, "flush")
ch <- col.smb2RequestMetric(&smb2Calls.Read, "read")
ch <- col.smb2RequestMetric(&smb2Calls.Write, "write")
ch <- col.smb2RequestMetric(&smb2Calls.Lock, "lock")
ch <- col.smb2RequestMetric(&smb2Calls.Ioctl, "ioctl")
ch <- col.smb2RequestMetric(&smb2Calls.Cancel, "cancel")
ch <- col.smb2RequestMetric(&smb2Calls.KeepAlive, "keepalive")
ch <- col.smb2RequestMetric(&smb2Calls.Find, "find")
ch <- col.smb2RequestMetric(&smb2Calls.Notify, "notify")
ch <- col.smb2RequestMetric(&smb2Calls.GetInfo, "getinfo")
ch <- col.smb2RequestMetric(&smb2Calls.SetInfo, "setinfo")
ch <- col.smb2RequestMetric(&smb2Calls.Break, "break")
}
sysCalls := smbProfileInfo.profileStatus.SystemCalls
if sysCalls != nil {
ch <- col.vfsIORequestMetric(&sysCalls.PRead, "pread")
ch <- col.vfsIORequestMetric(&sysCalls.AsysPRead, "asys_pread")
ch <- col.vfsIORequestMetric(&sysCalls.PWrite, "pwrite")
ch <- col.vfsIORequestMetric(&sysCalls.AsysPWrite, "asys_pwrite")
ch <- col.vfsIORequestMetric(&sysCalls.AsysFSync, "asys_fsync")
ch <- col.vfsRequestMetric(&sysCalls.Opendir, "opendir")
ch <- col.vfsRequestMetric(&sysCalls.FDOpendir, "fdopendir")
ch <- col.vfsRequestMetric(&sysCalls.Readdir, "readdir")
ch <- col.vfsRequestMetric(&sysCalls.Rewinddir, "rewinddir")
ch <- col.vfsRequestMetric(&sysCalls.Mkdirat, "mkdirat")
ch <- col.vfsRequestMetric(&sysCalls.Closedir, "closedir")
ch <- col.vfsRequestMetric(&sysCalls.Open, "open")
ch <- col.vfsRequestMetric(&sysCalls.OpenAt, "openat")
ch <- col.vfsRequestMetric(&sysCalls.CreateFile, "createfile")
ch <- col.vfsRequestMetric(&sysCalls.Close, "close")
ch <- col.vfsRequestMetric(&sysCalls.Lseek, "lseek")
ch <- col.vfsRequestMetric(&sysCalls.RenameAt, "renameat")
ch <- col.vfsRequestMetric(&sysCalls.Stat, "stat")
ch <- col.vfsRequestMetric(&sysCalls.FStat, "fstat")
ch <- col.vfsRequestMetric(&sysCalls.LStat, "lstat")
ch <- col.vfsRequestMetric(&sysCalls.FStatAt, "fstatat")
ch <- col.vfsRequestMetric(&sysCalls.UnlinkAt, "unlinkat")
ch <- col.vfsRequestMetric(&sysCalls.Chmod, "chmod")
ch <- col.vfsRequestMetric(&sysCalls.FChmod, "fchmod")
ch <- col.vfsRequestMetric(&sysCalls.FChown, "fchown")
ch <- col.vfsRequestMetric(&sysCalls.LChown, "lchown")
ch <- col.vfsRequestMetric(&sysCalls.Chdir, "chdir")
ch <- col.vfsRequestMetric(&sysCalls.GetWD, "getwd")
ch <- col.vfsRequestMetric(&sysCalls.Fntimes, "fntimes")
ch <- col.vfsRequestMetric(&sysCalls.FTruncate, "ftruncate")
ch <- col.vfsRequestMetric(&sysCalls.FAllocate, "fallocate")
ch <- col.vfsRequestMetric(&sysCalls.ReadLinkAt, "readlinkat")
ch <- col.vfsRequestMetric(&sysCalls.SymLinkAt, "symlinkat")
ch <- col.vfsRequestMetric(&sysCalls.LinkAt, "linkat")
ch <- col.vfsRequestMetric(&sysCalls.MknodAt, "mknodat")
ch <- col.vfsRequestMetric(&sysCalls.RealPath, "realpath")
}
}

Expand Down
12 changes: 6 additions & 6 deletions internal/metrics/smbstatus.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -259,12 +259,12 @@ type SMBProfileSMB2Calls struct {

// SMBProfile represents (a subset of the) output of 'smbstatus --profile'
type SMBProfile struct {
Timestamp string `json:"timestamp"`
Version string `json:"version"`
SmbConf string `json:"smb_conf"`
SmbdLoop SMBProfileLoop `json:"SMBD loop"`
SystemCalls SMBProfileSyscalls `json:"System Calls"`
SMB2Calls SMBProfileSMB2Calls `json:"SMB2 Calls"`
Timestamp string `json:"timestamp"`
Version string `json:"version"`
SmbConf string `json:"smb_conf"`
SmbdLoop *SMBProfileLoop `json:"SMBD loop"`
SystemCalls *SMBProfileSyscalls `json:"System Calls"`
SMB2Calls *SMBProfileSMB2Calls `json:"SMB2 Calls"`
}

// LocateSMBStatus finds the local executable of 'smbstatus' on host.
Expand Down
15 changes: 15 additions & 0 deletions internal/metrics/smbstatus_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1772,6 +1772,13 @@ var (
}
}
`

smbstatusProfileOutput8 = `
{
"timestamp":"2024-12-23T12:38:58.644260+0200",
"version":"4.22.0pre1-GIT-bc45829f56c",
"smb_conf":"//etc/samba/smb.conf"
}`
)

//revive:enable line-length-limit
Expand Down Expand Up @@ -1880,3 +1887,11 @@ func TestParseSMBStatusProfile(t *testing.T) {
assert.Equal(t, profile.SMB2Calls.Read.Outbytes, 10486240)
assert.Equal(t, profile.SMB2Calls.Write.Inbytes, 90180784)
}

func TestParseSMBStatusProfileNoData(t *testing.T) {
profile, err := parseSMBProfile(smbstatusProfileOutput8)
assert.NoError(t, err)
assert.Nil(t, profile.SmbdLoop)
assert.Nil(t, profile.SystemCalls)
assert.Nil(t, profile.SMB2Calls)
}