Skip to content

Commit 14bc7a3

Browse files
committed
doc: documented interval configuration option
1 parent 527ea80 commit 14bc7a3

File tree

1 file changed

+19
-1
lines changed

1 file changed

+19
-1
lines changed

docs/index.asciidoc

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,7 @@ This plugin supports the following configuration options plus the <<plugins-{typ
7777
| <<plugins-{type}s-{plugin}-api_version>> |<<string,string>>|No
7878
| <<plugins-{type}s-{plugin}-client_id>> |<<string,string>>|Yes
7979
| <<plugins-{type}s-{plugin}-client_secret>> |<<password,password>>|Yes
80+
| <<plugins-{type}s-{plugin}-interval>> |<<number,number>>|No
8081
| <<plugins-{type}s-{plugin}-password>> |<<password,password>>|Yes
8182
| <<plugins-{type}s-{plugin}-security_token>> |<<password,password>>|Yes
8283
| <<plugins-{type}s-{plugin}-sfdc_fields>> |<<array,array>>|No
@@ -124,8 +125,25 @@ https://help.salesforce.com/apex/HTViewHelpDoc?id=connected_app_create.htm
124125

125126
Consumer Secret from your oauth enabled connected app
126127

128+
[id="plugins-{type}s-{plugin}-interval"]
129+
===== `interval`
130+
131+
* Value type is <<number,number>>
132+
* There is no default value for this setting.
133+
134+
The interval in seconds between each run of the plugin.
135+
136+
If specified, the plugin only terminates when it receives the stop
137+
signal from Logstash, e.g. when you press Ctrl-C when running interactively,
138+
or when the process receives a TERM signal. It will query and publish
139+
events for all results, then sleep until `interval` seconds from the start
140+
of the previous run of the plugin have passed. If the plugin ran for longer
141+
than `interval` seconds, it will run again immediately.
142+
143+
If this property is not specified or is set to -1, the plugin will run once and then exit.
144+
127145
[id="plugins-{type}s-{plugin}-password"]
128-
===== `password`
146+
===== `password`
129147

130148
* This is a required setting.
131149
* Value type is <<password,password>>

0 commit comments

Comments
 (0)