Deploy Agent Packages Using APM Command Center

CA APM Command Center lets you create and deploy agent packages onto application servers. Packages are a deployable set of agent binaries and configuration files in ZIP or TAR format. Each package comprises several bundles. A bundle is a compact piece of agent functionality.
apmdevops106
CA APM Command Center lets you create and deploy agent packages onto application servers. Packages are a deployable set of agent binaries and configuration files in ZIP or TAR format. Each package comprises several bundles. A
bundle
is a compact piece of agent functionality.
The terms bundle and extension are interchangeable in Command Center.
You complete the following high-level steps to deploy agent packages:
  1. You create a package to fit your target application environment, add and remove bundles, and configure the package to your needs. You download the package as an archive file to install the agent. The agent then reports the package information in Command Center.
  2. You import and configure the bundles and upgrade the packages. For more information about package management, see Manage Agent Packages and Bundles Using APM Command Center.
Create an Agent Package
To monitor your application environment, create an agent package. An agent package is a deployable set of agent binaries and configuration files in ZIP or TAR format.
At any time during the process, you can select
Previous
to return to the previous screen.
Follow these steps:
  1. Go to the
    Home
    tab in Command Center, and download the Controller for your operating system (Windows or Linux) to each application server.
  2. Go to the
    Packages
    tab in Command Center and select
    New
    .
    The Agent Builder wizard opens.
  3. Enter a
    Package
    Name
    and
    Description
    .
  4. Select an
    Operating System Type
    (UNIX or Windows).
  5. Select a
    Process
    . The Process defines the application environment that you want to monitor.
  6. Select an
    Agent Version
    .
    When you select the
    Agent Version
    , you can add only the bundles available for that version to the package.
  7. (Optional) Enter one or more of the
    Enterprise Manager IP Addresses and Ports
    to which the agent connects. Leave this field empty if you want to deploy the package to different Enterprise Manager clusters.
  8. Select
    Done
    to save the package.
Now that you created a package, add or remove bundles to the package and configure agent functionality.
Use a Bundle in a Package
Each agent package comprises several bundles. A bundle represents a compact piece of agent functionality. For example, a bundle exists for SQL, web services, HTTP backends, servlet, and JSP.
Customize your package in Command Center:
  • Add and remove bundles when you create a package and edit the bundles later
  • Change the bundle configuration
  • Edit the default installation instructions for other users
In the Select Bundles tab of the Agent Builder, two columns list available and selected bundles:
  • Available Bundles
    Optional bundles for special monitoring that are compatible with your environment.
    Example
    The LeakHunter bundle
  • Selected Bundles
    Default, preselected bundles that are required or recommended for monitoring in your environment.
    Example
    You must use the Struts bundle for monitoring Tomcat. We recommend that you use that web bundle for Tomcat.
The bundles that are listed in both columns are grouped according to their type:
  • Core
    Core monitoring components, such as the Java Agent binaries or Command Center extension.
  • Environment
    Depending on the platform, the Environment group contains bundles that monitor the application server.
  • Features
    Various APM monitoring features to enhance metrics visibility.
  • Custom
    Unofficial bundles. For more information, see Add Custom Bundles.
When you select a bundle, information about the bundle functionality appears. If the selected bundle depends on other bundles, these bundles are highlighted.
For a full list of bundles that are included in the installation, see List of Bundles.
Add a Bundle to a Package
Before you can configure a bundle, you must add it to your agent package.
Follow these steps:
  1. Go to the
    Packages
    tab in Command Center.
    A list of packages appears.
  2. Select the package that you want to configure.
    Basic information for the package displays.
  3. Select
    Edit
    .
    The Agent Builder opens.
  4. To add or remove bundles and change the bundle configuration, select
    Customize
    .
    The
    Select Bundles
    tab opens.
  5. Select the bundles appropriate for your monitoring needs, and select
    Add
    .
    Filter the bundles by property name using the search function.
  6. (Optional) Select
    Get More Bundles
    to obtain extra bundles from the CA Marketplace.
  7. Select
    Done
    to save the bundles in the package.
Configure Bundle Properties and Installation Instructions
You configure a bundle by editing current properties or adding new ones. You can edit the bundles and configuration instructions when you create the package or later. Command Center shows the installation instructions for a created package. These instructions comprise all installation instructions for the individual bundles that are included in the package. Edit these instructions to convey information specific to agent deployment in your environment for other users. For text formatting, use markdown language syntax. For more information, see Markdown language syntax.
The changes that you make are specific to the package that you edit and do not propagate to other packages.
Follow these steps:
  1. Go to the
    Packages
    tab in Command Center.
    Command Center shows a list of available packages.
  2. Select the package that you want to configure.
    Basic information for the package displays.
  3. Select
    Edit
    .
    The Agent Builder opens.
  4. (Optional) Change the agent package as needed. For more information, see Create Agent Packages.
  5. Select
    Next
    to move through the
    Select Bundles
    screen.
    The
    Configure Bundles
    tab opens. Here you can view all properties from the
    IntroscopeAgent.profile
    file. You can add or disable extensions, add comments, and make other configuration changes. 
  6. Select
    the bundle that you want to configure. Information for the bundle displays.
    Filter the bundles by property name using the search function.
    • For each property, add a new value or select an option from the drop-down list where available.
      You can revert your changes by selecting the
      Settings
      icon and
      Reset
      from the drop-down list.
    • Add a new property by selecting
      Insert New
      from the
      Settings
      icon within an existing property.
      All updated or inserted properties show a user symbol to indicate that you made changes.
    • Delete properties by selecting the
      Settings
      icon next to each property and selecting
      Delete
      .
      You can only delete the properties that you added.
  7. Add a comment to describe the reason for your change.
  8. Select
    Next
    .
    The
    Install Instructions
    screen opens.
  9. Select the
    Pencil
    icon to add notes to the Installation Instructions, and select
    Done
    when you finish.
Watch the Video on Customizing Agent Packages
Customize the content and properties of Agent Packages

Import Bundles to CA APM Command Center
You can create your own custom bundles and can import them into Command Center. For more information about creating custom bundles, see Add Custom Bundles.
Follow these steps:
  1. In Command Center, go to the
    Bundles
    tab and select the
    Import
    button.
  2. Browse for the created or downloaded bundle and select
    Open
    .
    The bundle imports.
  3. View the bundle in the
    Bundles
    list.
  4. Go to the
    Packages
    tab, and add the bundle to the desired package. For more information about adding a bundle to a package, see Create Agent Packages.
Deploy Agent Packages
You deploy agent packages from Command Center by downloading the package onto your application server. You can later upgrade an agent to a new version. You can also apply dynamic hot-deployable bundles and properties to agent bundles without manually redeploying the package. You can also use the package to add non-dynamic bundles that require a restart of the application server. These changes take effect immediately after you push them to an agent. All dynamic bundles and properties are marked with the dynamic icon in the Bundles tab. Non-dynamic bundles are marked with a restart icon in the Bundles tab of Command Center.
Follow these steps:
  1. Go to the
    Home
    tab, and download the Controller for your operating system to each application server.
  2. In APM Command Center, select
    Packages
    .
    A list of available packages displays.
  3. Select the package that you want to deploy.
    Command Center shows basic information for the package.
  4. Select the
    Package URL
    .
    The agent package downloads.
  5. Copy the agent package to the target application server.
  6. Unzip the file, and copy the unzipped file to the application server.
  7. Follow the installation instructions in the
    Install Instructions
    card of the
    Packages
    tab.
  8. Restart the application server.
    The agent appears in the
    Agent
    tab after it connects to the application server.