This document describes how to download, install, and administer Transfer service for on-premises data agents on your servers.
Installing and running the on-premises agent
To install and run the on-premises agent:
Go to the Transfer service for on-premises data Web Console page in the Google Cloud Console.
Click Connection Settings.
Click the Install Agent button.
Installation instructions for the agent are displayed. Follow the instructions displayed to install and run the agent.
You can install more than one agent for each machine. For more information about determining how many agents to run, see Maximizing transfer agent performance.
Confirming agents are connected
After you install your on-premises agents, you can verify that they're connected to your Transfer service for on-premises data job.
To confirm that your agents are connected:
Go to the Transfer service for on-premises data Web Console page in the Google Cloud Console.
Click Connection Settings.
Connected agents are displayed.
If you don't see any of your agents displayed in Transfer service for on-premises data Web Console within ten minutes after installing an agent, see Agents are not connected.
Monitoring agents
You can monitor agents from either the Google Cloud Console, or use Cloud Monitoring alerts to notify you based on agent behavior.
Monitoring agents from the Google Cloud Console
To monitor agents from the Google Cloud Console:
Go to the Transfer service for on-premises data Connection Settings page in the Google Cloud Console.
Go to the Transfer service for on-premises data Connection Settings Page
All Transfer service for on-premises data transfer agents and their current connection status are displayed.
Using Cloud Monitoring to monitor agents
To use Cloud Monitoring, you create a Monitoring alert on either of the following Google Cloud metrics:
Metric name | What it describes | Suggested uses |
---|---|---|
storagetransfer.googleapis.com/agent/transferred_bytes_count | Measures how quickly a specific agent is moving data (across all jobs that it services) at a point in time. | Alert for dips in performance. |
storagetransfer.googleapis.com/agent/connected | A boolean that is True for each agent that Google Cloud received a recent heartbeat message from. |
|
Stopping an agent
To stop an agent:
Find your agent's Docker container ID:
Go to the Transfer service for on-premises data Web Console page in the Google Cloud Console.
Click Connection Settings.
Connected agents are displayed. The Agent ID field lists each agent's ID in the format:
agent-prefix:hostname:container-ID
.Note the Docker container ID.
Log into the server.
Run
sudo docker stop container-id
in the agent's terminal window, wherecontainer-id
is the Docker container ID you previously noted.