Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cherry-pick #21063 to 7.x: [Filebeat] Add Pensando DFW Module #24045

Merged
merged 1 commit into from
Feb 16, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG-developer.next.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,7 @@ The list below covers the major changes between 7.0.0-rc2 and master only.
- Update Go version to 1.14.7. {pull}20508[20508]
- Add packaging for docker image based on UBI minimal 8. {pull}20576[20576]
- Make the mage binary used by the build process in the docker container to be statically compiled. {pull}20827[20827]
- Add Pensando distributed firewall module. {pull}21063[21063]
- Update ecszap to v0.3.0 for using ECS 1.6.0 in logs {pull}22267[22267]
- Add support for customized monitoring API. {pull}22605[22605]

Expand Down
142 changes: 142 additions & 0 deletions filebeat/docs/fields.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@ grouped in the following categories:
* <<exported-fields-oracle>>
* <<exported-fields-osquery>>
* <<exported-fields-panw>>
* <<exported-fields-pensando>>
* <<exported-fields-postgresql>>
* <<exported-fields-process>>
* <<exported-fields-proofpoint>>
Expand Down Expand Up @@ -105825,6 +105826,147 @@ Specifies the sub type of the log

--

[[exported-fields-pensando]]
== Pensando fields

pensando Module



[float]
=== pensando

Fields from Pensando logs.



[float]
=== dfw

Fields for Pensando DFW



*`pensando.dfw.action`*::
+
--
Action on the flow.


type: keyword

--

*`pensando.dfw.app_id`*::
+
--
Application ID


type: integer

--

*`pensando.dfw.destination_address`*::
+
--
Address of destination.


type: keyword

--

*`pensando.dfw.destination_port`*::
+
--
Port of destination.


type: integer

--

*`pensando.dfw.direction`*::
+
--
Direction of the flow


type: keyword

--

*`pensando.dfw.protocol`*::
+
--
Protocol of the flow


type: keyword

--

*`pensando.dfw.rule_id`*::
+
--
Rule ID that was matched.


type: keyword

--

*`pensando.dfw.session_id`*::
+
--
Session ID of the flow


type: integer

--

*`pensando.dfw.session_state`*::
+
--
Session state of the flow.


type: keyword

--

*`pensando.dfw.source_address`*::
+
--
Source address of the flow.


type: keyword

--

*`pensando.dfw.source_port`*::
+
--
Source port of the flow.


type: integer

--

*`pensando.dfw.timestamp`*::
+
--
Timestamp of the log.


type: date

--

[[exported-fields-postgresql]]
== PostgreSQL fields

Expand Down
Binary file added filebeat/docs/images/filebeat-pensando-dfw.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
69 changes: 69 additions & 0 deletions filebeat/docs/modules/pensando.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
////
This file is generated! See scripts/docs_collector.py
////

[[filebeat-module-pensando]]
:modulename: pensando
:has-dashboards: true

== pensando module

The +{modulename}+ module parses distributed firewall logs created by the
http://pensando.io/[Pensando] distributed services card (DSC).


include::../include/what-happens.asciidoc[]

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

[float]
=== Compatibility

The Pensando module has been tested with 1.12.0-E-54 and later.

include::../include/configuring-intro.asciidoc[]
The following example shows how to set parameters in the +modules.d/{modulename}.yml+
file to listen for firewall logs sent from the Pensando DSC(s) on port 5514 (default is 9001):

["source","yaml",subs="attributes"]
-----
- module: pensando
access:
enabled: true
var.syslog_host: 0.0.0.0
var.syslog_port: [9001]
-----
:fileset_ex: dfw

include::../include/config-option-intro.asciidoc[]

TODO: document the variables from each fileset. If you're describing a variable
that's common to other modules, you can reuse shared descriptions by including
the relevant file. For example:

[float]
==== `dfw` log fileset settings

include::../include/var-paths.asciidoc[]

[float]
=== Example dashboard

This module comes with a sample dashboard. For example:

[role="screenshot"]
image::./images/filebeat-pensando-dfw.png[]

:has-dashboards!:

:fileset_ex!:

:modulename!:


[float]
=== Fields

For a description of each field in the module, see the
<<exported-fields-pensando,exported fields>> section.

2 changes: 2 additions & 0 deletions filebeat/docs/modules_list.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ This file is generated! See scripts/docs_collector.py
* <<filebeat-module-oracle>>
* <<filebeat-module-osquery>>
* <<filebeat-module-panw>>
* <<filebeat-module-pensando>>
* <<filebeat-module-postgresql>>
* <<filebeat-module-proofpoint>>
* <<filebeat-module-rabbitmq>>
Expand Down Expand Up @@ -121,6 +122,7 @@ include::modules/okta.asciidoc[]
include::modules/oracle.asciidoc[]
include::modules/osquery.asciidoc[]
include::modules/panw.asciidoc[]
include::modules/pensando.asciidoc[]
include::modules/postgresql.asciidoc[]
include::modules/proofpoint.asciidoc[]
include::modules/rabbitmq.asciidoc[]
Expand Down
12 changes: 12 additions & 0 deletions filebeat/filebeat.reference.yml
Original file line number Diff line number Diff line change
Expand Up @@ -335,6 +335,18 @@ filebeat.modules:
# of the document. The default is true.
#var.use_namespace: true

#------------------------------- Pensando Module -------------------------------
- module: pensando
# Firewall logs
dfw:
enabled: true
var.syslog_host: 0.0.0.0
var.syslog_port: 9001

# Set custom paths for the log files. If left empty,
# Filebeat will choose the paths depending on your OS.
# var.paths:

#------------------------------ PostgreSQL Module ------------------------------
#- module: postgresql
# Logs
Expand Down
1 change: 1 addition & 0 deletions filebeat/include/list.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

10 changes: 10 additions & 0 deletions filebeat/module/pensando/_meta/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
- module: pensando
# Firewall logs
dfw:
enabled: true
var.syslog_host: 0.0.0.0
var.syslog_port: 9001

# Set custom paths for the log files. If left empty,
# Filebeat will choose the paths depending on your OS.
# var.paths:
56 changes: 56 additions & 0 deletions filebeat/module/pensando/_meta/docs.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
:modulename: pensando
:has-dashboards: true

== pensando module

The +{modulename}+ module parses distributed firewall logs created by the
http://pensando.io/[Pensando] distributed services card (DSC).


include::../include/what-happens.asciidoc[]

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

[float]
=== Compatibility

The Pensando module has been tested with 1.12.0-E-54 and later.

include::../include/configuring-intro.asciidoc[]
The following example shows how to set parameters in the +modules.d/{modulename}.yml+
file to listen for firewall logs sent from the Pensando DSC(s) on port 5514 (default is 9001):

["source","yaml",subs="attributes"]
-----
- module: pensando
access:
enabled: true
var.syslog_host: 0.0.0.0
var.syslog_port: [9001]
-----
:fileset_ex: dfw

include::../include/config-option-intro.asciidoc[]

TODO: document the variables from each fileset. If you're describing a variable
that's common to other modules, you can reuse shared descriptions by including
the relevant file. For example:

[float]
==== `dfw` log fileset settings

include::../include/var-paths.asciidoc[]

[float]
=== Example dashboard

This module comes with a sample dashboard. For example:

[role="screenshot"]
image::./images/filebeat-pensando-dfw.png[]

:has-dashboards!:

:fileset_ex!:

:modulename!:
10 changes: 10 additions & 0 deletions filebeat/module/pensando/_meta/fields.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
- key: pensando
title: Pensando
description: >
pensando Module
fields:
- name: pensando
type: group
description: >
Fields from Pensando logs.
fields:
Loading