Skip to content

SAS9 on Linux Quick Start Guide

Welcome to the SAS Enterprise Session Monitor Quick Start guide for SAS 9. In this tutorial you will complete a basic SAS Enterprise Session Monitor installation, including integration with a SAS 9 deployment on a Linux system.

Before you begin

A SAS Enterprise Session Monitor deployment is completed in three stages:

"Quick Start Steps"

We must always complete our installations in this order because each stage, apart from the Server component installation, has a dependency on the previous stage.

Before you begin, you should ensure that your system meets the minimum system requirements:

  • The SAS Enterprise Session Monitor Server - Linux
  • The SAS Enterprise Session Monitor Agent - Unix

Step 1: Download and Install the Server

  1. Download the latest version1 of the Server component to the machine where you want to run the Server from. The installation packages come as either esm-server-linux-<version>.tar.gz or esm-server-win-<version>.zip depending on whether you are installing on Linux or Windows2.
  2. Unpack the archive to a suitable temporary location. When extracted, it will create a new folder called "esm-server-installer". 
    tar xzf ./esm-server-linux-<version>.tar.gz -C /pub/esm

  3. Change directory to the destination of the unpacked installation package and execute the setup.sh script to start the SAS Enterprise Session Monitor Server installation wizard. 

    cd /pub/esm/esm-server-installer/
./setup.sh

  4. The SAS Enterprise Session Monitor Server installation wizard will now start. We can accept the defaults for all options but you will want to make note of or consider changing the following:

  5. The esm-server install path: This the location where the installation wizard will deploy the Server in a folder called esm-server. On Linux, the default is the home directory of the executing user and on Windows the default is C:\esm.

  6. The SAS Enterprise Session Monitor admin settings username and password: This is the default administrative account for your installation. It is the username/and password that we will use to access the UI.

  7. Once the installation wizard has completed, and after about 30 seconds, the Enterprise Session Monitor UI will become available at: http://:18080/esm/. When you successfully login to the application for the first time, it will prompt you for a license key. You can find this in the email that was sent be SAS Licensing Operations.

Step 2: Download and Install the Agent

Elevated Permissions Required

In order to be able to install the Agent, elevated permissions are needed on all platforms. On Linux systems, this can either be with direct access to the root account, or with sudo.

  1. Download the latest version1 of the Agent component to the machine where you want to run the Server from. The installation packages come as either esm-agent-linux-<version>.tar.gz or esm-agent-win-<version>.zip depending on whether you are installing on Linux or Windows2.

  2. Unpack the archive to a suitable temporary location. When extracted, it will create a new folder called "esm-agent-installer". 

    tar xzf ./esm-agent-linux-<version>.tar.gz -C /pub/esm

  3. Change directory to the destination of the unpacked installation package and execute the setup.sh script to start the SAS Enterprise Session Monitor Agent installation wizard. 

    cd /pub/esm/esm-agent-installer/
sudo ./setup.sh

  4. The SAS Enterprise Session Monitor Agent installation wizard will now start. We can accept the defaults for all options but you will want to make note of or consider changing the following:

  5. The Server hostname/IP address: The Agent installation wizard will prompt for the hostname or IP address of the Server machine. As part of the installation process, the Agent will check connectivity to the Server. If a connection cannot be made, the installation wizard will exit.

  6. The Agent install path: This the location where the installation wizard will deploy the Agent in a folder called esm-agent. On Linux, the default is the home directory of the executing user and on Windows the default is C:\esm. You must change this to a location that will be accessible to all users.

Step 3: Integrate with SAS

  1. Copy and paste the below code block into the sasenv_local file of your SAS installation (for example, /sas/SASFoundation/9.4/bin/sasenv_local) updating the value of the ESMHOME variable to the location of your SAS Enterprise Monitor Agent. 

    # ESM CONFIG START
export ESMACTIVE=1
export ESMHOME=/path/to/esm-agent
if [ -f $ESMHOME/bin/esm-bootstrap.sh ]; then
  . $ESMHOME/bin/esm-bootstrap.sh
fi
# ESM CONFIG END

  2. Update line 9 of /path/to/esm-agent/bin/esm-bootstrap.sh by adding a semi-colon separated list of any additional SAS application server contexts that exist in your deployment.

Congratulations! You have completed a basic installation and configuration of SAS Enterprise Session Monitor. You've deployed and tested the UI of the Server, installed the Agent, and configured SAS to tell ESM about every session that starts. If you start using SAS, you will see your sessions appear in the Live View of the UI.

If you're looking for some next steps or some more advance configuration options, perhaps consider looking at:

  1. This site is password protected. Your username and password for this site can be found in the email that contains your SAS Enterprise Session Monitor license key. ↩↩

  2. The <version> part of the installation package be an actual version number when you download the package. ↩↩

Last update: July 19, 2023
Created: April 24, 2023