rouben / zfswatcher Goto Github PK

View Code? Open in Web Editor NEW

This project forked from damicon/zfswatcher

108.0 15.0 14.0 891 KB

ZFS pool monitoring and notification daemon

License: GNU General Public License v3.0

Makefile 1.62% Shell 3.99% Go 82.58% CSS 0.79% HTML 11.03%

zfs monitoring linux unix solaris bsd gplv3 gpl golang go

zfswatcher's Introduction

zfswatcher

ZFS pool monitoring and notification daemon.

Please see the project web site for general information about features, supported operating environments and to download a tarball or packaged version of this software:

http://zfswatcher.damicon.fi/

Source repository:

https://github.com/damicon/zfswatcher/

Installing and upgrading on Debian/Ubuntu

Download the .deb package and install it with dpkg, for example:

dpkg -i zfswatcher_0.03-1_amd64.deb

The service is started by default according to the Debian and Ubuntu conventions.

Installing and upgrading on RHEL/CentOS/Scientific Linux

Download the .rpm package and install it with yum, for example:

yum install zfswatcher-0.03-1.x86_64.rpm

The service is not started by default according to Red Hat conventions. It can be started as follows:

service zfswatcher start

Installing from source on Linux, FreeBSD and Opensolaris/Illumos

Generally it is best to use the ready made packages on Debian/Ubuntu and RHEL/CentOS/Scientific Linux.

If you are packaging this software yourself or you want to compile from source for other reasons, you can follow these instructions.

Prerequisites

This software is implemented in Go programming language. Further information about installing the Go environment is available at the following URL:

http://golang.org/doc/install

The version 1.0.3 of the Go programming language on a 64 bit platform is recommended.

The software has been developed on Debian 6.0 (squeeze) and Ubuntu 12.04 (precise) but it should work fine on other Linux distributions and also recent FreeBSD versions.

Compiling

Optionally edit the Makefile to set the installation directories. Then run:

make

Installation

make install

Running

There are some OS/distribution specific startup scripts in "etc" subdirectory. They may be useful.

See the installed zfswatcher(8) manual page for information on invoking the zfswatcher process.

Configuration

Edit the configuration file:

editor /etc/zfs/zfswatcher.conf

Verify the configuration syntax:

zfswatcher -t

Restart the process:

service zfswatcher restart

Some notes:

See the configuration file comments for information about the configuration settings.
Enclosure LED management is disabled by default. Currently an external utility ledctl (part of ledmon package) is required for this functionality.
Logging to file /var/log/zfswatcher/zfswatcher.log and local syslog daemon is enabled by default.
E-mail notifications are disabled by default.
The embedded web server is disabled by default.
If you change the default web interface templates, it is best to copy them from /usr/share/zfswatcher/www to another location and change the templatedir and resourcedir settings in the configuration accordingly. This way your local changes will not be overwritten if you upgrade the package at a later time.

Support

If you encounter a bug, please open an issue at the GitHub issue tracker at:

https://github.com/damicon/zfswatcher/issues

Reported bugs are fixed on best effort basis.

Commercial support, custom features, custom licensing and complete storage solutions are available from Damicon Kraa Oy. Contact [email protected].

Contributions

Contributions and suggestions are welcome. Feel free to open an issue or submit a merge request on GitHub.

Authors

Janne Snabb [email protected]

License

Zfswatcher is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

Zfswatcher is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with zfswatcher. If not, see http://www.gnu.org/licenses/.

zfswatcher's People

Contributors

Stargazers

Watchers

Forkers

racefpv der-jan djkazic jsirianni slade8888 janw tonydm rp70 jaustindavid heartshare davewatson91 danoontjes consp preussal

zfswatcher's Issues

zfswatcher does not create directory for logs

Hi, I receive the following notification when I do zfswatcher -t

zfswatcher -t

2019-03-12 23:12:26 [NOTIFIER] error opening log file: open /var/log/zfswatcher/zfswatcher.log: no such file or directory

If you create the directory manually and restart it logs to the file.

OS is Debian 9.7

dpkg fails under Ubuntu 18.04 LTS

Attempting to install zfswatcher_0.03-2_amd64.deb package on Ubuntu 18.04 fails with the following error:

Selecting previously unselected package zfswatcher.
(Reading database ... 147733 files and directories currently installed.)
Preparing to unpack zfswatcher_0.03-2_amd64.deb ...
Unpacking zfswatcher (0.03-2) ...
dpkg: dependency problems prevent configuration of zfswatcher:
 zfswatcher depends on zfs | ubuntu-zfs | debian-zfs; however:
  Package zfs is not installed.
  Package ubuntu-zfs is not installed.
  Package debian-zfs is not installed.

dpkg: error processing package zfswatcher (--install):
 dependency problems - leaving unconfigured
Processing triggers for man-db (2.8.3-2ubuntu0.1) ...
Processing triggers for ureadahead (0.100.0-21) ...
ureadahead will be reprofiled on next reboot
Processing triggers for systemd (237-3ubuntu10.21) ...
Errors were encountered while processing:
 zfswatcher

Attempting to install from source results in similar error.

Support for SSMTP or GMAIL SMTP

Hi, I have ssmtp setup across my systems as I do not require mail servers etc. Does zfswatcher support gmail smtp? Or can it be edited to use /usr/bin/mail?

bar graph of storage usage doesn't show

according to the html, the value of div.bar and div.bar.bar-success is missing definitions of height: and background-colour:

I was able to fix by manually editing the dashboard.html template and specifying values in CSS.

zpool checkpoint results in error

When using zpool checkpoint an error is displayed on the console every few seconds:

2021 Jun 8 08:10:01 servername invalid line 3 in status output: checkpoint: created Tue Jun 8 08:08:45 2021, consumes 468K
2021 Jun 8 08:10:01 servername parsing ZFS status failed

I have to shut down zfswatcher to have it stop spamming the console.

Ubuntu 18 LTS zfs config

After following https://github.com/zfsonlinux/zfs/wiki/Ubuntu-18.04-Root-on-ZFS to install zfs and then went to install zfswatcher with the provided .deb file i get this issue

Selecting previously unselected package zfswatcher.
(Reading database ... 141612 files and directories currently installed.)
Preparing to unpack zfswatcher_0.03-2_amd64.deb ...
Unpacking zfswatcher (0.03-2) ...
dpkg: dependency problems prevent configuration of zfswatcher:
 zfswatcher depends on zfs | ubuntu-zfs | debian-zfs; however:
  Package zfs is not installed.
  Package ubuntu-zfs is not installed.
  Package debian-zfs is not installed.

dpkg: error processing package zfswatcher (--install):
 dependency problems - leaving unconfigured

FreeBSD Support

Hi,

is there something specific that prevents you from supporting the FreeBSD system also?

Thanks,
vermaden

Is there a way to exclude/blacklist devices from ledctl processing?

Hello,
Is there a way to exclude/blacklist devices from ledctl processing?
I am encountering an issue with the zfswatcher initialisation, while having SSDs which are not located in the enclosures bays.

zfswatcher-ledctl: /dev/disk/by-id/ata-KINGSTON_SA400S37960G_50026B778547162D: device not supported
zfswatcher-ledctl: /dev/disk/by-id/ata-KINGSTON_SA400S37960G_50026B77854715F2: device not supported
zfswatcher-ledctl: /dev/disk/by-id/ata-KINGSTON_SA400S37960G_50026B77854737B7: device not supported
zfswatcher-ledctl: /dev/disk/by-id/ata-KINGSTON_SA400S37960G_50026B778547360A: device not supported
zfswatcher-ledctl: /dev/disk/by-id/ata-ADATA_SU650_2N20291ASKP2: device not supported
zfswatcher-ledctl: /dev/disk/by-id/ata-ADATA_SU650_2N202911S8CA: device not supported
zfswatcher-ledctl: /dev/disk/by-id/ata-KINGSTON_SA400S37960G_50026B778547352B: device not supported
zfswatcher-ledctl: /dev/disk/by-id/ata-KINGSTON_SA400S37960G_50026B778547137C: device not supported

Thank you for your good work!

Proxmox support

The installer won't work under Proxmox, where ZFS is native installed.

Also a question here, it's possible to connect multiple hosts to one cloud instance?
Like Netdata, but netdata never integrated zfs pool notifications, so we're looking for another solution.

Under Proxmox we're running into this issues:

DansHomeServer# dpkg -i zfswatcher_0.4.6-1_amd64.deb
Selecting previously unselected package zfswatcher.
(Reading database ... 145795 files and directories currently installed.)
Preparing to unpack zfswatcher_0.4.6-1_amd64.deb ...
Unpacking zfswatcher (0.4.6-1) ...
dpkg: dependency problems prevent configuration of zfswatcher:
zfswatcher depends on zfs | ubuntu-zfs | debian-zfs | zfs-dkms; however:
Package zfs is not installed.
Package ubuntu-zfs is not installed.
Package debian-zfs is not installed.
Package zfs-dkms is not installed.

dpkg: error processing package zfswatcher (--install):
dependency problems - leaving unconfigured
Processing triggers for systemd (241-7~deb10u4) ...
Processing triggers for man-db (2.8.5-2) ...
Errors were encountered while processing:
zfswatcher

draid support?

Hi there
I am just testing zfswatcher, and right away I get an issue, maybe because I use a draid pool and maybe because right now it is resilvering...
Platform:
Ubuntu 22.04
zfs-2.1.5-1ubuntu6~22.04.1
zfs-kmod-2.1.5-1ubuntu6

I see this error in the syslog:
Jul 26 16:18:05 box zfswatcher[1013799]: invalid line 7 in status output: scan: resilver (draid3:19d:24c:2s-0) in progress since Mon Jul 24 19:40:55 2023

Here is a view of my pool:
`root@box:~# zpool status aggr0
pool: aggr0
state: DEGRADED
status: One or more devices is currently being resilvered. The pool will
continue to function, possibly in a degraded state.
action: Wait for the resilver to complete.
scan: scrub repaired 0B in 2 days 10:05:20 with 0 errors on Tue Jul 11 10:29:22 2023
scan: resilver (draid3:19d:24c:2s-0) in progress since Mon Jul 24 19:40:55 2023
334T scanned at 2.13G/s, 306T issued 1.95G/s, 359T total
13.9T resilvered, 92.97% done, 03:22:35 to go
config:

NAME                   STATE     READ WRITE CKSUM
aggr0                  DEGRADED     0     0     0
  draid3:19d:24c:2s-0  DEGRADED     0     0     0
    0a-0               ONLINE       0     0     0  (resilvering)
    0a-1               ONLINE       0     0     0  (resilvering)
    0a-2               ONLINE       0     0     0  (resilvering)
    0a-3               ONLINE       0     0     0  (resilvering)
    0a-4               ONLINE       0     0     0  (resilvering)
    0a-5               ONLINE       0     0     0  (resilvering)
    0a-6               ONLINE       0     0     0  (resilvering)
    0a-7               ONLINE       0     0     0  (resilvering)
    0a-8               ONLINE       0     0     0  (resilvering)
    0a-9               ONLINE       0     0     0  (resilvering)
    0a-10              ONLINE       0     0     0  (resilvering)
    0a-11              ONLINE       0     0     0  (resilvering)
    spare-12           DEGRADED     0     0     0
      0a-12            UNAVAIL      3     4     0
      draid3-0-0       ONLINE       0     0     0  (resilvering)
    0a-13              ONLINE       0     0     0  (resilvering)
    0a-14              ONLINE       0     0     0  (resilvering)
    0a-15              ONLINE       0     0     0  (resilvering)
    0a-16              ONLINE       0     0     0  (resilvering)
    0a-17              ONLINE       0     0     0  (resilvering)
    0a-18              ONLINE       0     0     0  (resilvering)
    0a-19              ONLINE       0     0     0  (resilvering)
    0a-20              ONLINE       0     0     0  (resilvering)
    0a-21              ONLINE       0     0     0  (resilvering)
    0a-22              ONLINE       0     0     0  (resilvering)
    0a-23              ONLINE       0     0     0  (resilvering)
special
  mirror-1             ONLINE       0     0     0
    nvme01-part1       ONLINE       0     0     0
    nvme02-part1       ONLINE       0     0     0
cache
  sdc1                 ONLINE       0     0     0
  sdd1                 ONLINE       0     0     0
spares
  draid3-0-0           INUSE     currently in use
  draid3-0-1           AVAIL`

The 0a-xx device names are done using the vdev_id.conf file, maybe that can also cause issues?
I'm using a NetApp disk shelf and the numbers match the location in the disk shelf which is nice :-)

`multipath no
topology sas_direct
phys_per_port 4
slot bay
enclosure_symlinks yes

channel 02:00.0 2 0a-
channel 02:00.0 3 0b-
alias nvme01 /dev/disk/by-id/nvme-Seagate_FireCuda_530_ZP2000GM30013_7VR025QC
alias nvme02 /dev/disk/by-id/nvme-Seagate_FireCuda_530_ZP2000GM30013_7VR025Z6`

Option to disable authentication?

Anyway to disable the authentication?
This project does not have any possible actions that mess the ZFS
it's only for showing information. I don't see why there "must" be authentication rather than being optional.
Tried to remove the user from the config. Didn't work.