Edit

Elastic monitoring installation

The guide describes Elastic Monitoring installation on top of the existing SPA environment

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

Installing Elastic Monitoring Master

Monitoring master server should be installed on APM server.

Configurable parameters

Required values

Parameter	Default	Description
mon_agent_hostname	None	Define Server hostname that will 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 directory of your choice on the file-system where you want to extract the installation package.

   Grant read access for this directory to all users:

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

2. Download and unpack monitoring package and change 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
   

3. The following options are required. Add them if they are missing in config.yml (as root):

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

4. Place 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 a user to the default user WF_USER:

   su - wfuser
   

7. Run the 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

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

Configurable parameters

Required values

Parameter	Default	Description
mon_agent_hostname	None	Define Server hostname that will 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 directory of your choice on the file-system where you want to extract the installation package.

   Grant read access for this directory to all users:

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

2. Download and unpack lightweight monitoring package and change 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
   

3. The following options are required. Add them if they are missing in config.yml (as root):

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

4. Run the precheck installation step (as root):

   ./install.sh precheck mon-agent
   

5. Change a user to WF_USER:

   su - wfuser
   

6. Run the installation step (as wfuser):

   ./install.sh install mon-agent
   

7. Run the check installation step (as wfuser):

   ./install.sh check mon-agent