Managing Agents

After you have created an Agent, you can perform actions to change its state, such as moving it from Not Deployed to Running. You can also manage the Agent by modifying the configuration settings as required. When you have finished making your changes, you can redeploy the Agent.

You must create the Agent in the same environment as the event broker service that you want to connect to. For more information about environments, see Creating and Managing Environments.

To manage an Agent, you can perform the following actions:

Opening an Agent

You can open an Agent to view its information and configuration details. You can also view metrics for Agents that are in a deployed state. For more information, see Viewing Agent Metrics .

To open an Agent, perform the following steps:

  1. Log in to the PubSub+ Cloud Console if you have not done so yet. The URL to access the Cloud Console differs based on your authentication scheme. For more information, see Logging In to the PubSub+ Cloud Console.

  2. On the navigation bar, select Agents .

  3. If your organization uses multiple environments, on the Agents page, select the environment where you want to create the Agent. For more information, see Selecting Environments.

  4. Click the name of the Agent.

    The Agent Details page opens.

Viewing Agent Metrics

Metrics appear at the top of the Agent Details page and provide information about Agent performance and usage, including:

  • the state of the Agent

  • message and byte usage

  • total messages and errors

We collect metric data at a high frequency, and you can see up-to-the minute data by refreshing the Cloud Console browser tab. The table below explains the metrics shown on the card:

Metric Definition
Agent State

The current status of the Agent. The status for an Agent can be:

  • Not Deployed—The Agent has not been deployed.

  • Unable to deploy—The Agent cannot be deployed. There may be configuration problems. Review the Agent.

  • Deploying—The Agent is being deployed.

  • Running—The Agent is deployed and active.
Messages Per Second The number of messages being handled by the Agent per second.
Bytes Per Second The number of bytes being handled by the Agent per second.
Total Messages The total number of messages handled since the Agent was deployed.
Total Errors The total number of errors that have occurred since the Agent was deployed.
Last Updated The time that the metrics were last updated.
Update Interval The frequency in minutes that we collect metric data.

Editing an Agent

You can modify the configuration details of your existing Agent.

You can only edit an Agent if it is not deployed.

To edit an Agent, perform the following steps:

  1. On the navigation bar, select Agents .

  2. If your organization uses multiple environments, on the Agents page, select the environment that contains the Agent you want to edit. For more information, see Selecting Environments.

  3. Click the name of the Agent to open the Agent Detailss page.

  4. In the top-right corner of the Agent Detailss page, click Edit Agent. For more information, see Designing Agents.

Deploying an Agent

You deploy an Agent to start the flow of messages between your external system and event broker service. After the Agent has been successfully deployed, you can view the Agent's metrics to ensure that messages are moving as expected.

To deploy an Agent, perform the following steps:

  1. On the navigation bar, select Agents .

  2. If your organization uses multiple environments, on the Agents page, select the environment where you want to create the Agent. For more information, see Selecting Environments.

  3. Click the name of the Agent to open the Agent Detailss page.

  4. In the top-right corner of the Agent Detailss page, click the ellipsis () and then click Deploy.

Deploying an Agent takes a few minutes. After the Agent successfully deploys, its state shows as Running. If there are issues deploying, you may need to modify and troubleshoot your Agent. For more information, see Troubleshooting Agents.

Undeploying an Agent

You may want to take your Agent out of service to edit it or to disconnect it so that data no longer flows between the external systems and the event broker service.

To undeploy an Agent, perform the following steps:

  1. On the navigation bar, select Agents .

  2. If your organization uses multiple environments, on the Agents page, select the environment that contains the Agent you want to take out of service. For more information, see Selecting Environments.

  3. Click the name of the Agent to open the Agent Details page.

  4. In the top-right corner of the Agent Details page, click the ellipsis () and then click Undeploy.

Deleting an Agent

You can delete an Agent that you no longer require.

  • Deleting an Agent does not delete the event broker service.

  • If an event broker service gets deleted in  Cluster Manager, the Agent gets deleted as well.

To delete an Agent, perform the following steps:

  1. On the navigation bar, select Agents .

  2. If your organization uses multiple environments, on the Agents page, select the environment that contains the Agent. For more information, see Selecting Environments.

  3. Click the name of the Agent to open the Agent Details page.

  4. In the top-right corner of the Agent Detailss page, click the ellipsis () and then click Delete.