Articles in this section

See more

Agent Installation Guide for Linux (Versions: 7.2-)

QuerySurge Agents

QuerySurge Agents are delegated the actual query tasks by QuerySurge. By default, the QuerySurge Agent installs as a service – so it will start automatically when your Agent platform restarts, does not require a user to be logged in and has no user interface.

Deploy your Agent(s) to suitable boxes in your environment. While Agents may be deployed to any supported Windows platform, or to any supported Linux platform, please note that the physical resources (principally RAM) of the deployment platform may limit the overall resultset size your Agents can handle. More memory is always better.

QuerySurge Agent Installation Location

Agents should be installed on wire-connected platforms on the same network as your QuerySurge App server. Installing Agents on machines that might be connected via WiFi or by VPN will not only send potentially large amounts of data over a narrow connection but may also expose data on an insecure connection. Additionally, network topology, especially over VPN, may slow or interfere with the connection.

Note: Agents should never be co-installed with other programs or processes that might interfere with or hook the Agent process. This includes, but is not limited to, co-installation with products like automated GUI-testing tools.

QuerySurge Agent Installation

Prepare for Installation

  1. Download the QuerySurge Installer to the machine(s) you want to install the Agent on. Note that you must use the same installer version to install an Agent as your QuerySurge version.
     
  2. At the linux prompt on each machine, use the cd command to go to the directory in which you have downloaded the installer.
     
  3. At the prompt, issue the command ls –al to check the filename. You should see a listing similar to the following (where ‘x.x.x’ is the QuerySurge version number):
    -rw-rw-r--. 1 root root 232635922 Nov 21 11:07 querysurge-installer-x.x.x-linux-x64.run

     
  4. To make the installer file executable, type chmod +x <filename> at the prompt, where <filename> is the QuerySurge installer name from the previous command:
    chmod +x querysurge-installer-x.x.x-linux-x86.run

     
  5. Type ls -al again to confirm the change; at the left of the file listing, you should see rwxrwxr-x:
    -rwxrwxr-x. 1 root root 232635922 Nov 21 11:07 querysurge-installer-x.x.x-linux-x64.run

     

 Install a QuerySurge Agent
 

  1. On a box designated for a QuerySurge Agent, issue the following command at the prompt: ./<filename> where <filename> is the QuerySurge installer (where ‘x.x.x’ is the QuerySurge version number):
    ./querysurge-installer-x.x.x-linux-x86.run

    If the box has a desktop, then use:
    ./querysurge-installer-x.x.x-linux-x86.run --mode text
  2. Press the 'Enter' key as required  to review the license agreement, which begins:

    ------------------------------------------------------------------
    Welcome to the QuerySurge Setup Wizard.
    ------------------------------------------------------------------ 
    Please Please read the following License Agreement. You must accept the terms of this agreement before continuing with the installation.

    Press [Enter] to continue :

    EVALUATION AGREEMENT
    THIS EVALUATION AGREEMENT (?AGREEMENT?) IS ENTERED INTO BY AND BETWEEN REAL-TIME
    TECHNOLOGY SOLUTIONS, INC. (?RTTS?) AND ?EVALUATOR?.  BY CLICKING ON THE
    "ACCEPT" BUTTON, YOU OR THE ENTITY OR COMPANY THAT YOU REPRESENT (?EVALUATOR?)
    ARE UNCONDITIONALLY CONSENTING TO BE BOUND BY AND ARE BECOMING A PARTY TO THIS
    AGREEMENT.  EVALUATOR?S INSTALLATION AND USE OF THE PRODUCT SHALL ALSO
    CONSTITUTE ASSENT TO THE TERMS OF THIS AGREEMENT.  IF EVALUATOR DOES NOT
    UNCONDITIONALLY AGREE TO ALL OF THE TERMS OF THIS AGREEMENT, CLICK THE "CANCEL"
    BUTTON.  IF THESE TERMS ARE CONSIDERED AN OFFER, ACCEPTANCE IS EXPRESSLY LIMITED
    TO THESE TERMS.  BY CLICKING ?ACCEPT? YOU ACKNOWLEDGE AND AGREE ON BEHALF OF
    YOURSELF AND YOUR EMPLOYER TO BE BOUND TO THIS AGREEMENT.  YOU REPRESENT THAT
    YOU ARE AUTHORIZED TO ACCEPT THIS AGREEMENT ON YOUR EMPLOYER?S BEHALF.

  3. Type 'y' to accept the license agreement:

    Press [Enter] to continue :

    Do you accept this license? [y/n]: y

  4. Specify the directory where you want QuerySurge to be installed or press  'Enter' to accept the default location:

    ------------------------------------------------------------------ 
    Please specify the directory where QuerySurge will be installed.
    Installation Directory [/opt/QuerySurge]:

  5. Type  'y' at 'Agent' to install the Agent and 'N' for all other components.
    ------------------------------------------------------------------ 
    Select the components you want to install; clear the components you do not want to install.
    Database [Y/n]: N
    App Server [Y/n]: N
    Agent [Y/n]: Y
    Tutorial + Sample Data [Y/n]: N
    Command Line API [y/N]: N
    Test Management Tool Connectors [y/N]: N
  6. Press the 'Enter' key to confirm your selections
    Is the selection above correct? [Y/n]: y
  7. Press the 'Enter' key to confirm installation of QuerySurge as a service:
    ------------------------------------------------------------------
    Install Service
    Install QuerySurge as a service
    Install as a service? [Y/n]: y
  8. Type  'y' for each of the bundled JDBC driver selections that you want to deploy:

    Oracle (ojdbc7) [y/N]:
    Teradata (terajdbc4) [y/N]:
    Sybase (jTDS 1.3.1) [y/N]:
    Flat File and XML (JStels) [Y/n]:
    MS SQL Server (sqljdbc4) [y/N]:
    MySQL (Connector/J 5.1.33) [Y/n]:

    Amazon Redshift [y/N]:

    [1] –Select—
    [2] Apache Hive 1.2.1
    [3] Cloudera CDH 5.5
    [4] Hortonworks 2.3
    Please choose an option [1] :

    Note: If you do not see your specific data source technology listed, you will be able to add additional vendor drivers to QuerySurge post-installation. See your vendor website for driver download information. The procedure for "manually" adding a driver to an Agent is discussed here.

  9. You will need to accept the license terms for the drivers you have selected by typing 'y' at each request.

  10. Press the 'Enter' key to test the connection with the QuerySurge App Server:

    Test Agent Connection
    With Server [y/N]: y

     

  11. Enter the hostname and port for the QuerySurge App Server. You may use the IP address or the hostname of the QuerySurge App Server. The default HTTP Port is 80.
    ------------------------------------------------------------------
    Agent Connection
    QuerySurge agents need a connection to the QuerySurge App server.
    The hostname of the QuerySurge App server
    Hostname []: <Hostname of App Server>
    The port of the QuerySurge server
    Port [80]: <App Server HTTP Port>

  12. Press the 'Enter' key to confirm the installation of QuerySurge
    ------------------------------------------------------------------ 

    Setup is now ready to begin installing QuerySurge on your computer. Do you want to continue? [Y/n]: y
  13. The QuerySurge Agent should install. This will take several minutes (< 10 min)

  14. Once the installer has completed, your QuerySurge Agent should be installed, and should have self-registered with QuerySurge, but it will not be Enabled. Log into QuerySurge as a QuerySurge Admin user, and navigate to the Admin view. In the upper left of the Admin view, click on Agents in the Admin tree. A list of existing Agents will show in the grid in the main panel. Locate the Agent you have just installed, and Enable it by clicking on the checkbox in the Enabled column. In the lower right of the main panel, click on the Refresh button. You should now see in the Last Ping column that the Agent has successfully pinged into QuerySurge.

  15. You may want to install additional Agents (a minimum of one is required). There is a limit of one Agent install per Operating System (OS). You can repeat this procedure on additional OS's. To deploy multiple Agents on a single OS, download QuerySurge's Agent docker container. See this Knowledge Base article for details.

Enable your QuerySurge Agent

  1. When you installed the Agent, you connected the Agent to QuerySurge (Step 10 above). This allowed the Agent to automatically register itself with QuerySurge. However, while the Agent is registered, it is not enabled. It is also not available to any QuerySurge Project, nor is it enabled for any Project.
     
  2. To enable your Agent globally, log into QuerySurge as a QuerySurge Admin. Use the menu or the toolbar to go to the Admin view in QuerySurge. Click on the Agents node in the left nav tree. Find your new Agent, and click the slider in the EnabledGlobally column for the Agent to globally enable your Agent. This step  enables your Agent globally for use but does not assign it to a project or enable it on a project. 


     
  3. Double-click on the newly enabled Agent (or single-click and use the Edit button) to access the Edit Agent dialog. Click on the Projects tab and add your Agent to one or more Projects (using the mceclip2.png "Add Project" icon). Click Save (lower right).
     
  4. You will need to log into the Project(s) to which you have assigned the Agent as a Project Admin, and go to the Admin view, where you'll need to use the left nav to click on the Agents node. Find your Agent, and, in the Enable in Project column, click on the slider to enable your Agent at the Project level.



    Now your Agent is both globally enabled and enabled in your Project(s), and should be available to handle QuerySurge execution runs.

 

Related articles