Skip to content

Latest commit

 

History

History
170 lines (135 loc) · 6.37 KB

README.md

File metadata and controls

170 lines (135 loc) · 6.37 KB

Site24x7 APM Insight Java Agent Ansible Role

Table of Contents

  1. Overview
  2. Requirements
  3. Configuration
  4. Example Playbook and Inventory File
  5. Usage
  6. Uninstallation
  7. License

Overview

Deploy and configure the Site24x7 APM Insight Java agent on your application servers with ease using this Ansible role. Supports popular application servers and frameworks like Apache Tomcat, JBoss, Oracle WebLogic and WildFly.

Requirements

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

Configuration

APM Insight Configuration Properties

Property Description Required
app_name Application name for monitoring No (auto-generated if omitted)
license_key Site24x7 APM Insight License Key Yes

Role Installation Properties

Property Description Required Default
server_type Web server type (e.g., tomcat, jetty, wildfly) Yes -
server_version Web server version No -
jvm_config_file Path to the web server's JVM config file. For eg. setenv.sh file in Tomcat server Yes -
service_name Service name of App Server to restart after agent installation No -
restart_web_server Restart the web server after installation No true
agent_download_dir Directory for agent files (optional) No /opt/apm
enable_agent Enable/disable the APM Insight agent No true

Example Playbook and Inventory File

my-playbook.yml

- 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'
  roles:
   - role: Site24x7-APM
  become: yes
  tasks:
  - name: Make sure service has started
    debug:
         msg: "Make sure service has started"

host-inventory.yml

 prod_webserver: # host group
  vars:
    # Here, you can apply the configuration to all hosts
    ansible_user: fedora
    ansible_password: <Your host password>
    ansible_sudo_pass: <Your sudo password>
  hosts:
    java_server_one:
      ansible_host: 10.0.20.5
      #Host-specific agent configuration goes here
      java_agent_host_config:
        #Overrides app_name set in the playbook
        app_name: Example App
    java_server_two:
      ansible_host: 127.0.40.2
      #app_name set in playbook will be used

Usage

Use the below command to extract the Ansible role & 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

Write your own Playbook called my-playbook.yml and Inventory file called my-inventory.yml and keep the files in parallel to folder Site24x7-APM

After extracting the zip file with the above command, the final folder structure with the above two files (my-playbook.yml and my-inventory.yml) should look like below

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

Run the playbook with the below command

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

Uninstallation

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

Property Description Required Default
uninstall Set to true to uninstall the agent Yes -

Example Ansible Playbook

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

uninstall-playbook.yml

- hosts: webservers
  vars:
    uninstall: true
    ansible_sudo_pass: <Your sudo password>
  tasks:
   - include_role:
       name: Site24x7-APM

Run the playbook with the below command to uninstall

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

This will initiate the uninstallation process for the Site24x7 APM Insight Java agent.

Important Notes

  • Make sure to set the uninstall variable to true to uninstall the agent. If you set it to false or omit it, the agent will not be uninstalled.
  • Replace webservers with the name of your host group in your Ansible inventory file.
  • Make sure to include the Site24x7-APM role in your playbook to uninstall the agent.

License

(The MIT License)

Copyright © 2015, 2016 Site24x7 Terms of Use (http://www.site24x7.com/terms.html) Privacy Policy (http://www.site24x7.com/privacypolicy.html) Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.