Site24x7 APM Insight Java agent – Ansible role

Overview

You can deploy and configure the Site24x7 APM Insight Java agent on your application servers using an Ansible role. It supports popular application servers and frameworks like Apache Tomcat, Eclipse Jetty, and WildFly.

Requirements

• The unzip command must be available on target hosts.
• Supports operating systems such as RedHat, Rocky, AlmaLinux, Debian, and Darwin.
• Ansible should be installed on the control node. Ansible Installation Guide.

Configuration

The following properties can be configured in the Site24x7 APM Insight Ansible role to enable application performance monitoring.

APM Insight configuration properties

These settings can be specified through the apminsight_props variable to define essential configurations for application monitoring.

Role installation properties

These properties define the server-specific configurations required to integrate the Site24x7 APM Insight agent with your web server.

Installation of Site24x7 APM Insight Java agent with Ansible

Follow the steps to configure the Site24x7 APM Insight Java agent on your application servers using an Ansible role.

Step 1: Extract and set up the role

1. Use the following command to extract the Ansible role and rename it to Site24x7-APM:

curl -L -o Site24x7-APM-Ansible-main.zip https://github.com/site24x7/Site24x7-APM-Ansible/archive/refs/heads/main.zip && unzip Site24x7-APM-Ansible-main.zip && mv Site24x7-APM-Ansible-main Site24x7-APM

2. Once the zip file is extracted using the command above, the final folder structure, including the my-playbook.yml and my-inventory.yml files, should appear as follows:

   ├─ Site24x7-APM
   ├    ├── defaults
   ├    ├── handlers
   ├    ├── meta
   ├    ├── tasks
   ├    ├── tests
   ├    ├── vars
   ├    ├── README.md
   ├─ my-playbook.yml
   ├─ my-inventory.yml

Step 2: Configure the inventory and playbook

1. Create an inventory file as follows.

   Example my-inventory.yml file:

   prod_webserver:
     vars:
       ansible_user: fedora
       server_type: tomcat
     hosts:
       java_server_one:
         ansible_host: 10.0.20.5
         java_agent_host_config:
           app_name: Example App
       java_server_two:
         ansible_host: 127.0.40.2

2. Create a playbook file as follows.
   

   Example my-playbook.yml file:

   - hosts: prod_webserver
     vars:
       apminsight_props:
         app_name: <Your Application Name>
         license_key: <Your License Key>
       install_props:
         server_type: 'tomcat'
         jvm_config_file: '/usr/share/tomcat8/bin/setenv.sh'
         service_name: 'tomcat'
         server_version: '8'
         restart_web_server: true
     tasks:
      - include_role:
          name: Site24x7-APM

Step 3: Install the agent

1. Run the Ansible playbook using the following command:

   ansible-playbook -i ./my-inventory.yml ./my-playbook.yml

2. Verify that the agent is installed and the application server is running as expected.

Uninstallation

To uninstall the Site24x7 APM Insight Java agent using Ansible, you can use the following variable property in your Ansible playbook:

Example Ansible playbook

Here is an example Ansible playbook that uninstalls the Site24x7 APM Insight Java agent:

- hosts: webservers
  vars:
    uninstall: true
  tasks:
   - include_role:
       name: Site24x7-APM

This will initiate the uninstallation process.