Version: 3.3.1

exec

Execute arbitrary commands

Some things to take note of:

Shell expansion ($VAR) will take place using the Pipe environment
Will usually wrap the output as JSON in the form {"_raw":...}

Any linefeeds will be removed from the command, so this works fine:

exec:
  command: |
    docker ps
      -all
      --no-trunc
      --quiet
      --size

Note: This invokes a shell, which is something we might want to avoid at some point

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
retry	For operations that could potentially fail	Retry	-
command	A shell command to be executed	string	-
batch	For when a number of output events need to be marked as belonging to a distinct group	Batch	-
result	Offers a way to collect the full output of a command: stdout, stdin, and exit status	ExecResult	-
raw	Do not wrap incoming data in JSON format (i.e. `{"_raw":"some data"})	bool	false
count	Number of times to run the command	integer	-
no-strip-linefeeds	Do not strip newline characters (\n) automatically on multi-line commands	bool	false
ignore-line-breaks	Do not treat separate output lines as distinct events	bool	false
env	Accepts a YAML file containing variables that would be added to environment of the command	path	-

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

retry

For operations that could potentially fail

Type: Retry

Field Name	Description	Type	Default
count	How many attempts to make before declaring failure	integer	-
pause	How long to pause before re-trying	duration	-
forever	Keep trying until success is declared	bool	false

count

How many attempts to make before declaring failure

Type: integer

Example

action:

exec:
  command: echo 'one two'
  retry:
    count: 1

output:

{"_raw":"one two"}

pause

How long to pause before re-trying

Accepts human-friendly formats, like 1m (for 1 minute) and 4h (for 4 hours)

Type: duration

Example

action:

exec:
  command: echo 'one two'
  retry:
    count: 6
    pause: 10s

output:

{"_raw":"one two"}

forever

Keep trying until success is declared

Accepts human-friendly formats, like 1m (for 1 minute) and 4h (for 4 hours)

Type: bool

Example

action:

exec:
  command: echo 'one two'
  retry:
    forever: true

output:

{"_raw":"one two"}

command

A shell command to be executed

Type: string

Example

action:

exec:
  command: echo 'one two'

output:

{"_raw":"one two"}

batch

For when a number of output events need to be marked as belonging to a distinct group

Type: Batch

Field Name	Description	Type	Default
uuid-field	Field where generated uuid, the unique marker for the group, will be stored	field	-
invocation-time-field	Field where invocation time will be stored	field	-
completion-time-field	Field where completion (end of execution) time will be stored	field	-
begin-marker-field	Field used to mark first event in the group	field	-
end-marker-field	Field used to mark last event in the group	field	-
line-count-field	Field used to store the line count of the batch	field	-
line-num-field	Field used to store the line number of the batch	field	-

uuid-field

Field where generated uuid, the unique marker for the group, will be stored

Type: field

Example

action:

exec:
  command: |
    for n in $(seq 3)
    do
      echo $n
    done
  no-strip-linefeeds: true
  batch:
    uuid-field: marker
  interval: 1m

output:

{"_raw":"foo","line-count":3,"line-num":1,"marker":"f3308aa9-6f56-4cc1-8782-c4231ff254b8"}
{"_raw":"2","line-count":3,"line-num":2,"marker":"f3308aa9-6f56-4cc1-8782-c4231ff254b8"}
{"_raw":"3","line-count":3,"line-num":3,"marker":"f3308aa9-6f56-4cc1-8782-c4231ff254b8"}

Example: For cases where event count is known, a simple counter is used, instead of uuid (useful for testing)

action:

exec:
  command: echo foo
  no-strip-linefeeds: true
  count: 3
  batch:
    uuid-field: marker
  interval: 1m

output:

{"_raw":"1","line-count":3,"line-num":1,"marker":"1"}
{"_raw":"2","line-count":3,"line-num":2,"marker":"1"}
{"_raw":"3","line-count":3,"line-num":3,"marker":"1"}
{"_raw":"1","line-count":3,"line-num":1,"marker":"2"}
{"_raw":"2","line-count":3,"line-num":2,"marker":"2"}
{"_raw":"3","line-count":3,"line-num":3,"marker":"2"}
{"_raw":"1","line-count":3,"line-num":1,"marker":"3"}
{"_raw":"2","line-count":3,"line-num":2,"marker":"3"}
{"_raw":"3","line-count":3,"line-num":3,"marker":"3"}

invocation-time-field

Field where invocation time will be stored

Type: field

Example

action:

exec:
  command: |
    for n in $(seq 3)
    do
      echo $n
    done
  no-strip-linefeeds: true
  batch:
    invocation-time-field: begin
  interval: 1m

output:

{"_raw":"1","line-count":3,"line-num":1,"begin":"2020-01-17T09:55:09.135Z"}
{"_raw":"2","line-count":3,"line-num":2,"begin":"2020-01-17T09:55:09.135Z"}
{"_raw":"3","line-count":3,"line-num":3,"begin":"2020-01-17T09:55:09.135Z"}

completion-time-field

Field where completion (end of execution) time will be stored

Type: field

Example

action:

exec:
  command: |
    for n in $(seq 3)
    do
      echo $n
    done
  no-strip-linefeeds: true
  batch:
    invocation-time-field: begin
    completion-time-field: end
  interval: 1m

output:

{"_raw":"1","begin":"2020-01-17T10:02:14.302Z","end":"2020-01-17T10:02:14.301Z","line-count":3,"line-num":1}
{"_raw":"2","begin":"2020-01-17T10:02:14.302Z","end":"2020-01-17T10:02:14.301Z","line-count":3,"line-num":2}
{"_raw":"3","begin":"2020-01-17T10:02:14.302Z","end":"2020-01-17T10:02:14.301Z","line-count":3,"line-num":3}

begin-marker-field

Field used to mark first event in the group

Type: field

Example

action:

exec:
  command: |
    for n in $(seq 3)
    do
      echo $n
    done
  no-strip-linefeeds: true
  batch:
    begin-marker-field: begin
  interval: 1m

output:

{"_raw":"1","begin":true,"line-count":3,"line-num":1}
{"_raw":"2","line-count":3,"line-num":2}
{"_raw":"3","line-count":3,"line-num":3}

end-marker-field

Field used to mark last event in the group

Type: field

Example

action:

exec:
  command: |
    for n in $(seq 3)
    do
      echo $n
    done
  no-strip-linefeeds: true
  batch:
    begin-marker-field: begin
    end-marker-field: end
  interval: 1m

output:

{"_raw":"1","begin":true,"line-count":3,"line-num":1}
{"_raw":"2","line-count":3,"line-num":2}
{"_raw":"3","end":true,"line-count":3,"line-num":3}

line-count-field

Field used to store the line count of the batch

Type: field

line-num-field

Field used to store the line number of the batch

Type: field

result

Offers a way to collect the full output of a command: stdout, stdin, and exit status

Type: ExecResult

Field Name	Description	Type	Default
status-field	Field where exit status of command will be stored	field	-
stderr-field	Field where stderr of command will be stored	field	-
stdout-field	Field where stdout of command will be stored	field	_raw

status-field

Field where exit status of command will be stored

Type: field

Example

action:

exec:
  command: echo foo
  result:
    status-field: status

output:

{"_raw":"foo\n","status":0}

stderr-field

Field where stderr of command will be stored

Type: field

Example

input:

{"one":1,"two":2}

action:

exec:
  command: "echo \"this will return with an error\" 1>&2 && false"
  result:
    stderr-field: stderr

output:

{"one":1,"two":2,"stderr":"this will return with an error"}

stdout-field

Field where stdout of command will be stored

Type: field

Example

action:

exec:
  command: echo foo
  result:
    stdout-field: stdout
  interval: 1m

output:

{"stdout":"foo\n"}

raw

Do not wrap incoming data in JSON format (i.e. `{"_raw":"some data"})

This is useful when incoming data is already in JSON format.

Type: bool

Example: Enabled

action:

exec:
  command: echo one
  raw: true

output:

one

Example: Disabled (default)

action:

exec:
  command: echo one

output:

{"_raw":"one"}

Example: Enabled, with JSON data

action:

exec:
  command: echo '{"one":1}'
  raw: true

output:

{"one":1}

Example: Disabled, with JSON data (note the escapes)

action:

exec:
  command: echo '{"one":1}'

output:

{"_raw":"{\"one\":1}"}

count

Number of times to run the command

Type: integer

Example

action:

exec:
  command: echo 'one two'
  interval: 1s
  count: 3

output:

{"_raw":"one two"}
{"_raw":"one two"}
{"_raw":"one two"}

no-strip-linefeeds

Do not strip newline characters (\n) automatically on multi-line commands

Type: bool

Example: Enabled

action:

exec:
  command: |
    echo one
    echo two
  no-strip-linefeeds: true

output:

{"_raw":"one"}
{"_raw":"two"}

Example: Enabled, with a more realistic example (this will fail as one line)

action:

exec:
  command: |
    for n in $(seq 3)
    do
      echo $n
    done
  no-strip-linefeeds: true

output:

{"_raw":"1"}
{"_raw":"2"}
{"_raw":"3"}

Example: Disabled

action:

exec:
  command: |
    echo one
    echo two

output:

{"_raw":"one echo two"}

ignore-line-breaks

Do not treat separate output lines as distinct events

Type: bool

Example: Enabled

action:

exec:
  command: |
    echo one
    echo two
  no-strip-linefeeds: true
  ignore-line-breaks: true
  interval: 1s
  count: 1

output:

{"_raw":"one\ntwo"}

Example: Disabled

action:

exec:
  command: |
    echo one
    echo two
  no-strip-linefeeds: true

output:

{"_raw":"one"}
{"_raw":"two"}

env

Accepts a YAML file containing variables that would be added to environment of the command

Type: path

Example

file: some-file.yml

one: 1
two: 2

action:

exec:
  command: echo $one $two
  env: some-file.yml

output:

{"_raw":"1 2"}

exec

interval​

cron​

immediate​

random-offset​

window​

size​

offset​

start-time​

highwatermark-file​

block​

retry​

count​

pause​

forever​

command​

batch​

uuid-field​

invocation-time-field​

completion-time-field​

begin-marker-field​

end-marker-field​

line-count-field​

line-num-field​

result​

status-field​

stderr-field​

stdout-field​

raw​

count​

no-strip-linefeeds​

ignore-line-breaks​

env​

interval

cron

immediate

random-offset

window

size

offset

start-time

highwatermark-file

block

retry

count

pause

forever

command

batch

uuid-field

invocation-time-field

completion-time-field

begin-marker-field

end-marker-field

line-count-field

line-num-field

result

status-field

stderr-field

stdout-field

raw

count

no-strip-linefeeds

ignore-line-breaks

env