echo

Create a simple static event

Field Name	Description	Type	Default
interval	How often to run the command	duration	-
cron	How often to run the command. Note that Hotrod uses a different format than Cron it includes a column for seconds. See full discussion	cron	-
immediate	Run as soon as invoked, instead of waiting for the specified cron interval	bool	false
random-offset	Sets a random offset to the schedule, then sticks to it	duration	0s
window	For resources that need a time window to be specified	Window	-
block	Block further input schedules from triggering if the pipe output is retrying	bool	false
event	The static data to be used as input	string	-
json	Treat incoming data as JSON	bool	false
ignore-linebreaks	Do not treat separate lines as distinct events	bool	false

interval

How often to run the command

By default, interval: 0s which means: once. Note that scheduled inputs set document markers. See full discussion

Type: duration

Example

action:

exec:
  command: echo 'once a day'
  interval: 1d

cron

How often to run the command. Note that Hotrod uses a different format than Cron it includes a column for seconds. See full discussion

Type: cron

Example: Once a day

action:

exec:
  command: echo 'once a day'
  cron: '0 0 0 * * *'

Example: Once a day, using a convenient shortcut

action:

exec:
  command: echo 'once a day'
  cron: '@daily'

immediate

Run as soon as invoked, instead of waiting for the specified cron interval

Type: bool

Example: Run immediately on invocation, and thereafter at 10h every morning

action:

exec:
  command: echo 'hello'
  immediate: true
  cron: '0 0 10 * * *'

random-offset

Sets a random offset to the schedule, then sticks to it

This can help avoid the thundering herd problem, where you do not, for example, want to overload some service at 00:00:00

Type: duration

Example: Would fire up to a minute after every hour

action:

exec:
  command: echo 'hello'
  random-offset: 1m
  cron: '0 0 * * * *'

window

For resources that need a time window to be specified

Type: Window

Field Name	Description	Type	Default
size	Window size	duration	-
offset	Window offset	duration	0s
start-time	Allows the windowing to start at a specified time	time	-
highwatermark-file	Specify file where timestamp would be stored in order to resume, for when Pipe has been restarted	path	-

size

Window size

Type: duration

Example

action:

exec:
  command: echo 'one two'
  window:
    size: 1m

offset

Window offset

Type: duration

Example

action:

exec:
  command: echo 'one two'
  window:
    size: 1m
    offset: 10s

start-time

Allows the windowing to start at a specified time

It should in the following format: 2019-07-10 18:45:00.000 +0200

Type: time

Example

action:

exec:
  command: echo 'one two'
  window:
    size: 1m
    start-time: 10s

highwatermark-file

Specify file where timestamp would be stored in order to resume, for when Pipe has been restarted

Type: path

Example

action:

exec:
  command: echo 'one two'
  window:
    size: 1m
    highwatermark-file:: /tmp/mark.txt

block

Block further input schedules from triggering if the pipe output is retrying

Type: bool

event

The static data to be used as input

Type: string

json

Treat incoming data as JSON

Type: bool

ignore-linebreaks

Do not treat separate lines as distinct events

Type: bool