Skip to content

Commit

Permalink
Fix syslog RFC 5424 parsing in CheckPoint module
Browse files Browse the repository at this point in the history
Change the input type in the CheckPoint module to `udp` from `syslog`
so the syslog parsing happens in the ingest node pipeline rather than
in the Filebeat syslog input that only support RFC 3164.
  • Loading branch information
andrewkroh committed Oct 15, 2020
1 parent ac00dd2 commit cc73439
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 19 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.next.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -284,6 +284,7 @@ https://github.com/elastic/beats/compare/v7.0.0-alpha2...master[Check the HEAD d
- Provide backwards compatibility for the `append` processor when Elasticsearch is less than 7.10.0. {pull}21159[21159]
- Fix checkpoint module when logs contain time field. {pull}20567[20567]
- Add field limit check for AWS Cloudtrail flattened fields. {pull}21388[21388] {issue}21382[21382]
- Fix syslog RFC 5424 parsing in the CheckPoint module. {pull}21854[21854]

*Heartbeat*

Expand Down
18 changes: 10 additions & 8 deletions filebeat/docs/modules/checkpoint.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,25 +12,27 @@ This file is generated! See scripts/docs_collector.py
== Check Point module
beta[]

This is a module for Check Point firewall logs. It supports logs from the Log Exporter in the Syslog format.
This is a module for Check Point firewall logs. It supports logs from the Log
Exporter in the Syslog RFC 5424 format. If you need to ingest Check Point logs
in CEF format then please use the <<filebeat-module-cef, `CEF module`>> (more
fields are provided in the syslog output).

To configure a Log Exporter, please refer to the documentation by https://supportcenter.checkpoint.com/supportcenter/portal?eventSubmit_doGoviewsolutiondetails=&solutionid=sk122323[Check Point].
To configure a Log Exporter, please refer to the documentation by
https://supportcenter.checkpoint.com/supportcenter/portal?eventSubmit_doGoviewsolutiondetails=&solutionid=sk122323[Check
Point].

Example below:
Example Log Exporter config:

`cp_log_export add name testdestination target-server 192.168.1.1 target-port 9001 protocol udp format syslog`

The module that supports Check Point firewall logs sent in the CEF format requires the <<filebeat-module-cef, `CEF module`>>

The Check Point and ECS fields that are the same between both modules will be mapped to the same names for compability between modules, though not all fields are included in CEF. Please reference the supported fields in the CEF documentation.

include::../include/gs-link.asciidoc[]


[float]
=== Compatibility

This module has been tested against Check Point Log Exporter on R80.X but should also work with R77.30.
This module has been tested against Check Point Log Exporter on R80.X but should
also work with R77.30.

include::../include/configuring-intro.asciidoc[]

Expand Down
18 changes: 10 additions & 8 deletions x-pack/filebeat/module/checkpoint/_meta/docs.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,25 +7,27 @@
== Check Point module
beta[]

This is a module for Check Point firewall logs. It supports logs from the Log Exporter in the Syslog format.
This is a module for Check Point firewall logs. It supports logs from the Log
Exporter in the Syslog RFC 5424 format. If you need to ingest Check Point logs
in CEF format then please use the <<filebeat-module-cef, `CEF module`>> (more
fields are provided in the syslog output).

To configure a Log Exporter, please refer to the documentation by https://supportcenter.checkpoint.com/supportcenter/portal?eventSubmit_doGoviewsolutiondetails=&solutionid=sk122323[Check Point].
To configure a Log Exporter, please refer to the documentation by
https://supportcenter.checkpoint.com/supportcenter/portal?eventSubmit_doGoviewsolutiondetails=&solutionid=sk122323[Check
Point].

Example below:
Example Log Exporter config:

`cp_log_export add name testdestination target-server 192.168.1.1 target-port 9001 protocol udp format syslog`

The module that supports Check Point firewall logs sent in the CEF format requires the <<filebeat-module-cef, `CEF module`>>

The Check Point and ECS fields that are the same between both modules will be mapped to the same names for compability between modules, though not all fields are included in CEF. Please reference the supported fields in the CEF documentation.

include::../include/gs-link.asciidoc[]


[float]
=== Compatibility

This module has been tested against Check Point Log Exporter on R80.X but should also work with R77.30.
This module has been tested against Check Point Log Exporter on R80.X but should
also work with R77.30.

include::../include/configuring-intro.asciidoc[]

Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
{{ if eq .input "syslog" }}

type: syslog
protocol.udp:
host: "{{.syslog_host}}:{{.syslog_port}}"
type: udp
host: "{{.syslog_host}}:{{.syslog_port}}"

{{ else if eq .input "file" }}

Expand Down

0 comments on commit cc73439

Please sign in to comment.