Sources - Odigos

There are two ways to add sources to the Odigos VM Agent: use odictl or use YAML files.

It is recommended to add a destination before adding a source.

odictl
YAML

Launch odictl

odictl

Select the source menu

Use Tab to focus on the Sources pane or press o, then press Enter or click + Add Source with your mouse.

Select Sources pane of the odictl interface

Select a source

Type the name of the Linux process in the search bar at the top, and/or press Tab and scroll through the list of sources. Once your source is highlighted, press Enter.

Instrument source

Review and adjust the properties if needed:

Show Properties

Name

string

A human-readable label for the process or systemd service. You can edit this to make the source easier to identify in the UI.

Service Name

string

The exact name of the running process as detected by the VM Agent. This field is auto-populated at discovery time — contact support before changing it.

Kind

string

The process type: either systemd for services managed by systemd, process for standalone Linux processes, or docker for docker containers. This field is auto-populated at discovery time — contact support before changing it.

Enabled

boolean

Controls whether the VM Agent instruments this source. Check to enable instrumentation, or uncheck to pause it without removing the source.

Runtime Language

string

The programming language of the process as detected by the VM Agent. This field is auto-populated at discovery time — contact support before changing it.

Runtime Version

string

The version of the runtime language as detected by the VM Agent. This field is auto-populated at discovery time — contact support before changing it.

Press Tab to navigate to Apply, then press Enter to save and instrument your service.

Once you select Apply the service or process will restart.

Complete instrumentation

Select OK.

The service or process will restart automatically to apply instrumentation. After it comes back up, it appears in the Sources list with a Health status of Success.

Navigate to the /etc/odigos-vmagent/sources.d folder

cd /etc/odigos-vmagent/sources.d

Create source YAML file

Create a YAML file for your source’s configuration using the editor of your choice. The example below uses vi.

sudo vi example.yaml

Add the source configuration

Define each service or process you want to instrument using the properties below.

Show Properties

name

string

A human-readable label for the process or systemd service. You can edit this to make the source easier to identify in the UI.

enabled

boolean

Controls whether the VM Agent instruments this source. Set to true to enable instrumentation, or to false to pause it without removing the source.

serviceName

string

The exact name of the running process as detected by the VM Agent.

kind

string

The process type: either systemd for services managed by systemd, process for standalone Linux processes, or docker for Docker containers.

config

object | null

Optional runtime configuration (e.g., language and version). Auto-populated at discovery time — contact support before changing this field.

For example:

- name: odigos-demo-frontend
  enabled: true
  serviceName: odigos-demo-frontend
  kind: systemd
  config: null
- name: odigos-demo-membership
  enabled: true
  serviceName: odigos-demo-membership
  kind: systemd
  config: null

You can define multiple sources in a single YAML file, and you can organize sources across multiple YAML files.

Save the file

:wq!

Verify the source has been instrumented

sudo journalctl -u odigos-vmagent | grep 'Successfully attached eBPF probes to process'

Mar 10 20:14:35 ip-10-0-1-51 odigos-vmagent[4203]: time=2026-03-10T20:14:35.846Z level=INFO source=/go/src/github.com/keyval/odigos-vmagent/pkg/components/controller/instrumentor/ebpf_manager.go:179 msg="Successfully attached eBPF probes to process" pid=7251 service=odigos-demo-frontend
Mar 10 20:21:42 ip-10-0-1-51 odigos-vmagent[4203]: time=2026-03-10T20:21:42.098Z level=INFO source=/go/src/github.com/keyval/odigos-vmagent/pkg/components/controller/instrumentor/ebpf_manager.go:179 msg="Successfully attached eBPF probes to process" pid=8308 service=odigos-demo-membership

VM Agent

Documentation Index