├── go.mod ├── README.md ├── statfs.go ├── diskspace.go └── go.sum /go.mod: -------------------------------------------------------------------------------- 1 | module github.com/mholt/diskspace 2 | 3 | go 1.14 4 | 5 | require ( 6 | go.uber.org/zap v1.15.0 7 | golang.org/x/sys v0.0.0-20200615200032-f1bc736245b1 8 | ) 9 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | Package diskspace 2 | ================= 3 | 4 | A tiny package that can read disk usage and manage disk space when it gets too full. Just something I needed for a couple projects. I don't expect or encourage anyone else to use it. 5 | -------------------------------------------------------------------------------- /statfs.go: -------------------------------------------------------------------------------- 1 | // Copyright 2020 Matthew Holt 2 | 3 | package diskspace 4 | 5 | import ( 6 | "runtime" 7 | 8 | syscall "golang.org/x/sys/unix" 9 | ) 10 | 11 | type diskStatus struct { 12 | all, available, free, used uint64 13 | } 14 | 15 | // Source: https://gist.github.com/ttys3/21e2a1215cf1905ab19ddcec03927c75 16 | func diskUsage(path string) (diskStatus, error) { 17 | fs := syscall.Statfs_t{} 18 | err := syscall.Statfs(path, &fs) 19 | if err != nil { 20 | return diskStatus{}, err 21 | } 22 | disk := diskStatus{ 23 | all: fs.Blocks * uint64(fs.Bsize), 24 | available: fs.Bavail * uint64(fs.Bsize), 25 | free: fs.Bfree * uint64(fs.Bsize), 26 | } 27 | if runtime.GOOS == "darwin" { 28 | // not sure why mac is different but whatevs 29 | disk.used = disk.all - disk.available 30 | } else { 31 | disk.used = disk.all - disk.free 32 | } 33 | return disk, nil 34 | } 35 | -------------------------------------------------------------------------------- /diskspace.go: -------------------------------------------------------------------------------- 1 | // Copyright 2020 Matthew Holt 2 | 3 | package diskspace 4 | 5 | import ( 6 | "context" 7 | "fmt" 8 | "sync" 9 | "time" 10 | 11 | "go.uber.org/zap" 12 | ) 13 | 14 | // Maintainer keeps disk space utilization under control. 15 | type Maintainer struct { 16 | // The volume to maintain. Default: "/" 17 | Volume string 18 | 19 | // How often to check disk space usage. 20 | // Default: 10m 21 | CheckInterval time.Duration 22 | 23 | // The ratio of used/total space before 24 | // disk cleaning. Default: 0.9 25 | Threshold float64 26 | 27 | // The function that will be called to 28 | // clean up disk space. 29 | Clean func() error 30 | 31 | // Custom logger. 32 | Logger *zap.Logger 33 | 34 | mu sync.Mutex 35 | } 36 | 37 | // Maintain maintains disk space. It checks the disk usage 38 | // for m.Volume every m.CheckInterval, and runs m.Clean if 39 | // the disk usage is above m.Threshold. If m.Clean is nil, 40 | // this function panics. Otherwise, it blocks indefinitely 41 | // until ctx is cancelled. 42 | func (m *Maintainer) Maintain(ctx context.Context) { 43 | if m.Clean == nil { 44 | panic("nil Clean function") 45 | } 46 | if m.Volume == "" { 47 | m.Volume = defaultVolume 48 | } 49 | if m.Threshold <= 0 || m.Threshold >= 1 { 50 | m.Threshold = defaultThreshold 51 | } 52 | if m.CheckInterval <= 0 { 53 | m.CheckInterval = defaultCheckInterval 54 | } 55 | if m.Logger == nil { 56 | m.Logger = zap.NewNop() 57 | } 58 | 59 | m.Logger.Info("starting disk usage maintenance goroutine", 60 | zap.String("volume", m.Volume), 61 | zap.Float64("threshold", m.Threshold), 62 | zap.Duration("interval", m.CheckInterval)) 63 | 64 | // initial maintenance 65 | err := m.maintainDiskUsage() 66 | if err != nil { 67 | m.Logger.Error("checking disk space", zap.Error(err)) 68 | } 69 | 70 | // start maintenance ticker 71 | ticker := time.NewTicker(m.CheckInterval) 72 | 73 | // maintain until context is canceled 74 | for { 75 | select { 76 | case <-ticker.C: 77 | err := m.maintainDiskUsage() 78 | if err != nil { 79 | m.Logger.Error("checking disk space", zap.Error(err)) 80 | continue 81 | } 82 | case <-ctx.Done(): 83 | ticker.Stop() 84 | return 85 | } 86 | } 87 | } 88 | 89 | func (m *Maintainer) maintainDiskUsage() error { 90 | // don't allow maintenance ops to overlap 91 | m.mu.Lock() 92 | defer m.mu.Unlock() 93 | 94 | du, err := diskUsage(m.Volume) 95 | if err != nil { 96 | return err 97 | } 98 | totalMB := du.all / MB 99 | usedMB := du.used / MB 100 | usedRatio := float64(usedMB) / float64(totalMB) 101 | 102 | // nothing to do if disk is not nearly full 103 | if usedRatio < m.Threshold { 104 | return nil 105 | } 106 | 107 | m.Logger.Warn("disk space usage above threshold", 108 | zap.Uint64("total_mb", totalMB), 109 | zap.Uint64("used_mb", usedMB), 110 | zap.Float64("used_ratio", usedRatio), 111 | zap.Float64("used_threshold", m.Threshold)) 112 | 113 | // run cleaner function 114 | err = m.Clean() 115 | if err != nil { 116 | return fmt.Errorf("clean: %v", err) 117 | } 118 | 119 | // see how much space is now available 120 | du, err = diskUsage(m.Volume) 121 | if err != nil { 122 | return err 123 | } 124 | newUsedMB := du.used / MB 125 | usedDiff := usedMB - newUsedMB 126 | 127 | m.Logger.Info("disk space cleaned", 128 | zap.Uint64("used_mb", newUsedMB), 129 | zap.Uint64("freed_mb", usedDiff)) 130 | 131 | return nil 132 | } 133 | 134 | const ( 135 | defaultVolume = "/" 136 | defaultThreshold = 0.9 137 | defaultCheckInterval = 10 * time.Minute 138 | ) 139 | 140 | // Disk size constants. 141 | const ( 142 | _ = iota 143 | KB = 1 << (10 * iota) 144 | MB 145 | GB 146 | TB 147 | PB 148 | EB 149 | ZB 150 | YB 151 | ) 152 | -------------------------------------------------------------------------------- /go.sum: -------------------------------------------------------------------------------- 1 | github.com/BurntSushi/toml v0.3.1 h1:WXkYYl6Yr3qBf1K79EBnL4mak0OimBfB0XUf9Vl28OQ= 2 | github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03qcyfWMU= 3 | github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= 4 | github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= 5 | github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= 6 | github.com/google/renameio v0.1.0/go.mod h1:KWCgfxg9yswjAJkECMjeO8J8rahYeXnNhOm40UhjYkI= 7 | github.com/kisielk/gotool v1.0.0/go.mod h1:XhKaO+MFFWcvkIS/tQcRk01m1F5IRFswLeQ+oQHNcck= 8 | github.com/kr/pretty v0.1.0 h1:L/CwN0zerZDmRFUapSPitk6f+Q3+0za1rQkzVuMiMFI= 9 | github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo= 10 | github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ= 11 | github.com/kr/text v0.1.0 h1:45sCR5RtlFHMR4UwH9sdQ5TC8v0qDQCHnXt+kaKSTVE= 12 | github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI= 13 | github.com/pkg/errors v0.8.1 h1:iURUrRGxPUNPdy5/HRSm+Yj6okJ6UtLINN0Q9M4+h3I= 14 | github.com/pkg/errors v0.8.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0= 15 | github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= 16 | github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= 17 | github.com/rogpeppe/go-internal v1.3.0/go.mod h1:M8bDsm7K2OlrFYOpmOWEs/qY81heoFRclV5y23lUDJ4= 18 | github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= 19 | github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI= 20 | github.com/stretchr/testify v1.4.0 h1:2E4SXV/wtOkTonXsotYi4li6zVWxYlZuYNCXe9XRJyk= 21 | github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4= 22 | go.uber.org/atomic v1.6.0 h1:Ezj3JGmsOnG1MoRWQkPBsKLe9DwWD9QeXzTRzzldNVk= 23 | go.uber.org/atomic v1.6.0/go.mod h1:sABNBOSYdrvTF6hTgEIbc7YasKWGhgEQZyfxyTvoXHQ= 24 | go.uber.org/multierr v1.5.0 h1:KCa4XfM8CWFCpxXRGok+Q0SS/0XBhMDbHHGABQLvD2A= 25 | go.uber.org/multierr v1.5.0/go.mod h1:FeouvMocqHpRaaGuG9EjoKcStLC43Zu/fmqdUMPcKYU= 26 | go.uber.org/tools v0.0.0-20190618225709-2cfd321de3ee h1:0mgffUl7nfd+FpvXMVz4IDEaUSmT1ysygQC7qYo7sG4= 27 | go.uber.org/tools v0.0.0-20190618225709-2cfd321de3ee/go.mod h1:vJERXedbb3MVM5f9Ejo0C68/HhF8uaILCdgjnY+goOA= 28 | go.uber.org/zap v1.15.0 h1:ZZCA22JRF2gQE5FoNmhmrf7jeJJ2uhqDUNRYKm8dvmM= 29 | go.uber.org/zap v1.15.0/go.mod h1:Mb2vm2krFEG5DV0W9qcHBYFtp/Wku1cvYaqPsS/WYfc= 30 | golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w= 31 | golang.org/x/crypto v0.0.0-20190510104115-cbcb75029529/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI= 32 | golang.org/x/lint v0.0.0-20190930215403-16217165b5de h1:5hukYrvBGR8/eNkX5mdUezrA6JiaEZDtJb9Ei+1LlBs= 33 | golang.org/x/lint v0.0.0-20190930215403-16217165b5de/go.mod h1:6SW0HCj/g11FgYtHlgUYUwCkIfeOF89ocIRzGO/8vkc= 34 | golang.org/x/mod v0.0.0-20190513183733-4bf6d317e70e/go.mod h1:mXi4GBBbnImb6dmsKGUJ2LatrhH/nqhxcFungHvyanc= 35 | golang.org/x/net v0.0.0-20190311183353-d8887717615a/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg= 36 | golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg= 37 | golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= 38 | golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= 39 | golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= 40 | golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= 41 | golang.org/x/sys v0.0.0-20200615200032-f1bc736245b1 h1:ogLJMz+qpzav7lGMh10LMvAkM/fAoGlaiiHYiFYdm80= 42 | golang.org/x/sys v0.0.0-20200615200032-f1bc736245b1/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= 43 | golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= 44 | golang.org/x/tools v0.0.0-20190311212946-11955173bddd/go.mod h1:LCzVGOaR6xXOjkQ3onu1FJEFr0SW1gC7cKk1uF8kGRs= 45 | golang.org/x/tools v0.0.0-20190621195816-6e04913cbbac/go.mod h1:/rFqwRUd4F7ZHNgwSSTFct+R/Kf4OFW1sUzUTQQTgfc= 46 | golang.org/x/tools v0.0.0-20191029041327-9cc4af7d6b2c/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= 47 | golang.org/x/tools v0.0.0-20191029190741-b9c20aec41a5 h1:hKsoRgsbwY1NafxrwTs+k64bikrLBkAgPir1TNCj3Zs= 48 | golang.org/x/tools v0.0.0-20191029190741-b9c20aec41a5/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= 49 | golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= 50 | gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= 51 | gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127 h1:qIbj1fsPNlZgppZ+VLlY7N33q108Sa+fhmuc+sWQYwY= 52 | gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= 53 | gopkg.in/errgo.v2 v2.1.0/go.mod h1:hNsd1EY+bozCKY1Ytp96fpM3vjJbqLJn88ws8XvfDNI= 54 | gopkg.in/yaml.v2 v2.2.2 h1:ZCJp+EgiOT7lHqUV2J862kp8Qj64Jo6az82+3Td9dZw= 55 | gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= 56 | honnef.co/go/tools v0.0.1-2019.2.3 h1:3JgtbtFHMiCmsznwGVTUWbgGov+pVqnlf1dEJTNAXeM= 57 | honnef.co/go/tools v0.0.1-2019.2.3/go.mod h1:a3bituU0lyd329TUQxRnasdCoJDkEUEAqEt0JzvZhAg= 58 | --------------------------------------------------------------------------------