src/main/resources/Documentation/config.md

@PLUGIN@ Configuration
======================

In a multi-primary environment events may be created and written
to the filestore from any primary.  Without a notification system,
events written by other servers might only be seen by the current
server when the current server creates a new event.  If the traffic
on the current server is low, this delay may be significant and
unacceptable.

In order to get events from other primaries output in a timely manner,
the @PLUGIN@ plugin can be configured to poll and recongnize when
new events may have been written to the filestore and output them.

Reload the plugin on each primary for the changes to take effect.

Config
------

`pollingInterval`

: The polling frequency can be specified in the configuration.
For example:

```
  [plugin "@PLUGIN@"]
    pollingInterval = 3s
```

causes polling to be done every 3 seconds.

Values should use common time unit suffixes to express their setting:

* s, sec, second, seconds
* m, min, minute, minutes
* h, hr, hour, hours
* d, day, days
* w, week, weeks (`1 week` is treated as `7 days`)
* mon, month, months (`1 month` is treated as `30 days`)
* y, year, years (`1 year` is treated as `365 days`)

If a time unit suffix is not specified, `seconds` is assumed.

If 'pollingInterval' is not present in the configuration, polling
will not be enabled.

`queue`

: The work queue on which the polling is scheduled can be provided
using the queue option. Example

```
  [plugin "@PLUGIN@"]
    queue = myQueue
```

causes polling to be scheduled on myQueue executor. If the specified
queue is not found or the queue is not specified, default queue
(WorkQueue) is used.