Support tools on Jitterbit private agents

Introduction

The Agent Support Tools described on this page are a set of diagnostic and reporting commands.

Use them to see how your agent is performing, or when requested by Jitterbit support.

To access the tools, run the following commands:

LinuxWindows

cd /opt/jitterbit/AgentSupportTools
./run.sh

cd C:\Program Files\Jitterbit Agent\AgentSupportTools
.\run.bat

The tools are ready when you see the JB Agent Tools> prompt. From here you can enter any of the commands listed below.

Tip

Enter the first few characters of a command then press the Tab key to see those that match.

`help`

Description

Show all available commands.

Usage

help [COMMAND]

Options

COMMAND: Show help for a command.

`about`

Note

Added in private agent version 11.36.

Description

Show the following information about the installed agent:

Agent name
Agent group
Version
Environments

Usage

about

Options

None.

`apache-stat`

Description

Show the status of the Apache service.

Usage

apache-stat [-j]

Options

-j: Write the output in JSON format.

Examples

JB Agent Tools>apache-stat
Busy Workers | Idle Workers | Total Workers | Free Capacity
-----------------------------------------------------------
           1 |          255 |           256 |           99%

JB Agent Tools>apache-stat -j
{
  "busy_workers": 1,
  "idle_workers": 255,
  "total_workers": 256,
  "capacity_percent":99
}

`clear`

Description

Clear the console.

Usage

clear

Options

None

`connection-check`

Description

Check the connections from the private agent to the Harmony gateway, and the private agent's Apache and Tomcat servers.

Usage

connection-check [-t]

Options

-t: If traceroute is installed, include its output for the Harmony gateway host address.

Examples

JB Agent Tools>connection-check
connection-check
***** Harmony *****

Ping: na-east.jitterbit.com
Harmony gateway is reachable

***** Apache *****
Apache Is reachable on port 46908

***** Tomcat *****
Tomcat is reachable on port 46912.

`env-list`

Note

Added in private agent version 11.36.

Description

Show a list of environments associated with the private agent.

Usage

env-list

Options

None.

`exit`

Description

Exit the program.

Usage

exit

Options

None

`generate-report`

Description

Create the following files:

report.html: A report showing the agent's operations, pending operations, Apache statistics, PostgreSQL server connections, system log files, and services.
jitterbit-logs.zip: A zip file containing private agent log files.

Usage

generate-report [-p OUTPUT_DIRECTORY]

Options

-p OUTPUT_DIRECTORY: Save the files in the specified directory.

`list-connectors`

Description

Show downloaded and loaded connectors.

Usage

list-connectors [-p AGENT_PORT]

Options

-p: Port the agent runs on.

Examples

JB Agent Tools>list-connectors
list-connectors
---------------------------
Downloaded connectors
---------------------------
SAP - 1.0.0
Smart Recruiters - 1.0.0
Jira - 1.0.1
AI - 1.0.0
SalesforceEvents - 1.0.0

---------------------------
Loaded connectors
---------------------------
SAP - 1.0.0
SalesforceEvents - 1.0.0
CLARIZEN - 1.0.0
FOUR51 - 1.0.0
FOUR51 - 1.0.0
Smart Recruiters - 1.0.0
Jira - 1.0.1
CLARIZEN - 1.0.0
AI - 1.0.0

`list-ops`

Description

Show operations.

Usage

list-ops [-d] [OPERATION_NAME_FILTER]

Options

OPERATION_NAME_FILTER: Show operations starting with this text. Default: jb-agent-tools-.
-d: Show more details.

`log-sync`

Description

Show the number of items in the private agent log queue for each of the states processed, unprocessed, and error.

Usage

log-sync

Options

None

`pending-ops`

Description

Show the number of scheduled and child requests in a running or waiting state.

Usage

pending-ops [-j]

Options

-j: Write the output in JSON format.

`pg-connection`

Description

Show the status of open PostgreSQL connections.

Usage

pg-connection [ -m MODE] [-j]

Options

-m MODE: Choose how to make the connection, where MODE is one of the following:
- conf: Use the information in the jitterbit.conf file.
- postgres: Connect to the PostgreSQL server.
- pgbouncer: Connect to the pgbouncer service.
-j: Format the output as JSON.

Examples

JB Agent Tools>pg-connection
pg-connection
count | state
---------------
    5 | null
    1 | active
   12 | idle

JB Agent Tools>pg-connection -j
pg-connection -j
[{"count":5,"state":null},{"count":1,"state":"active"},{"count":13,"state":"idle"}]

`pg-status`

Description

Show the database size, and list tables with the highest number of table scans and affected rows.

Usage

pg-status

Options

None

Examples

JB Agent Tools>pg-status
pg-status
                     Table |       Scans (Sequential-Index) | Affected rows (Inserted-Updated-Deleted)
-----------------------------------------------------------------------------------------------------
            incomingmsgtab |              317439 (7-317432) |                  44 (15-14-15)
       verboseloguploadtab |                21450 (3-21447) |                      0 (0-0-0)
                key_values |              18797 (18177-620) |               1081 (11-1069-1)
                logsynctab |             16194 (13318-2876) |              330 (110-110-110)
              deploylogtab |                   312 (21-291) |              674 (230-229-215)
   operationdataelementtab |                     32 (20-12) |                752 (376-0-376)
   document_definitionstab |                        5 (5-0) |                592 (296-0-296)
    filestorepropertiestab |                        9 (7-2) |                408 (204-0-204)
 transformationdefinitionstab |                      17 (17-0) |                400 (200-0-200)
    operationpropertiestab |                      34 (34-0) |                344 (180-0-164)
-----------------------------------------------------------------------------------------------------

Database size: 16 MB

`resync-deploylogs`

Note

Added in private agent version 11.29.

Description

Download the deploy logs from Harmony to re-synchronize them for a given environment ID.

Usage

resync-deploylogs -e ENVIRONMENT_ID [-p AGENT_PORT]

Options

-e: Environment ID.
-p: Agent port number.

`run-op`

Description

Run an operation specified by its ID, then show the status.

Usage

run-op [-l OPERATION_ID LOOP_COUNT] [-r OPERATION_ID DELAY] [-s OPERATION_ID]

Options

-l: For LOOP_COUNT number of times, run operation OPERATION_ID.
-r: Run operation OPERATION_ID in an infinite loop with a delay between runs.
-s: Stop infinite loop operation OPERATION_ID.

`service-status`

Description

Show the status of the Apache, Tomcat, Postgres, Pgbouncer, and VerboseLogShipper agent services.

Usage

service-status

Options

None

`zip-logs`

Description

Create a zip file containing all agent logs.

Usage

zip-logs [OUTPUT_DIRECTORY]

Options

OUTPUT_DIRECTORY: Save the .zip file in the specified directory.

Examples

JB Agent Tools>zip-logs
zip-logs
Zip filed created in: /opt/jitterbit/AgentSupportTools/jitterbit-logs.zip

JB Agent Tools>zip-logs /var
zip-logs /var
Zip filed created in: /var/jitterbit-logs.zip