netwatchdog

README

netwatchdog

netwatchdog is a library designed to help creating watchdogs, that monitor network access, network folder mountings, and similar conditions, to help headless devices stay connected and available.

Goals / TODO

It needs to loops through a set of checks and attempt to remediate any given faults, as well as make debugging faults that may not be remediated by the software easier.

monitoring loop

• check the interfaces
• check network access
• check the defined fstab mounts

check the interfaces

if interface exactly one interface should have an ip of 172.x.x.x or 192.x.x.x if neither one has, attempt to reconnect to wifi if both has, disconnect wifi in both cases log the change between the previous checks interface config and the new one

check network access

check network access by pinging the main server or the gateway if the interface is still online but network is not available attempt to remediate by reconnecting network (after waiting a configured minutes)

check the defined fstab mounts

check each folder mount compare mount output with fstab? check if the folder actually exists/writable? if missing try to remount

modularity

define a way to add checks to the loops provide an interface for these checks each check needs to have a descriptive name, a function for the check, and a remediation process, as well as a fatality of the check (whether or not the os needs to be rebooted if the remediation steps fail to correct the state of the checked object).

CLI

The Service needs to be interactable through a set of cli commands

Example of how it should be usable by a user

package main

import (
	"nwdtest/vendor/netwatchdog"
)

func main() {
	var nwd netwatchdog.NwdCore
	Interface := InterfaceCheck{
		Interface: "eth0",
		Priority: 0,
	}
	Net := NetworkCheck{
		Subnet: "192.168.100.0/24",
		Ping: "8.8.8.8",
		Priority: 1,
	}
	SMB := SMBCheck{
		Share: "//mnt/fileserver",
	  //Share: "/mnt/fileserver"
	  //Share: "auto"
		Priority: 2,
	}
	nwd.AddCheck(&Interface,30*time.Second,"eth0 NIC",3)
	nwd.AddCheck(&Net,30*time.Second,"IPCheck",2)
	nwd.AddCheck(&SMB,30*time.Second,"SMB",1)
	nwd.Start()

}

Documentation

Overview

Copyright © 2024 Alex Bedo <alex98hun@gmail.com>

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.