Multi Agent

Overview

QueryPie Multi Agent is an improved Proxy Agent that allows you to use multiple QueryPie Hosts simultaneously.

In the Agent UI, you can check the resources available on specific Hosts.

You can access resources through two or more QueryPie Proxies without additional configuration by simply installing the Agent and performing login for each Host.

Download Agent App and Initial Setup

1. After logging into QueryPie, click the profile in the top right corner, then click Download & Support > Multi-Agent button.
2. When the QueryPie Multi-Agent Downloads popup appears, download the installation file that matches your PC’s operating system in Step 1, then copy the QueryPie URL from Step 3.
   
3. Run the downloaded QueryPie Multi-Agent installation program and copy the .app file to the Applications folder to complete the installation.
4. When you run the installed QueryPie Agent, the Host initial registration page opens.
   Enter the QueryPie URL you copied earlier in the QueryPie Host input field and click the Next button to enter the login screen.
5. Enter your authentication information on the login page of the entered host and click the Continue button.

DAC

Connecting to Database with Agent

1. In the Database tab, you can view the Database Connection list that has been granted permissions and can use Proxy for the selected QueryPie Host.
2. Select the connection you want to connect to and right-click to open the context menu.
   1. Connection Information: You can check the information needed for Proxy connection.
   2. Open Connection With [10.2.6~]: You can connect to the connection with 3rd Party tools.
      1. DBeaver: Opens DBeaver and inserts the connection information.
         (A one-time DBeaver path recognition process is required. We recommend running this feature while DBeaver is running.)
      2. DataGrip: Connection information that can be pasted into DataGrip is copied.
      3. SQLGate for Oracle (Windows only): Opens SQLGate for Oracle and inserts the connection information.
   3. Copy as JDBC URL [10.2.6~]: Copies the JDBC URL of the selected connection.

Managing 3rd Party Database Tool Settings in Agent

You can manage 3rd Party tool-related settings in Settings > Databases.

• Database Tool Path: You can set the path of supported 3rd Party tools.
  • Auto Detected: Automatically finds the tool’s path each time you select a tool with Open Connection With.
    • If the tool doesn’t open properly, please manually specify the path with Manual Configuration.
  • Manual Configuration: Manually specify the path where the tool is installed.
  • Do not use the tool: Disables tool usage. The tool is hidden from the context menu in the connection list.
• DataGrip Connection Guide: Sets whether to continue viewing the guide modal that appears when opening a connection with DataGrip.

Selecting Default Privilege in Agent

In QueryPie DB access control, one user can be granted two or more privileges. When a user with access rights to a specific connection is included in multiple groups and different access rights are granted to the groups, this user can be assigned multiple privileges. At this time, you can select the Privilege to use when connecting through proxy from the agent screen. (Supported from 10.3.0)

If a user with multiple privileges does not set a specific privilege as default, they cannot connect, so if no default privilege is set, a warning icon like the one shown below is displayed.

1. Right-click on a connection with multiple Privileges assigned and call the menu.
2. Select Connection Information from the menu.
   
3. Click the edit (pencil icon) button in the Privilege of Original Information.
   
   
4. Select one of the Privilege Name items and save.
   
5. Check that the warning icon disappears and the assigned privilege name is visible for that connection.
   
   

KAC

Viewing Kubernetes Cluster List by Role in Agent

When you select one of the Roles granted to you from the Role selector, you can view the K8s Cluster list that has permissions for the selected Role.

Checking Kubeconfig Setup Guide in Agent

To use kubectl commands through Proxy, one-time Kubeconfig setup is required.

Click the gear button in the top right corner of the agent to enter the Setting page, select the Kubernetes tab to manage the Kubeconfig File storage path and copy the Kubeconfig setup command.

Then paste and run the copied command in the terminal you are using.

SAC**[10.2.8~]**

Connecting to Server with Agent

1. When you select a Role from the Role dropdown, you can view the server list that can be accessed with the selected Role.
2. Select a server, right-click to open the context menu, and select Open Connection With > Terminal Tool.
3. Enter Account information if necessary and press the Open button.
   1. When you select an account with category QueryPie - Custom Account in Account, the Custom Account field and Password field are displayed, and you can directly enter unregistered account information to connect to Linux and Windows servers.
      1. However, when connecting to a Windows Server without Server Agent, only Custom Account can be selected, and the Custom Account input field and Password input field are not displayed. It cannot be used on Windows Servers with Server Agent.
4. You can connect to the server with the selected terminal tool.

Requesting Server Access Permission from Agent

When you don’t have the necessary account permissions to connect to a server, you can directly request server access permission (Server Privilege Request) from Multi Agent.

1. Select the server you want to request permission for in the Servers tab and right-click to open the context menu.
   
2. Select the terminal tool you want to use from Open Connection With.
   
   
3. When the account selection window appears, click the Request Server Privilege button at the bottom.
   
   
   • Clicking this button navigates to the permission request screen on the QueryPie web page, with the previously selected Role, server group, server, and account information automatically filled in.
     

Available Filters When Viewing Server List in Agent

1. Time-limited items only : Only displays servers with time-based permissions in the list.
2. Search by Host : Changes the search criteria for the server list from the existing server name to Host (IP address). At the same time, the display method of the server list is also switched to Host. When the toggle is disabled, you can only search by server name.

Managing 3rd Party Terminal Tool Settings in Agent

You can manage terminal tool-related settings in Setting > Servers.

• Terminal Tool Path: You can set the path of supported 3rd Party tools.
  • Auto Detected: Automatically finds the tool’s path each time you select a tool with Open Connection With.
    • If the tool doesn’t open properly, please manually specify the path with Manual Configuration.
  • Manual Configuration: Manually specify the path where the tool is installed.
  • Do not use the tool: Disables tool usage. The tool is hidden from the context menu in the server list.

Using Two or More Hosts in Agent

1. In Settings > Hosts, click the + Add New Host button, enter the domain of the new Host, and save.
2. If the new Host registration is successful, you will be notified with a Toast. Check that the new Host has been added to the list and click the X button in the top right corner to exit the settings page.
   1. You can click on the desired Host in the Host list to switch immediately.
3. Click the profile button to view the registered Host list. You can click to switch between Hosts.

Resetting Multi Agent Settings

1. Click the Multi Agent icon (or item) in the system tray or menu bar, then select ‘Reset All Settings’ from the displayed menu.

1. Or click the gear button in the top right corner of the agent to enter the settings page and click the Reset All Settings button at the bottom of the Hosts tab.
2. Click the Reset button in the confirmation modal to reset all settings stored in the local folder.
3. You will enter the Multi Agent initial setup (initial Host registration) page.

Extracting Multi Agent Logs

If problems occur while using Multi-agent, please extract logs following the procedures below.

GUI

1. Click the Multi-agent icon in the menu bar (MacOS) or system tray (Windows) and click Diagnostic Tools > Enable Tracing in the menu.
   1. Changes the log level to Trace, and the item changes to Disable Tracing in the UI.
2. Reproduce the problem.
3. Click Multi-agent icon > Diagnostic Tools > Export Log from the menu bar again.
4. You can send the extracted log file.

macOS

1. After closing the agent, run the following command in the terminal.

QPMA_TRACE=1 open -a QueryPieMultiAgent

1. Reproduce the problem.
2. Please compress and send the following folder.

~/.querypie-multi-agent

Windows

1. After closing the agent, run the following command in the terminal.

set QPMA_TRACE=1 "%ProgramFiles%\QueryPie Multi Agent\QueryPieMultiAgent.exe"

1. Reproduce the problem.
2. Please compress and send the following folder.

%USERPROFILE%\.querypie-multi-agent

Constraint Documentation for Administrators

Please refer to the separate administrator guide document for Multi Agent constraint documentation for administrators.

Multi Agent Constraints