Edge Delta Exec Source

Execute a command or script.

Overview

The Exec node executes a command or script to create log items.

  • outgoing_data_types: log

Example Configuration

nodes:
- name: my_exec_input
  type: exec_input
  script: for i in {1..50}; do echo "Welcome $i times"; done
  command: /bin/sh -c
  run_interval: 10s

Required Parameters

name

A descriptive name for the node. This is the name that will appear in pipeline builder and you can reference this node in the YAML using the name. It must be unique across all nodes. It is a YAML list element so it begins with a - and a space followed by the string. It is a required parameter for all nodes.

nodes:
  - name: <node name>
    type: <node type>

type: exec_input

The type parameter specifies the type of node being configured. It is specified as a string from a closed list of node types. It is a required parameter.

nodes:
  - name: <node name>
    type: <node type>

command

The command parameter is a path to an executable with some arguments such as /bin/sh -c. It is written as a string and is required.

nodes:
  - name: <node name>
    type: exec_input
    command: "<command>"

Optional Parameters

run_interval

The run_interval parameter is the duration before the command and script will be run again. If it is not specified the command and script will run once. It is written as a string and is optional.

nodes:
  - name: <node name>
    type: exec_input
    command: "<command>"
    run_interval: <duration>

script

The script parameter is a Bash script that can be added if the command is a shell executable. It is written as a string and is optional.

nodes:
  - name: <node name>
    type: exec_input
    command: "<command>"
    script: |
      <script>      

source_metadata

The source_metadata parameter is used to define which detected resources and attributes to add to each data item as it is ingested by the Edge Delta agent. In the GUI you can select:

  • Required Only: This option includes the minimum required resources and attributes for Edge Delta to operate.
  • Default: This option includes the required resources and attributes plus those selected by Edge Delta
  • High: This option includes the required resources and attributes along with a larger selection of common optional fields.
  • Custom: With this option selected, you can choose which attributes and resources to include. The required fields are selected by default and can’t be unchecked.

Based on your selection in the GUI, the source_metadata YAML is populated as two dictionaries (resource_attributes and attributes) with Boolean values.

See Choose Data Item Metadata for more information on selecting metadata.