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

Disable host.* fields by default for Cisco module #18753

Merged
merged 2 commits into from
Jun 1, 2020
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
16 changes: 10 additions & 6 deletions CHANGELOG.next.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -23,16 +23,20 @@ https://github.com/elastic/beats/compare/v7.0.0-alpha2...master[Check the HEAD d
- File integrity dataset (macOS): Replace unnecessary `file.origin.raw` (type keyword) with `file.origin.text` (type `text`). {issue}12423[12423] {pull}15630[15630]

*Filebeat*

- Improve ECS field mappings in panw module. event.outcome now only contains success/failure per ECS specification. {issue}16025[16025] {pull}17910[17910]
- Improve ECS categorization field mappings for nginx module. http.request.referrer is now lowercase & http.request.referrer only populated when nginx sets a value {issue}16174[16174] {pull}17844[17844]
- Improve ECS field mappings in santa module. move hash.sha256 to process.hash.sha256 & move certificate fields to santa.certificate . {issue}16180[16180] {pull}17982[17982]
- With the default configuration the cloud modules (aws, azure, googlecloud, o365, okta)
will no longer send the `host` field that contains information about the host Filebeat is
running on. This is because the `host` field specifies the host on which the event
happened. {issue}13920[13920] {pull}18223[18223]
- With the default configuration the cef and panw modules will no longer send the `host`
field. You can revert this change by configuring tags for the module and omitting
`forwarded` from the list. {issue}13920[13920] {pull}18223[18223]
will no longer send the `host` field that contains information about the host Filebeat is
running on. This is because the `host` field specifies the host on which the event
happened. {issue}13920[13920] {pull}18223[18223]
- With the default configuration the following modules will no longer send the `host`
field. You can revert this change by configuring tags for the module and omitting
`forwarded` from the list. {issue}13920[13920]
* CEF {pull}18223[18223]
* PANW {pull}18223[18223]
* Cisco {pull}18753[18753]

*Heartbeat*

Expand Down
24 changes: 21 additions & 3 deletions filebeat/docs/modules/cisco.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,12 @@ Set to 0.0.0.0 to bind to all available interfaces.

The UDP port to listen for syslog traffic. Defaults to 9001.

*`var.tags`*::

A list of tags to include in events. Including `forwarded` indicates that the
events did not originate on this host and causes `host.name` to not be added to
events. Defaults to `[cisco-asa, forwarded]`.

:has-dashboards!:

:fileset_ex!:
Expand Down Expand Up @@ -244,6 +250,12 @@ Set to 0.0.0.0 to bind to all available interfaces.

The UDP port to listen for syslog traffic. Defaults to 9003.

*`var.tags`*::

A list of tags to include in events. Including `forwarded` indicates that the
events did not originate on this host and causes `host.name` to not be added to
events. Defaults to `[cisco-ftd, forwarded]`.

:has-dashboards!:

:fileset_ex!:
Expand Down Expand Up @@ -275,6 +287,12 @@ Set to 0.0.0.0 to bind to all available interfaces.

The UDP port to listen for syslog traffic. Defaults to 9002.

*`var.tags`*::

A list of tags to include in events. Including `forwarded` indicates that the
events did not originate on this host and causes `host.name` to not be added to
events. Defaults to `[cisco-ios, forwarded]`.

include::../include/timezone-support.asciidoc[]

:has-dashboards!:
Expand All @@ -285,10 +303,10 @@ include::../include/timezone-support.asciidoc[]
[[dynamic-script-compilations]]
=== Dynamic Script Compilations

The `asa` and `ftd` filesets are based on Elasticsearch ingest pipelines and
make extensive use of script processors and painless conditions. This can cause
The `asa` and `ftd` filesets are based on Elasticsearch ingest pipelines and
make extensive use of script processors and painless conditions. This can cause
the pipelines to fail loading the first time the module is used, due to exceeding
the maximum script compilation limits. It is recommended to tune the following
the maximum script compilation limits. It is recommended to tune the following
parameters on your Elasticsearch cluster:

- {ref}/circuit-breaker.html#script-compilation-circuit-breaker[script.max_compilations_rate]:
Expand Down
24 changes: 21 additions & 3 deletions x-pack/filebeat/module/cisco/_meta/docs.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,12 @@ Set to 0.0.0.0 to bind to all available interfaces.

The UDP port to listen for syslog traffic. Defaults to 9001.

*`var.tags`*::

A list of tags to include in events. Including `forwarded` indicates that the
events did not originate on this host and causes `host.name` to not be added to
events. Defaults to `[cisco-asa, forwarded]`.

:has-dashboards!:

:fileset_ex!:
Expand Down Expand Up @@ -239,6 +245,12 @@ Set to 0.0.0.0 to bind to all available interfaces.

The UDP port to listen for syslog traffic. Defaults to 9003.

*`var.tags`*::

A list of tags to include in events. Including `forwarded` indicates that the
events did not originate on this host and causes `host.name` to not be added to
events. Defaults to `[cisco-ftd, forwarded]`.

:has-dashboards!:

:fileset_ex!:
Expand Down Expand Up @@ -270,6 +282,12 @@ Set to 0.0.0.0 to bind to all available interfaces.

The UDP port to listen for syslog traffic. Defaults to 9002.

*`var.tags`*::

A list of tags to include in events. Including `forwarded` indicates that the
events did not originate on this host and causes `host.name` to not be added to
events. Defaults to `[cisco-ios, forwarded]`.

include::../include/timezone-support.asciidoc[]

:has-dashboards!:
Expand All @@ -280,10 +298,10 @@ include::../include/timezone-support.asciidoc[]
[[dynamic-script-compilations]]
=== Dynamic Script Compilations

The `asa` and `ftd` filesets are based on Elasticsearch ingest pipelines and
make extensive use of script processors and painless conditions. This can cause
The `asa` and `ftd` filesets are based on Elasticsearch ingest pipelines and
make extensive use of script processors and painless conditions. This can cause
the pipelines to fail loading the first time the module is used, due to exceeding
the maximum script compilation limits. It is recommended to tune the following
the maximum script compilation limits. It is recommended to tune the following
parameters on your Elasticsearch cluster:

- {ref}/circuit-breaker.html#script-compilation-circuit-breaker[script.max_compilations_rate]:
Expand Down
3 changes: 2 additions & 1 deletion x-pack/filebeat/module/cisco/asa/config/input.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@ exclude_files: [".gz$"]

{{ end }}

tags: {{.tags}}
tags: {{.tags | tojson}}
publisher_pipeline.disable_host: {{ inList .tags "forwarded" }}

processors:
- add_locale: ~
2 changes: 1 addition & 1 deletion x-pack/filebeat/module/cisco/asa/manifest.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ var:
default:
- /var/log/cisco-asa.log
- name: tags
default: [cisco-asa]
default: [cisco-asa, forwarded]
- name: syslog_host
default: localhost
- name: syslog_port
Expand Down
15 changes: 10 additions & 5 deletions x-pack/filebeat/module/cisco/asa/test/asa-fix.log-expected.json
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,8 @@
"source.ip": "10.123.123.123",
"source.port": 53723,
"tags": [
"cisco-asa"
"cisco-asa",
"forwarded"
]
},
{
Expand Down Expand Up @@ -60,7 +61,8 @@
"source.address": "10.123.123.123",
"source.ip": "10.123.123.123",
"tags": [
"cisco-asa"
"cisco-asa",
"forwarded"
]
},
{
Expand Down Expand Up @@ -90,7 +92,8 @@
"source.ip": "10.123.123.123",
"source.port": 6316,
"tags": [
"cisco-asa"
"cisco-asa",
"forwarded"
]
},
{
Expand Down Expand Up @@ -122,7 +125,8 @@
"source.ip": "10.123.123.123",
"source.port": 57621,
"tags": [
"cisco-asa"
"cisco-asa",
"forwarded"
]
},
{
Expand All @@ -146,7 +150,8 @@
"source.address": "10.123.123.123",
"source.ip": "10.123.123.123",
"tags": [
"cisco-asa"
"cisco-asa",
"forwarded"
]
}
]
Loading