HYPHAby S33D
Documentation › Integrations

Network and security devices (syslog)

The device sends its logs to an agent on your network; the server splits them with the vendor's model and derives attributes shared by every device.

How it works

  1. The device sends its syslog (UDP or TCP) to a HYPHA agent on its network.
  2. The agent receives it, decodes the syslog header and records, from its parsers rule, which parsing model applies (attribute syslog.parser).
  3. The server splits the message with that model: firewall action, addresses and ports, protocol, rule, user, interface, the device's own severity, event type.

Tested on samples, not on the devices. Each model was checked against lines taken from the vendor's public documentation (or, when the vendor publishes none, from a public integration guide or from the documented format), sent over UDP and TCP to a test agent. None of these devices was actually connected. A line the model does not recognise keeps its full text in the message, with no attribute added.

Turn reception on in an agent

Syslog reception is off by default. Add a conf.d/40-syslog.yaml file to the agent that will receive the logs:

syslog:
  enabled: true
  udp: "0.0.0.0:5514"          # address:port; empty = no UDP
  tcp: "0.0.0.0:5514"          # newline-terminated or length-prefixed frames
  allowed_sources: ["192.0.2.0/24"]   # only these senders (empty = all)
  parsers:
    - {match: 192.0.2.1, parser: fortinet}        # sender address
    - {match: 192.0.2.16/29, parser: cisco-asa}   # CIDR network
    - {match: "pfsense*", parser: pfsense}         # pattern on the header's host name
  tags: {site: hq}

Models

DeviceparserFormat receivedSamples used in tests
Fortinet FortiGate (FortiOS)fortinetkey=value (date=… logid=…)vendor: "Sample logs by log type" (FortiOS 7.0) and Fortinet Community
Stormshield SNSstormshieldWELF key=value (id=firewall …)vendor (alarm), FortiSIEM (filter)
pfSensepfsensefilterlog CSVvendor ("Viewing the Firewall Log"); Netgate grammar
OPNsenseopnsensefilterlog CSV (same format)built on the Netgate grammar
Palo Alto Networks (PAN-OS)paloaltoCSV TRAFFIC, THREAT, SYSTEM, CONFIG, GLOBALPROTECTbuilt on the PAN-OS 10.2 field order
Cisco ASA and FTDcisco-asa%ASA-n-nnnnnn: …vendor (Cisco Security Center); message guide templates
SonicWall (SonicOS)sonicwallkey=value (id=firewall … m=… msg=…)FortiSIEM, IBM/Juniper JSA
WatchGuard Fireboxwatchguardmsg_id="…" then Allow or Deny …vendor (Fireware 12.12 log catalog); Graylog
Check PointcheckpointLog Exporter: syslog [key:"value"; …], CEF, LEEFbuilt on the Log Exporter guide format
MikroTik RouterOSmikrotiktopics message (firewall,info input: …)vendor (RouterOS "Log" page)
Ubiquiti UniFi and EdgeOSubiquitikernel logs ([RULE] IN=… SRC=…), UniFi Network CEFGraylog (the vendor's site refuses automated reads)

The kv model (wave 1) remains available for any other device that writes key=value pairs: each key becomes an attribute, without normalisation.

Attributes produced

The same for every model, when the device provides them:

AttributeValues
evt.categorytraffic, threat, vpn, admin, system
evt.namethe vendor's event name (subtype, message number, admin_login…)
evt.outcomesuccess, failure (logins, VPN)
fw.actionallow, deny
fw.rulename or number of the rule, policy or access list
network.source.ip, network.source.portflow source
network.destination.ip, network.destination.portflow destination
network.protocol, network.interface.in, network.interface.outprotocol and interfaces
usr.nameuser or administrator
threat.name, threat.typesignature, virus, threat type
vpn.tunnel, vpn.peer, vpn.statustunnel, remote peer, up or down
device.vendor, device.product, device.name, device.severitydevice and the severity it reports

The vendor's raw fields stay under its prefix (fortinet.*, stormshield.*, filterlog.*, paloalto.*, cisco.asa.*, sonicwall.*, watchguard.*, checkpoint.*, mikrotik.*, ubiquiti.*). network.client.ip remains the address of the sending device.

The line's status is raised, never lowered: threat → warning (error when the device rates it high or critical); failed admin login, VPN failure, tunnel down → warning.

Search examples: source:syslog @fw.action:deny, @evt.category:threat, @evt.category:admin @evt.outcome:failure, @syslog.parser:cisco-asa @vpn.status:down.

Configure sending on the device

Replace 192.0.2.50 with the agent's address and 5514 with its port. Menus change between versions: check your version's documentation.

Ready-made monitors and dashboards

Network and security devices family of the monitor catalogue, each grouped by sending device and optionally restricted to one model (parser variable):

Reception itself has its own: Syslog reception failing, Silent syslog device, Dropped syslog lines.

The dashboard catalogue offers one dashboard per model (Fortinet FortiGate (syslog), Cisco ASA et FTD (syslog)…): lines received per device, dropped lines, then denied traffic, threats, administration, VPN and errors, filterable by agent and by device.

What was tested

On a test machine, an agent received on an unprivileged port, over UDP then TCP, every sample line of the eleven models, each model sent from its own address; the parsed attributes were read back in HYPHA. The sample lines and their sources are in server/tests/test_equipements.py. Not tested: the behaviour of real devices (version-specific formats, missing fields, volumes), and the admin and VPN messages that vendors do not publish as samples (Stormshield, SonicWall, Check Point, UniFi). If a log from your device is not recognised, the line keeps all its text: send us an anonymised sample.

Updated: 20 November 2026