Manage agents

If your agents are deployed in your own cloud infrastructure in a Hybrid SaaS configuration, there are certain agent management tasks you can perform directly from the Data Productivity Cloud user interface. This article discusses those management tasks.

Note

This article covers Data Productivity Cloud agents only. For Streaming agents, read Create a Streaming agent.

List agents

To see a full list of agents, click the menu button in the top left of any Data Productivity Cloud page, then click Manage → Agents. This will open the Agents page.

The Agents page lists all agents currently created, and for each agent it shows:

Agent: The name of the agent. Click the name to display the full details for the agent.
Status: The status of the agent. This will be one of the following:
- Running: The agent is connected and ready for development and pipeline tasks.
- Unknown: The agent is in an unknown state.
- Pending: The agent has been created but hasn't yet connected to the Data Productivity Cloud.
- Stopped: The agent has been stopped.
Plaform: The cloud platform that the agent is installed on. This is shown as an icon, but if you hover over the icon you will see the description, which will be one of the following:
- AWS Fargate.
- Azure Container App or ACI.
- Matillion Hosted. This is a Full SaaS agent hosted and managed by Matillion. You will not be able to view further details or perform management actions on this agent.
Type: The type of agent, which will be Data Productivity Cloud or Streaming. For more details of Streaming agents, read Create a Streaming agent.
Version reported by agent: This is the version of the agent currently installed in your cloud infrastructure. If a new version is available, this column will also display the notice Update Available.

Click the ... icon to the right of this information to display the actions menu for the agent.

Agent details

On the Agents page, locate the agent you want to pause and click the agent's name to open its details page.

The agent details page displays:

Agent name: The name of the agent.
Description: The optional description you entered when you created the agent.
Agent status: The status of the agent. This will be one of the following:
- Running: The agent is connected and ready for development and pipeline tasks.
- Unknown: The agent is in an unknown state.
- Pending: The agent has been created but hasn't yet connected to the Data Productivity Cloud.
- Stopped: The agent has been stopped.
Type: The type of agent, which will be Data Productivity Cloud or Streaming. For more details of Streaming agents, read Create a Streaming agent.
Cloud provider: The cloud platform that the agent is installed on. Currently, AWS and Azure are supported.
Deployment: The supported deployment method for the given cloud provider. Currently, Fargate for AWS and Container App/ACI for Azure are supported.
Auto update: If the agent has auto update enabled, then whenever a new version is released on its version track the agent will be automatically updated to that version. You can change an agent's auto update status at any time by clicking the toggle button. Read Auto update for details of how this setting is applied.
Version Track The release version track that the agent is using, Current or Stable. Read Version tracks for details.
Latest version: The latest version of the agent that's available on the version track.
Version release date: The date that the latest version of the agent was released by Matillion.
Version reported by agent: This is the version of the agent currently installed in your cloud infrastructure. If there is a discrepancy between this version number and the Latest version number, you should consider upgrading the agent. If you have enabled Auto update, the versions should be in sync.
Update Available: This will be displayed if a new agent version is available.

Actions

To carry out management actions on an agent:

On the Agents page, locate the agent in the list, and click ... to the right of it to open the actions menu.

The actions that can be selected from this menu are described below.

Agent details: Select this action to view the full agent details page, described above.
Restart agent: Select this action to restart the agent. Read Restart an agent for details.
Pause agent: Select this action to pause the agent. Read Pause an agent for details.
Remove agent: Select this action to delete the agent. Deleting the agent here doesn't remove the underlying AWS or Azure resources. You should go into the AWS Console or Azure Portal and clean up any resources that you no longer require.

Warning

Deleting an agent that is currently running may interrupt scheduled pipelines or pipelines that are currently running. Therefore, you should always stop the agent service before deleting it.