merge from branch status-file

Author: creativeprojects

.gitignore

@@ -24,3 +24,5 @@
 
 # log files
 /*.log
+
+status.json

README.md

@@ -64,6 +64,7 @@ For the rest of the documentation, I'll be mostly showing examples using the TOM
       * [Examples of scheduling commands under Linux](#examples-of-scheduling-commands-under-linux)
       * [Examples of scheduling commands under macOS](#examples-of-scheduling-commands-under-macos)
     * [Changing schedule\-permission from user to system, or system to user](#changing-schedule-permission-from-user-to-system-or-system-to-user)
+  * [Status file for easy monitoring](#status-file-for-easy-monitoring)
   * [Configuration file reference](#configuration-file-reference)
   * [Appendix](#appendix)
   * [Using resticprofile and systemd](#using-resticprofile-and-systemd)
@@ -1004,6 +1005,40 @@ This order is important:
 - now you can change your permission (`user` to `system`, or `system` to `user`)
 - `schedule` your updated profile
 
+## Status file for easy monitoring
+
+If you need to escalate the result of your backup to a monitoring system, you can definitely use the `run-after` and `run-after-fail` scripting.
+
+But sometimes we just need something simple that a monitoring system can regularly check. For that matter, resticprofile can generate a simple JSON file with the details of the latest backup/forget/check command. I have a Zabbix agent checking this file once a day, and you can hook up any monitoring system that can load a JSON file.
+
+In your profile, you simply need to add a new parameter, which is the location of your status file
+
+```toml
+[my-backup]
+status-file = "backup-status.json"
+```
+
+Here's an example of a generated file, where you can see that the last check failed, whereas the last backup succeeded:
+
+```json
+{
+  "profiles": {
+    "my-backup": {
+      "backup": {
+        "success": true,
+        "time": "2020-07-31T23:54:00.401556+01:00",
+        "error": ""
+      },
+      "check": {
+        "success": false,
+        "time": "2020-07-31T23:47:22.311848+01:00",
+        "error": "exit status 1"
+      }
+    }
+  }
+}
+```
+
 ## Configuration file reference
 
 `[global]`
@@ -1034,6 +1069,7 @@ Flags used by resticprofile only
 * **run-before**: string OR list of strings
 * **run-after**: string OR list of strings
 * **run-after-fail**: string OR list of strings
+* **status-file**: string
 
 Flags passed to the restic command line
 

config/profile.go

@@ -22,6 +22,7 @@ type Profile struct {
 	RunBefore     []string                  `mapstructure:"run-before"`
 	RunAfter      []string                  `mapstructure:"run-after"`
 	RunAfterFail  []string                  `mapstructure:"run-after-fail"`
+	StatusFile    string                    `mapstructure:"status-file"`
 	Environment   map[string]string         `mapstructure:"env"`
 	Backup        *BackupSection            `mapstructure:"backup"`
 	Retention     *RetentionSection         `mapstructure:"retention"`

examples/dev.yaml

@@ -75,8 +75,9 @@ root:
         - dev
 
 self:
-    initialize: true
+    initialize: false
     inherit: default
+    status-file: status.json
     backup:
         source: ./
         schedule:

go.mod

@@ -21,6 +21,7 @@ require (
 	github.com/rhysd/go-github-selfupdate v1.2.2
 	github.com/rickb777/date v1.12.3
 	github.com/smartystreets/assertions v1.0.0 // indirect
+	github.com/spf13/afero v1.3.2
 	github.com/spf13/cast v1.3.1 // indirect
 	github.com/spf13/jwalterweatherman v1.1.0 // indirect
 	github.com/spf13/pflag v1.0.5

main.go

@@ -25,7 +25,7 @@ import (
 
 // These fields are populated by the goreleaser build
 var (
-	version = "0.9.0"
+	version = "0.9.1-dev"
 	commit  = ""
 	date    = ""
 	builtBy = ""

status/profile.go

@@ -0,0 +1,72 @@
+package status
+
+import "time"
+
+// Profile status
+type Profile struct {
+	Backup    *CommandStatus `json:"backup,omitempty"`
+	Retention *CommandStatus `json:"retention,omitempty"`
+	Check     *CommandStatus `json:"check,omitempty"`
+}
+
+func newProfile() *Profile {
+	return &Profile{}
+}
+
+// CommandStatus is the last command status
+type CommandStatus struct {
+	Success bool      `json:"success"`
+	Time    time.Time `json:"time"`
+	Error   string    `json:"error"`
+}
+
+// BackupSuccess indicates the last backup was successful
+func (p *Profile) BackupSuccess() *Profile {
+	p.Backup = newSuccess()
+	return p
+}
+
+// BackupError sets the error of the last backup
+func (p *Profile) BackupError(err error) *Profile {
+	p.Backup = newError(err)
+	return p
+}
+
+// RetentionSuccess indicates the last retention was successful
+func (p *Profile) RetentionSuccess() *Profile {
+	p.Retention = newSuccess()
+	return p
+}
+
+// RetentionError sets the error of the last retention
+func (p *Profile) RetentionError(err error) *Profile {
+	p.Retention = newError(err)
+	return p
+}
+
+// CheckSuccess indicates the last check was successful
+func (p *Profile) CheckSuccess() *Profile {
+	p.Check = newSuccess()
+	return p
+}
+
+// CheckError sets the error of the last check
+func (p *Profile) CheckError(err error) *Profile {
+	p.Check = newError(err)
+	return p
+}
+
+func newSuccess() *CommandStatus {
+	return &CommandStatus{
+		Success: true,
+		Time:    time.Now(),
+	}
+}
+
+func newError(err error) *CommandStatus {
+	return &CommandStatus{
+		Success: false,
+		Time:    time.Now(),
+		Error:   err.Error(),
+	}
+}

status/status.go

@@ -0,0 +1,71 @@
+package status
+
+import (
+	"encoding/json"
+	"os"
+
+	"github.com/spf13/afero"
+)
+
+// Status of last schedule profile
+type Status struct {
+	fs       afero.Fs
+	filename string
+	Profiles map[string]*Profile `json:"profiles"`
+}
+
+// NewStatus returns a new blank status
+func NewStatus(fileName string) *Status {
+	return &Status{
+		fs:       afero.NewOsFs(),
+		filename: fileName,
+		Profiles: make(map[string]*Profile),
+	}
+}
+
+// newAferoStatus returns a new blank status for unit test
+func newAferoStatus(fs afero.Fs, fileName string) *Status {
+	return &Status{
+		fs:       fs,
+		filename: fileName,
+		Profiles: make(map[string]*Profile),
+	}
+}
+
+// Load existing status; does not complain if the file does not exists, or is not readable
+func (s *Status) Load() *Status {
+	// we're not bothered if the status cannot be loaded
+	file, err := s.fs.Open(s.filename)
+	if err != nil {
+		return s
+	}
+	defer file.Close()
+	decoder := json.NewDecoder(file)
+	_ = decoder.Decode(s)
+	return s
+}
+
+// Profile gets the profile from its name (it creates a blank new one if not exists)
+func (s *Status) Profile(name string) *Profile {
+	if profile, ok := s.Profiles[name]; ok {
+		return profile
+	}
+	profile := newProfile()
+	s.Profiles[name] = profile
+	return profile
+}
+
+// Save current status to the file
+func (s *Status) Save() error {
+	file, err := s.fs.OpenFile(s.filename, os.O_CREATE|os.O_WRONLY|os.O_TRUNC, 0644)
+	if err != nil {
+		return err
+	}
+	defer file.Close()
+	encoder := json.NewEncoder(file)
+	err = encoder.Encode(s)
+	if err != nil {
+		return err
+	}
+	return nil
+}