Exec

Collect output from a process running on the host

status: beta role: sidecar delivery: at-least-once egress: stream state: stateless output: log

Configuration

Example configurations

{
  "sources": {
    "my_source_id": {
      "type": "exec",
      "mode": "scheduled",
      "command": null
    }
  }
}
[sources.my_source_id]
type = "exec"
mode = "scheduled"
---
sources:
  my_source_id:
    type: exec
    mode: scheduled
    command: null
    scheduled: null
    streaming: null
{
  "sources": {
    "my_source_id": {
      "type": "exec",
      "mode": "scheduled",
      "command": null,
      "working_directory": null,
      "include_stderr": true,
      "event_per_line": true,
      "maximum_buffer_size_bytes": 1000000
    }
  }
}
[sources.my_source_id]
type = "exec"
mode = "scheduled"
include_stderr = true
event_per_line = true
maximum_buffer_size_bytes = 1_000_000
---
sources:
  my_source_id:
    type: exec
    mode: scheduled
    command: null
    working_directory: null
    include_stderr: true
    event_per_line: true
    maximum_buffer_size_bytes: 1000000
    scheduled: null
    streaming: null

command

required [string]
The command to be run, plus any arguments required.
Array string literal

event_per_line

optional bool
Determine if events should be generated per line or buffered and output as a single event when script execution finishes.
default: true

include_stderr

optional bool
Include the output of stderr when generating events.
default: true

maximum_buffer_size_bytes

optional uint
The maximum buffer size allowed before a log event will be generated.
default: 1e+06 (bytes)

mode

required string enum
The type of exec mechanism.
Enum options string literal
OptionDescription
scheduledScheduled exec mechanism.
streamingStreaming exec mechanism.

scheduled

common optional object
The scheduled options.

scheduled.exec_interval_secs

optional uint
The interval in seconds between scheduled command runs. The command will be killed if it takes longer than exec_interval_secs to run.
Relevant when: mode = `scheduled`
default: 60 (seconds)

streaming

common optional object
The streaming options.

streaming.respawn_interval_secs

optional uint
The interval in seconds between restarting streaming commands if needed.
Relevant when: mode = `streaming`
default: 5 (seconds)

streaming.respawn_on_exit

optional bool
Determine if a streaming command should be restarted if it exits.
Relevant when: mode = `streaming`
default: true

working_directory

optional string
The directory in which to run the command.

Output

Logs

Line

An individual event from exec.
Fields
command required [string]
The command that was run to generate this event.
data_stream optional string literal
The data stream from which the event originated.
Examples
stdout
stderr
host required string literal
The local hostname, equivalent to the gethostname command.
Examples
my-host.local
message required string literal
The raw line, unparsed.
Examples
2019-02-13T19:48:34+00:00 [info] Started GET "/" for 127.0.0.1
pid required uint
The process ID of the command.
Examples
60085
668
timestamp required timestamp
The exact time the event was ingested into Vector.
Examples
2020-10-10T17:07:36.452332Z

Telemetry

Metrics

link

command_executed_total

counter
The total number of times a command has been executed.
component_kind required
The Vector component kind.
component_name required
The Vector component name.
component_type required
The Vector component type.

command_execution_duration_seconds

histogram
The command execution duration in seconds.
component_kind required
The Vector component kind.
component_name required
The Vector component name.
component_type required
The Vector component type.

events_in_total

counter
The number of events accepted by this component either from tagged origin like file and uri, or cumulatively from other origins.
component_kind required
The Vector component kind.
component_name required
The Vector component name.
component_type required
The Vector component type.
container_name optional
The name of the container from which the event originates.
file optional
The file from which the event originates.
mode optional
The connection mode used by the component.
peer_addr optional
The IP from which the event originates.
peer_path optional
The pathname from which the event originates.
pod_name optional
The name of the pod from which the event originates.
uri optional
The sanitized URI from which the event originates.

events_out_total

counter
The total number of events emitted by this component.
component_kind required
The Vector component kind.
component_name required
The Vector component name.
component_type required
The Vector component type.

processed_bytes_total

counter
The number of bytes processed by the component.
component_kind required
The Vector component kind.
component_name required
The Vector component name.
component_type required
The Vector component type.
container_name optional
The name of the container from which the bytes originate.
file optional
The file from which the bytes originate.
mode optional
The connection mode used by the component.
peer_addr optional
The IP from which the bytes originate.
peer_path optional
The pathname from which the bytes originate.
pod_name optional
The name of the pod from which the bytes originate.
uri optional
The sanitized URI from which the bytes originate.

processed_events_total

counter
The total number of events processed by this component. This metric is deprecated in place of using events_in_total and events_out_total metrics.
component_kind required
The Vector component kind.
component_name required
The Vector component name.
component_type required
The Vector component type.

processing_errors_total

counter
The total number of processing errors encountered by this component.
component_kind required
The Vector component kind.
component_name required
The Vector component name.
component_type required
The Vector component type.
error_type required
The type of the error

Examples

Exec line

Given this event...
64 bytes from 127.0.0.1: icmp_seq=0 ttl=64 time=0.060 ms
...and this configuration...
[sources.my_source_id]
type = "exec"
---
sources:
  my_source_id:
    type: exec
{
  "sources": {
    "my_source_id": {
      "type": "exec"
    }
  }
}
...this Vector event is produced:
{
  "log": {
    "data_stream": "stdout",
    "host": "my-host.local",
    "message": "64 bytes from 127.0.0.1: icmp_seq=0 ttl=64 time=0.060 ms",
    "pid": 5678,
    "timestamp": "2020-03-13T20:45:38.119Z"
  }
}

How it works

Context

By default, the exec source augments events with helpful context keys.

Line Delimiters

Each line is read until a new line delimiter, the 0xA byte, is found or the end of the maximum_buffer_size_bytes is reached.

State

This component is stateless, meaning its behavior is consistent across each input.