exec

Execute arbitrary commands

One thing to take note of:

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

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

Field Name	Description	Type	Default
input-field	A field from where data is to be read, meaning JSON is assumed	field	-
command	A shell command to be executed	string	-
stdin	Run the command separately for each event	bool	true
retry	For operations that could potentially fail	-	-

A field from where data is to be read, meaning JSON is assumed

Otherwise the whole event is sent

Type: field

Example

input:

{"text":"one","number":1}

action:

exec:
  input-field: text
  command: cat

output:

one

A shell command to be executed

If stdin is set to false (or input-field) then there can be field expansions

Type: string

Example

input:

{"text":"one","number":1}

action:

exec:
  command: cat

output:

{"text":"one","number":1}

Run the command separately for each event

Normally, the command runs continuously and events are passed through

Type: bool

For operations that could potentially fail

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

How many attempts to make before declaring failure

Type: integer

Example

action:

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

output:

{"_raw":"one two"}

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"}

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"}