Skip to main content

​
Introduction

The Odigos VM Agent is installed with a terminal user interface (TUI) called odictl. odictl is one method you can use to instrument processes and services, set up destinations, and add actions to Odigos. To launch odictl, run the following command from the command-line: 
odictl
You will then see a screen similar to the one below: Initial odictl TUI screen The odictl interface has five main sections: Services, Logs, Sources, Destinations, and Actions. Use the keyboard to move between them; if you are connected through an ssh session from a terminal that supports mouse input, you can navigate the interface with your mouse.
The following describes how to navigate using the keyboard:
KeyAction
Tab / Shift+TabCycle panes
↑ / ↓Move between items in the current section
EnterSelect the highlighted item
q / EscQuit
sFocus Services
oFocus Sources
dFocus Destinations
aFocus Actions
cOpen Configuration Editor
rReload status + config
eEdit selected
Del / BackspaceDelete selected
lShow service logs
yShow YAML config
? / hDisplay full keymap
The currently selected item has a secondary border around it. Press Enter to select it.

​
Requirements

Mouse support requires:
  • A terminal emulator that supports mouse input
  • An SSH session that forwards mouse events
Most modern terminal emulators support mouse interaction automatically.
To navigate:
  • Click a section to switch sections
  • Click an item to select it

​
Services Panel

The Services section shows the status of the two services that run the Odigos VM Agent: odigos-vmagent and odigos-otelcol. When you highlight a service, the log window shows that service’s logs. Services section of the odictl interface The following animation shows switching between viewing logs for odigos-vmagent and odigos-otelcol in the Logs section.

​
Logs Panel

The Logs section shows a live stream of logs for the odigos-vmagent and odigos-otelcol Odigos services. When the section is focused, use the ↑ / ↓ keys or the mouse wheel to scroll through the logs.

​
Sources Panel

Sources is where you define the systemd services or Linux processes on the host system that you want to instrument with the Odigos VM Agent. See Add Sources to learn how. Sources screen

​
Destinations Panel

Destinations are backends that accept data from the Odigos VM Agent. Odigos lets you add as many destinations as you like, enabling you to execute different use cases such as:
  • Using different backends for different types of OpenTelemetry signals
  • Migrating from one backend to another
  • Testing different backends for different OpenTelemetry use cases
Destinations screen

​
Actions Panel

Actions let you modify OpenTelemetry data from Odigos Sources before it is exported to your destinations. Odigos implements actions using OpenTelemetry Collector processors—components that transform, filter, or enrich telemetry before it is sent to your destinations. See Actions overview to add or edit actions. For action types and processor options, see Odigos Actions. Actions screen

​
Instrumentation Rules Panel

Instrumentation Rules control how telemetry is recorded from your instrumented sources. A rule can be applied to specific sources and instrumentation libraries, letting you control what attributes, headers, or payloads are collected and how custom instrumentations behave. For rule types and configuration options, see Instrumentation rules overview. Instrumentation Rules screen