Skip to content

Commit 52e3b82

Browse files
committed
Doc:Highlight difference between static and streaming filter
1 parent 14410ed commit 52e3b82

File tree

3 files changed

+32
-8
lines changed

3 files changed

+32
-8
lines changed

docs/filter-jdbc_static.asciidoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,10 @@ This filter enriches events with data pre-loaded from a remote database.
2626
This filter is best suited for enriching events with reference data that is
2727
static or does not change very often, such as environments, users, and products.
2828

29+
TIP: If you need to process dynamic data, consider using the
30+
{logstash-ref}/plugins-filters-jdbc_streaming.html[JDBC streaming filter plugin]
31+
instead.
32+
2933
This filter works by fetching data from a remote database, caching it in a
3034
local, in-memory https://db.apache.org/derby/manuals/#docs_10.14[Apache Derby]
3135
database, and using lookups to enrich events with data cached in the local

docs/filter-jdbc_streaming.asciidoc

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,13 @@ include::{include_path}/plugin_header-integration.asciidoc[]
2121

2222
==== Description
2323

24-
This filter executes a SQL query and store the result set in the field
24+
//We could use a better general, introductory description here.
25+
26+
TIP: If you need to process static data or that doesn't change often,
27+
consider using the {logstash-ref}/plugins-filters-jdbc_static.html[JDBC static
28+
filter plugin] instead.
29+
30+
This filter executes a SQL query and stores the result set in the field
2531
specified as `target`.
2632
It will cache the results locally in an LRU cache with expiry.
2733

@@ -46,7 +52,7 @@ filter {
4652
[id="plugins-{type}s-{plugin}-prepared_statements"]
4753
==== Prepared Statements
4854

49-
Using server side prepared statements can speed up execution times as the server optimises the query plan and execution.
55+
Using server side prepared statements can speed up execution times as the server optimizes the query plan and execution.
5056

5157
NOTE: Not all JDBC accessible technologies will support prepared statements.
5258

docs/index.asciidoc

Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,18 +15,32 @@ END - GENERATED VARIABLES, DO NOT EDIT!
1515

1616
[id="plugins-{type}s-{plugin}"]
1717

18-
=== JDBC Integration Plugin
18+
=== JDBC integration plugin
1919

2020
include::{include_path}/plugin_header.asciidoc[]
2121

2222
==== Description
2323

24-
The JDBC Integration Plugin provides integrated plugins for working with databases that provide JDBC drivers:
24+
The JDBC Integration Plugin provides integrated plugins for working with
25+
databases that provide JDBC drivers:
2526

26-
- {logstash-ref}/plugins-inputs-jdbc.html[JDBC Input Plugin]
27-
- {logstash-ref}/plugins-filters-jdbc_static.html[JDBC Static Filter Plugin]
28-
- {logstash-ref}/plugins-filters-jdbc_streaming.html[JDBC Streaming Filter Plugin]
27+
- {logstash-ref}/plugins-inputs-jdbc.html[JDBC input plugin]
28+
- {logstash-ref}/plugins-filters-jdbc_static.html[JDBC static filter plugin]
29+
- {logstash-ref}/plugins-filters-jdbc_streaming.html[JDBC streaming filter plugin]
2930

30-
:no_codec!:
31+
[id="plugins-{type}s-{plugin}-static_or_streaming"]
32+
===== JDBC static or JDBC streaming?
33+
34+
The JDBC integration plugin offers two JDBC filtering options--JDBC static and
35+
JDBC streaming. Use the one that best fits your use case.
3136

37+
* **{logstash-ref}/plugins-filters-jdbc_static.html[JDBC static filter].**
38+
Best suited for enriching events with reference data that is static or does not
39+
change very often, such as environments, users, and products.
3240

41+
* **{logstash-ref}/plugins-filters-jdbc_streaming.html[JDBC streaming filter].**
42+
Best suited for filtering data that is transmitted in a steady, continuous flow.
43+
This plugin continues to receive incoming data while data received earlier is
44+
being processed.
45+
46+
:no_codec!:

0 commit comments

Comments
 (0)