Edit

Elastic Monitoring installation

This guide describes Elastic Monitoring installation on top of an existing SPA environment.

For the installation type, obtain the following package: workfusion-full-package-\[release_version\]-\[build_number\].tar.gz.

Installing Elastic Monitoring Master

Install the Monitoring Master on the APM server.

Configurable parameters

Required values

Parameter	Default	Description
mon_agent_hostname	None	Define Server hostname to be displayed on monitoring dashboards. Example: apm.example.com

Optional values

Parameter	Default	Description
metricbeat_system_scrape_period	30s	The time interval (in seconds) when metrics are sent to the Elastic Monitoring Master.
metricbeat_top_processes_memory_count	10	Top memory consuming processes to evaluate.
metricbeat_top_processes_cpu_count	10	Top CPU-consuming processes to evaluate.
curator_indices_close_days	14	Retention settings (in days) for Elastic Monitoring indices.
curator_indices_delete_days	60	Retention settings (in days) for Elastic Monitoring indices.
heartbeat_monitors_http_schedule	60s	Time interval (in seconds) used to run Heartbeat monitors.

Installation steps

1. Create a directory of your choice in the file system where you want to extract the installation package.

2. Grant all users read access to this directory:

   mkdir -p /opt/workfusion/wf_installer
   chmod 0755 /opt/workfusion/wf_installer
   

3. Download and unpack the installation package and change the directory to the target folder:

   tar -xzf workfusion-full-package-[release_version]-[build_number].tar.gz  --strip 1 -C /opt/workfusion/wf_installer
   cd /opt/workfusion/wf_installer
   

4. In config.yml (as root), add the following required options if they are missing:

   apm_hostname: apm.example.com
   mon_agent_hostname: apm.example.com
   wf_user: wfuser
   wf_group: wfuser
   install_dir: /opt/workfusion
   passwords_check: false
   

   You are required to move CA.cert, apm.crt, and apm.key from the existing installation to the certificates folder.

5. Run the [precheck] installation step (as root):

   ./install.sh precheck mon-master
   

6. Change user to default user wfuser:

   su - wfuser
   

7. Run the [install] installation step (as wfuser):

   ./install.sh install mon-master
   

8. Run the [check] installation step (as wfuser):

   ./install.sh check mon-master
   

Installing Elastic Monitoring Agent

The Monitoring agent should be installed on every monitored host. APM already has Agent components installed after the Master installation.

Configurable parameters

Required values

Parameter	Default	Description
mon_agent_hostname	None	Define the server hostname to be displayed on monitoring dashboards. Example: db.example.com

Optional values

Parameter	Default	Description
metricbeat_system_scrape_period	30s	The time interval (in seconds) when metrics are sent to the Elastic Monitoring Master.
metricbeat_top_processes_memory_count	10	Top memory consuming processes to evaluate.
metricbeat_top_processes_cpu_count	10	Top CPU consuming processes to evaluate.

Installation steps

1. Create a directory of your choice in the file system where you want to extract the installation package.

2. Grant all users read access to this directory:

   mkdir -p /opt/workfusion/wf_installer
   chmod 0755 /opt/workfusion/wf_installer
   

3. Download and unpack the installation package and change the directory to the target folder:

   tar -xzf workfusion-full-package-[release_version]-[build_number].tar.gz  --strip 1 -C /opt/workfusion/wf_installer
   cd /opt/workfusion/wf_installer
   

4. In config.yml (as root), add the following required options if they are missing:

    apm_hostname: apm.example.com
    mon_agent_hostname: db.example.com
    wf_user: wfuser
    wf_group: wfuser
    install_dir: /opt/workfusion
    passwords_check: false
   

5. Run the [precheck] installation step (as root):

   ./install.sh precheck mon-agent
   

6. Change the user to wfuser:

   su - wfuser
   

7. Run the [install] installation step (as wfuser):

   ./install.sh install mon-agent
   

8. Run the [check] installation step (as wfuser):

   ./install.sh check mon-agent