Linux

1. Open a terminal connection to your VM instance using SSH or a similar tooland ensure you havesudo access.

2. Change to a directory you have write access to, for example your homedirectory.

3. Download and run the agent-installation script by using the followingcommands:

   curl -sSO https://dl.google.com/cloudagents/add-google-cloud-ops-agent-repo.shsudo bash add-google-cloud-ops-agent-repo.sh --also-install

   After it is installed, the agent is started automatically.

Windows

1. Connect to your instance using RDP or a similar tool and login to Windows.

2. Open a PowerShell terminal with administrator privileges by right-clicking thePowerShell icon and selectingRun as Administrator.

3. Run the following PowerShell commands:

   (New-Object Net.WebClient).DownloadFile("https://dl.google.com/cloudagents/add-google-cloud-ops-agent-repo.ps1", "${env:UserProfile}\add-google-cloud-ops-agent-repo.ps1")Invoke-Expression "${env:UserProfile}\add-google-cloud-ops-agent-repo.ps1 -AlsoInstall"

Linux

1. Open a terminal connection to your VM instance using SSH or a similar tooland ensure you havesudo access.

2. Change to a directory you have write access to, for example your homedirectory.

3. Download the agent installation script:

   curl -sSO https://dl.google.com/cloudagents/add-google-cloud-ops-agent-repo.sh

   When running theadd-google-cloud-ops-agent-repo.sh script, you can also set thefollowing flags:

   • --verbose: Turns on verbose logging during the script execution.
   • --also-install: Installs the agent after adding the agent packagerepository.
   • --version: Sets the agent version for the script to install.For version information, seeList all agent versions.
   • --uninstall: Uninstalls the agent.
   • --remove-repo: Removes the corresponding agent package repository afterinstalling or uninstalling the agent.
   • --dry-run: Triggers only a dry run of the script execution and prints outthe commands that it is supposed to execute.
   • --uninstall-standalone-logging-agent: Uninstalls the legacyLogging agent (StackdriverLogging).
   • --uninstall-standalone-monitoring-agent: Uninstalls the legacyMonitoring agent (StackdriverMonitoring).

   See the script comments for more information and example usage.

4. Add the agent's package repository and install the agent:

   1. To list the available agent versions, seeList all agent versions.

   2. For production environments, you might want to pin to a major version toavoid installing major versions that might include backward incompatiblechanges. To pin to a major version, run:

      sudo bash add-google-cloud-ops-agent-repo.sh --also-install \  --version=MAJOR_VERSION.*.*

      For example, to pin to the 1.x.x of theagent, run:

      sudo bash add-google-cloud-ops-agent-repo.sh --also-install \  --version=1.*.*

   3. To install a specific version of the agent, run:

      sudo bash add-google-cloud-ops-agent-repo.sh --also-install \  --version=MAJOR_VERSION.MINOR_VERSION.PATCH_VERSION

You can delete the installation script after it runs successfully.

• To verify that the agent is working as expected, run:

  sudo systemctl status google-cloud-ops-agent"*"

  Verify that the components "Logging Agent" and "Metrics Agent" are running.

If you have trouble with the installation, refer to theTroubleshooting page.

Windows

1. Connect to your instance using RDP or a similar tool and login to Windows.

2. Open a PowerShell terminal with administrator privileges by right-clicking thePowerShell icon and selectingRun as Administrator.

3. Download the agent installation script:

   (New-Object Net.WebClient).DownloadFile("https://dl.google.com/cloudagents/add-google-cloud-ops-agent-repo.ps1", "${env:UserProfile}\add-google-cloud-ops-agent-repo.ps1")

   When running theadd-google-cloud-ops-agent-repo.ps1 script, you can also set thefollowing flags:

   • -Verbose: Turns on verbose logging during the script execution.
   • -AlsoInstall: Installs the agent after adding the agent packagerepository.
   • -Version: Sets the agent version for the script to install.For version information, seeList all agent versions.
   • -Uninstall: Uninstalls the agent.
   • -RemoveRepo: Removes the corresponding agent package repository afterinstalling or uninstalling the agent.
   • -WhatIf: Triggers only a dry run of the script execution and prints outthe commands that it is supposed to execute.
   • -UninstallStandaloneLoggingAgent: Uninstalls the legacyLogging agent (StackdriverLogging).
   • -UninstallStandaloneMonitoringAgent: Uninstalls the legacyMonitoring agent (StackdriverMonitoring).

   See the script comments for more information and example usage.

4. Add the agent's package repository and install the agent:

   1. To list the available agent versions, seeList all agent versions.

   2. For production environments, you might want to pin to a major version toavoid installing major versions that might include backward incompatiblechanges. To pin to a major version, run:

      Invoke-Expression "${env:UserProfile}\add-google-cloud-ops-agent-repo.ps1 -AlsoInstall -VersionMAJOR_VERSION.*.*"

      For example, to pin to the 1.x.x of the agent, run:

      Invoke-Expression "${env:UserProfile}\add-google-cloud-ops-agent-repo.ps1 -AlsoInstall -Version 1.*.*"

   3. To install a specific version of the agent, run:

      Invoke-Expression "${env:UserProfile}\add-google-cloud-ops-agent-repo.ps1 -AlsoInstall -Versionversion-number"

      For example:

      Invoke-Expression "${env:UserProfile}\add-google-cloud-ops-agent-repo.ps1 -AlsoInstall -Version 1.0.1"

You can delete the installation script after it runs successfully.

• To verify that the agent is working as expected, run:

  Get-Service google-cloud-ops-agent

  The status of the agent should beRunning.

If you have trouble with the installation, refer to theTroubleshooting page.

Cloud Monitoring

In the Google Cloud console, go to theVM Instances page:

Go toVM Instances

If you use the search bar to find this page, then select the result whose subheading isMonitoring.

TheList view on theInventory tab on the dashboard lists all VMs andincludes a status column for your agent, as shown in the following screenshot:

TheAgent column reports the following values:

• Not detected: Either you don't have an agent installed or it isnot running. If you aren't sure if you've installed an agent, then youcanquery for the installed version. If you've installedthe agent, then you canrestart the agent.If you've installed and started the Ops Agent but the status remainsNot detected, then the agent might not have started correctly oris unable to send metrics.

  To troubleshoot start-up problems, seeAgent is installed but notrunning.To troubleshoot metric-ingestion problems, seeTroubleshoot dataingestion. The generalagent-diagnostics scriptandhealth checksmight also be helpful.

• Ops Agent: You are running the Ops Agent.If you don't see a green checkmark beside the entry, then there is anagent upgrade available, based on the detected operating system of your VM.

  When you hover over the Ops Agent indicator in the table, you see informationabout the version of the Ops Agent. If you are running an older version, youalso see a recommendation to upgrade your agent.

• Pending: The Ops Agent is being installed or upgraded.

  If the agent installation remainsPending for more than 10 minutes,then there might be a problem in applying the Ops Agent OS policy orstarting the agent. For troubleshootinginformation, seeAgent diagnostics tool for automatic installation policies.

• Agent installation failed: Installation of the Ops Agent failed.For troubleshooting information, seeAgentfails toinstall.

• Not Collecting Telemetry: Installation of the Ops Agent succeeded, butthe agent isn't yet sending telemetry.

  It usually takes about 10 minutes fortelemetry to flow from a new agent. You can refresh the page to update thestatus. If this status persists for longer than 10 minutes, it mightindicate a problem with the ingestion of the telemetry. For more information,seeAgent is installed but notrunning.

• Legacy Agent: You are running the legacy Monitoring or theLogging agent.SeeMigrating from the legacy agents to theOps Agentfor information on transitioning to the Ops Agent.

• Not applicable: This VM is not a supported platform for running the agent.

• VM Stopped: The VM is not running, so the agent's status is not known.

You can install the Ops Agent by doing the following:

• Select the VM instances on which you want to install agents.
• Click theInstall/Update Ops Agent option on theInstances table.

You can also install or update the Ops Agent fromtheVM Details page for a specific VM.

When possible, the agent is installed by using an Ops Agent OS policy.For more information, seeManage VMs covered by the Ops Agent OS policy.Ops Agent OS policies aren't supported on all versions of all operatingsystems. In this case, clickingInstall/Update Ops Agent providesa series of commands to run in Cloud Shell.

The Ops Agent collects both metrics and logs by default. You can changethis default behavior byconfiguring the Ops Agent.

Compute Engine

1. In the Google Cloud console, go to theVM instances page:

   Go toVM instances

   If you use the search bar to find this page, then select the result whose subheading isCompute Engine.

2. Click the name of the VM on which you want to install the agent.

3. Click theObservability tab.

4. ClickInstall Ops Agent.

   When possible, the agent is installed by using an Ops Agent OS policy.For more information, seeManage VMs covered by the Ops Agent OS policy.Ops Agent OS policies aren't supported on all versions of all operatingsystems. In this case, clickingInstall/Update Ops Agent providesa series of commands to run in Cloud Shell.

   The Ops Agent collects both metrics and logs by default. You can changethis default behavior byconfiguring the Ops Agent.

   If the agent installation remainsPending for more than 10 minutes,then there might be a problem in applying the Ops Agent OS policy orstarting the agent. For troubleshootinginformation, seeAgent diagnostics tool for automatic installation policies.

Linux

1. Edit the following configuration file (create the file if it doesn't alreadyexist):

    /etc/systemd/system.conf

2. Add the following to the file:

    DefaultEnvironment="HTTP_PROXY=http://proxy-ip:proxy-port" "HTTPS_PROXY=http://proxy-ip:proxy-port" "NO_PROXY=http://metadata.google.internal"  # Skip proxy for the local Metadata Server.

3. Reload the environment variables:

   sudosystemctldaemon-reload

4. Restart the agent by running the following command on your VM instance:

    sudo systemctl restart google-cloud-ops-agent"*"

Windows

1. If you use an HTTP proxy, run the following command from anadministrator command prompt. This sets theHTTP_PROXY andHTTPS_PROXYenvironment variables so that the agent can send data using outbound HTTPS:

   setx HTTP_PROXY http://proxy-ip:proxy-port /msetx HTTPS_PROXY http://proxy-ip:proxy-port /msetx no_proxy "metadata.google.internal,169.254.169.254" /m

Google Cloud console

To see the version of your Ops Agent on a VM:

• Locate the entry for the VM in theInstances table in theMonitoringVM Instances page. For navigation information,seeInstall the agent by using the Google Cloud console.

• Hover over theOps Agent indicator in the table entry.

CENTOS / RHEL

Run the following command on Red Hat or CentOS Linux:

rpm --query --queryformat '%{NAME} %{VERSION} %{RELEASE} %{ARCH}\n' google-cloud-ops-agent

DEBIAN / UBUNTU

Run the following command on Debian or Ubuntu:

dpkg-query--show--showformat'${Package}${Version}${Architecture}${Status}\n'google-cloud-ops-agent

SLES / SUSE

Run the following command on SUSE:

rpm --query --queryformat '%{NAME} %{VERSION} %{RELEASE} %{ARCH}\n' google-cloud-ops-agent

WINDOWS

Run the following command on Windows:

googet installed google-cloud-ops-agent

LINUX

Run the following command on your instance:

     sudo systemctl restart google-cloud-ops-agent

Windows

1. Connect to your instance using RDP or a similar tool and login to Windows.

2. Open a PowerShell terminal with administrator privileges by right-clicking thePowerShell icon and selectingRun as Administrator.

3. Run the following PowerShell command:

Restart-Service google-cloud-ops-agent -Force

Google Cloud console

You can upgrade the Ops Agent by using Cloud Monitoring installationinstructions. For more information, seeInstall the agent by using theGoogle Cloud console.

Linux

To upgrade the agent to the latest version, run the following command:

sudo bash add-google-cloud-ops-agent-repo.sh --also-install

To upgrade the agent to the latest point release of a specific major version,run the following command:

sudo bash add-google-cloud-ops-agent-repo.sh --also-install \  --version=MAJOR_VERSION.*.*

Windows

To upgrade to the latest agent release:

1. Connect to your instance using RDP or a similar tool and login to Windows.

2. Open a PowerShell terminal with administrator privileges by right-clicking thePowerShell icon and selectingRun as Administrator.

   Note: If you're upgrading your agent from a version earlier than 2.0.3 toversion 2.0.3 or later, the upgrade removes the old config file. If youcustomized your agent configuration, be sure to save a backup of yourconfiguration file before upgrading, and then to apply the necessarychanges to the configuration file after the upgrade.

   Copy-Item -Path "C:\Program Files\Google\Cloud Operations\Ops Agent\config\config.yaml" -Destination "C:\Program Files\Google\Cloud Operations\Ops Agent\config\config.bak"

3. Run the following PowerShell commands to remove your installed agent and to run theinstallation command:

   googet -noconfirm remove google-cloud-ops-agentgooget -noconfirm install google-cloud-ops-agent

CENTOS / RHEL

List the available versions of the agent:

sudo yum list --showduplicates google-cloud-ops-agent

DEBIAN / UBUNTU

List the available versions of the agent:

sudo apt-cache madison google-cloud-ops-agent

SLES / SUSE

List the available versions of the agent:

sudo zypper search -s google-cloud-ops-agent

WINDOWS

List the available versions of the agent:

googet available google-cloud-ops-agent

Linux

Run the following command:

sudo bash add-google-cloud-ops-agent-repo.sh --uninstall

Optionally, to remove the repository in addition to uninstalling the agent,append--remove-repo to the previous command.

Windows

To uninstall the Ops Agent, follow the following steps:

1. Connect to your instance using RDP or a similar tool and login to Windows.

2. Open a PowerShell terminal with administrator privileges by right-clicking thePowerShell icon and selectingRun as Administrator.

3. Run the following PowerShell command:

   googet -noconfirm remove google-cloud-ops-agent