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 #14789 to 7.x: Cisco: Add warning about script compilations to docs #15628

Merged
merged 1 commit into from
Jan 17, 2020
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
27 changes: 27 additions & 0 deletions filebeat/docs/modules/cisco.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,17 @@ Cisco ASA devices also support exporting flow records using NetFlow, which is
supported by the {filebeat-ref}/filebeat-module-netflow.html[netflow module] in
{beatname_uc}.

[WARNING]
=======================================
Some filesets in this module make extensive use of ingest pipeline scripts.
This can cause their ingest pipelines to fail loading due to exceeding the
default compilation limits:

`[script] Too many dynamic script compilations within, max: [75/5m]`

Check the <<dynamic-script-compilations>> section for more information.
=======================================

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

include::../include/running-modules.asciidoc[]
Expand Down Expand Up @@ -280,6 +291,22 @@ include::../include/timezone-support.asciidoc[]

:fileset_ex!:

[float]
[[dynamic-script-compilations]]
=== Dynamic Script Compilations

The `asa` and `ftd` filesets are based on 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 parameters
on your cluster:

- {ref}/circuit-breaker.html#script-compilation-circuit-breaker[script.max_compilations_rate]:
Increase to at least `100/5m`.

- {ref}/modules-scripting-using.html#modules-scripting-using-caching[script.cache_max_size]:
Increase to at least `200` if using both filesets or other script-heavy modules.

:modulename!:


Expand Down
27 changes: 27 additions & 0 deletions x-pack/filebeat/module/cisco/_meta/docs.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,17 @@ Cisco ASA devices also support exporting flow records using NetFlow, which is
supported by the {filebeat-ref}/filebeat-module-netflow.html[netflow module] in
{beatname_uc}.

[WARNING]
=======================================
Some filesets in this module make extensive use of ingest pipeline scripts.
This can cause their ingest pipelines to fail loading due to exceeding the
default compilation limits:

`[script] Too many dynamic script compilations within, max: [75/5m]`

Check the <<dynamic-script-compilations>> section for more information.
=======================================

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

include::../include/running-modules.asciidoc[]
Expand Down Expand Up @@ -275,4 +286,20 @@ include::../include/timezone-support.asciidoc[]

:fileset_ex!:

[float]
[[dynamic-script-compilations]]
=== Dynamic Script Compilations

The `asa` and `ftd` filesets are based on 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 parameters
on your cluster:

- {ref}/circuit-breaker.html#script-compilation-circuit-breaker[script.max_compilations_rate]:
Increase to at least `100/5m`.

- {ref}/modules-scripting-using.html#modules-scripting-using-caching[script.cache_max_size]:
Increase to at least `200` if using both filesets or other script-heavy modules.

:modulename!: