Agents and Routines

Agents

Qalita agents are workers for the platform and sources; they connect them together and compute analyses, then send them to the platform.

Registering an Agent

If you have the role of data engineer or admin, you can register an agent on the platform. To do this, you will see an Agent Configuration button in the navigation bar.

Button containing instructions for agent configuration

You just need to follow the instructions to register your agent.

Command

qalita agent -n admin login

Result

Found existing agent file: ~/.qalita/.env-admin
Qalita Platform Version : 0.0.0-dev
Qalita CLI Version : 1.5.0
Make sure you are using compatible versions for the platform and the CLI,
> check compatibility matrix on the documentation <
Agent Authenticated
Agent Registered
Agent Fetched Registry

You will then see your agent in the platform's agent list.

Agent Operating Modes

The agent has 2 operating modes:

• Job
• Worker

Job

The Job mode can be useful when you are developing your own packs.

To run a pack in job mode, you will need:

• A source registered on the platform
• A pack registered on the platform

You will need to obtain their ID with:

qalita source list

and

qalita pack list

Finally, you can run a job locally with your agent using:

qalita agent -m job run -s <source_id> -p <pack_id>

This will run your pack with your source using your local agent.

Worker

The worker mode allows you to run an agent as a worker for the platform. It enables the execution of tasks and routines. This agent will remain online waiting for tasks to execute.

info

Agents in worker mode will only run tasks on sources that are present in their configuration ~/.qalita/qalita-conf.yaml. If the source is not present in the agent's configuration, it will not be able to run tasks on that source.

warning

Make sure your agent in worker mode has the configuration of the sources on which you want to run tasks. And that there is a source id.

Tracking Task Executions

You can directly track task executions on the platform.

• View the status of tasks
• View the logs of tasks
• See which pack is running on which source

Routines

Creating Routines

Routines are scheduled tasks that run automatically at a given frequency.

You can create routines from the detail page of a pack.

From the pack list	From the pack page
From the source page

	The routine creation pane allows you to select the pack to use, the frequency of the routine execution, the start date of the routine. Once the pack is selected, the default configuration is loaded; you can then override the default configuration of the pack specifically for this routine.

Tracking Routine Executions

You can track routine executions on the platform.

• View the status of tasks
• Activate or deactivate a routine
• Modify the configuration of a routine
• Delete a routine