Files
weewx/docs_src/usersguide/monitoring.md

4.4 KiB

Monitoring WeeWX

Whether you run weewxd directly or in the background, weewxd emits messages about its status and generates reports. The status messages will help you diagnose problems.

Status

If WeeWX is running in the background, you can use the system's init tools to check the status. For example, on systems that use systemd, check it like this:

systemctl status weewx

On systems that use sysV init scripts, check it like this:

/etc/init.d/weewx status

Reports

When it is running properly, WeeWX will generate reports, typically every five minutes. The reports are not (re)generated until data have been received and accumulated, so it could be a few minutes before you see a report or a change to a report. The location of the reports depends on the operating system and how WeeWX was installed.

See HTML_ROOT in the Where to find things section.

Depending on the configuration, if WeeWX cannot get data from the sensors, then it will probably not generate any reports. So if you do not see reports, check the log!

Log messages

In the default configuration, WeeWX logs to the system logging facility.

The following sections show how to view WeeWX log messages on systems that use syslog and systemd-journald logging facilities. See the wiki article How to view the log for more details.

See the wiki article How to configure logging for information and examples about how to configure WeeWX logging.

The syslog logging facility

On traditional systems, the system logging facility puts the WeeWX messages into a file, along with other messages from the system. The location of the system log file varies, but it is typically /var/log/syslog or /var/log/messages.

You can view the messages using standard tools such as tail, head, more, less, and grep, although the use of sudo may be necessary (the system logs on most modern systems are readable only to administrative users).

For example, to see only the messages from weewxd:

sudo grep weewxd /var/log/syslog

To see only the latest 40 messages from weewxd:

sudo grep weewxd /var/log/syslog | tail -40

To see messages as they come into the log in real time (hit ctrl-c to stop):

sudo tail -f /var/log/syslog

The systemd-journald logging facility

Some systems with systemd use only systemd-journald as the system logging facility. On these systems, you will have to use the tool journalctl to view messages from WeeWX. In what follows, depending on your system, you may or may not need sudo.

For example, to see only the messages from weewxd:

sudo journalctl -u weewx

To see only the latest 40 messages from weewxd:

sudo journalctl -u weewx --lines 40

To see messages as they come into the log in real time:

sudo journalctl -u weewx -f

Logging on macOS

Unfortunately, with the introduction of macOS Monterey (12.x), the logging handler SysLogHandler, which is used by WeeWX, does not work1 . Indeed, the only handlers in the Python logging facility that work with macOS 12.x or later are standalone handlers that log to files.

Fortunately, there is a simple workaround. Put this at the bottom of your weewx.conf configuration file:

[Logging]

    [[root]]
        handlers = timed_rotate,

    [[handlers]]
        # Log to a set of rotating files
        [[[timed_rotate]]]
            level = DEBUG
            formatter = verbose
            class = logging.handlers.TimedRotatingFileHandler
            # File to log to, relative to WEEWX_ROOT:
            filename = log/{process_name}.log
            # When to rotate:
            when = midnight
            # How many log files to save
            backupCount = 7

This reconfigures the root logger to send log messages to the file ~/weewx-data/log/weewxd.log instead of the system logger.

For an explanation of what all these lines mean, see the wiki article on WeeWX logging.


  1. See Python issue #91070. ↩︎