Aller au contenu

La version 0.1.0 est une première version, à l'essai. Voir ce qui n'est pas prouvé →

bogolang
EN

← Exemples

syslog_listener

Écoute le syslog de deux équipements avec on syslog, compte les événements et affiche les plus graves.

Ce programme écoute les messages syslog de deux équipements. Un bloc on syslog dans le corps de la classe compte chaque événement par équipement et par gravité, et affiche les événements de gravité 3 (erreur) ou pire. À la fin, le programme affiche ce que l'écouteur a reçu et les comptes.

Exécutez-le depuis ce dossier, sur les événements enregistrés dans saved :

bogo run --replay saved syslog_listener.bogo
bogo test syslog_listener.bogo

Avec --replay saved, aucun port n'est ouvert. Les événements sont lus dans saved/listen/syslog.txt, et listen() rend la main quand ils sont tous traités. Un événement enregistré vient d'un expéditeur qui n'est pas dans devices, donc il est compté comme « from other senders » et n'est pas traité. Les événements ont été écrits à la main, et les noms et les adresses sont inventés.

Pour l'utiliser sur votre propre réseau, mettez vos équipements dans devices et dirigez leur syslog vers cet ordinateur, port UDP 5514. Sans --replay, le programme ouvre vraiment le port UDP 5514 sur chaque adresse de l'ordinateur et écoute pendant une minute (listen(1min)). Le pare-feu de l'ordinateur doit laisser entrer les paquets. Le port 514, le port syslog habituel, demande un administrateur sur la plupart des systèmes.

syslog_listener.bogo
edition 2027
"""Listen for syslog from two devices, count the events and print the serious ones."""


class SyslogListener:
    """Counts the syslog events of each device by severity.

    The `on syslog` block stands in the class body. Its listener opens when the class
    is read, before main runs. Packets from a sender not in `devices` are not handled.
    """

    devices = [
        Device(name="core-sw1", ip=192.0.2.1, platform="iosxe"),
        Device(name="edge-rt2", ip=192.0.2.2, platform="iosxe"),
    ]
    serious = 3  # severity 0 to 3: emergency, alert, critical, error
    counts: dict[str, int] = {}

    on syslog port 5514 from devices as e:
        SyslogListener.tally(SyslogListener.counts, e.device, e.severity)
        if SyslogListener.is_serious(e.severity):
            print(f"{e.received}  {e.device:9} {e.code}: {e.message}")

    @staticmethod
    def is_serious(severity: int) -> bool:
        return severity <= SyslogListener.serious

    @staticmethod
    def tally(counts: dict[str, int], device: str, severity: int) -> None:
        key = f"{device} severity {severity}"
        counts[key] = counts.get(key, 0) + 1

    @staticmethod
    def main(args: list[str]) -> None:
        print("Serious events as they arrive:")
        for c in listen(1min):
            print()
            print(
                f"{c.received} received, {c.handled} handled, {c.not_from} from other senders, "
                f"{c.unreadable} unreadable"
            )
        print()
        for key, n in sorted(SyslogListener.counts.items()):
            print(f"{n:4}  {key}")


class TestSyslogListener:
    def test_serious_is_error_or_worse(self) -> None:
        assert SyslogListener.is_serious(0)
        assert SyslogListener.is_serious(3)
        assert not SyslogListener.is_serious(5)

    def test_tally_counts_per_device_and_severity(self) -> None:
        counts: dict[str, int] = {}
        SyslogListener.tally(counts, "core-sw1", 3)
        SyslogListener.tally(counts, "core-sw1", 3)
        SyslogListener.tally(counts, "edge-rt2", 5)
        assert counts == {"core-sw1 severity 3": 2, "edge-rt2 severity 5": 1}