The Agent Installer requires microservices configuration performed by AppDynamics. The configurations will be rolled out gradually to SaaS Controllers beginning on June 8, 2020.
This page guides you through the steps required to use the AppDynamics Agent Installer, which streamlines the deployment of the Java and Machine Agents. The Agent Installer simplifies the agent installation process. With two lines of script, the installer:
- Deploys the Java and (optionally) Machine Agents
- Automatically instruments applications
- Assigns unique names to tiers and nodes
Overview of the Agent Installer
To understand how the Agent Installer works, familiarize yourself with the following terms:
- Agent Installer - Executable installer inside the Zero Agent zip file. The Agent Installer installs the Zero Agent along with Java and Machine Agents on a system. Access the installer in the Controller UI.
- Decorator - Library responsible for automatically instrumenting new processes with AppDynamics APM agents. The library auto-instruments the application and auto-names tiers and nodes for the Controller.
- Zero Agent - Software bundle that manages the Decorator, Java Agent, and Machine Agent. Enables automatic instrumentation and reports the status of various processes to the Controller UI. Collective term for the decorator, agent
daemon, agent binaries.
- Downloader - Script (
zero-agent.sh) that downloads individual zip files containing the Java, Machine (if applicable), and Zero Agents.
Make sure you meet the following Agent Installer requirements for components, permissions and supported environments.
- The Agent Installer requires SaaS Controller version 20.6.0 and later.
- You also need sufficient APM licenses to use the Java and Machine Agents. No additional license is required for the Zero Agent.
- Access to your specific AppDynamics-related URL:
- Access to the AppDynamics download files site:
Agent Installer Permission
To use the Agent Installer, you need Install Agent account-level permission and at least one of the following:
- Any default role
- Any application-level permission
- Any dashboard permission
- Execute Workflow account-level permission
Install Agent permission is not added to any default role. See Roles and Permissions for more information on creating roles.
The table below lists supported environments for the Agent Installer.
|Agent Installer Supported Environments|
Linux (64 bit). Fully tested flavors:
Other Linux operating systems and versions should work but are not certified by AppDynamics.
Available Agents with the Agent Installer
The Agent Installer deploys the Zero Agent, which downloads app server agents to your machine. Currently, you can install:
- Java Agent version 4.5.15 and later
- Machine Agent version 4.5.15 and later
See Java Supported Environments and Machine Agent Requirements and Supported Environments for details regarding Java and Machine Agent version compatibility.
The limit for the number of active agent registrations per account is 1000.
Use the Agent Installer
To use the Agent Installer:
- In the Controller UI, go to Home > Agent Installer.
Select an existing application or click New application.
Application names cannot contain a single quotation mark.
- Select the agent(s) you want to install.
- After you select an agent(s), a command is generated. Copy and paste the command in your terminal.
When you run the command on a designated host, the agent files download onto that host only. If you want to deploy the Agent Installer to a large number of hosts, see Run the Agent Installer on Multiple Hosts.
Choose how you want to run the installer.
Instrument processes for all system users - runs the installer with
sudopermission and enables the Zero Agent for all users on the host.
Instrument processes for an individual user - runs the installer without
sudopermission and enables the Zero Agent for the current user only.
See Sudo vs. Non-Sudo Access for more information.
- After you select how to instrument the processes, another script is generated. Input the script in your terminal.
- Restart the application processes.
- Click Next in the Agent Installer UI to finish instrumentation.
After you finish installing the agents, you are redirected to the Monitoring Settings tab to view instrumented tiers and nodes.
Sudo vs. Non-Sudo Access
You can run the Agent Installer with or without
sudo permission. AppDynamics recommends using the
sudo command to install the agents for all users in your system.
The table below details the differences between
|Description||Installs the agents on all supported processes for all users in your system||Installs the agents for the current user only.|
|Automatic Instrumentation Process||By default, integrates with ||Auto-instruments processes that are started by the installing user, running under a Linux shell such as bash.|
Works for Java and Java/Machine Agent bundle
|Works for Java Agent only.|
Run the Agent Installer on Multiple Hosts
You can download the Agent Installer once and run on multiple hosts. To install the agent bundle across multiple hosts, distribute the binaries to all applicable machines.
For example, the steps below demonstrate how to move files across hosts with the
- Download the agent bundle (see steps 1-3 in Use the Agent Installer).
- Distribute the Agent Installer to multiple hosts.
- Make sure you are in the same directory in which you downloaded the agent bundle.
tarcommand to put the script in a single file:
Copy the file to multiple hosts:
Extract the archived script in the same directory:
- Complete the Agent Installer process (see steps 5-8 in Use the Agent Installer).
Upgrade the Agent Installer
If you want to upgrade the Java and Machine Agents running through the Agent Installer, you need to uninstall your current agents. In the terminal, navigate to the directory where the Zero Agent is installed and run the following command:
You can now install the new versions of the Java and Machine Agents with the Agent Installer (see Use the Agent Installer).
Customize the Agent Installer
See Customize the Agent Installer to learn how to modify the agent configuration.