Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Use the The following sections article serves as a diagnostics checklist to investigate server performance issues.  

Run performance_analysis.py

The first step in diagnosing server performance issues is to run the performance analysis python If you are experiencing performance issues, review the sections below to diagnose the cause of the issue. If you are unable to identify the performance issue on your own, escalate the issue to our support team. For more information, see Escalate an Issue.

Info
titlePrerequisites

Depending on your release version and the method of investigating server performance, you may need the following:

  • Access to the server file system
  • Access to the admin console

Run Performance Analysis

Before completing any other steps to investigate server performance issues, run the performance analysis Python script, performance_analysis.py. 

...

In most cases, you need access to the server file system to run this script.

...

However, in any release later than 2019_01 r195525 dated after

...

08/01

...

/2019, you can run the script

...

by opening the administrator consolegoing to Debugging > Performance

...

, and clicking Run Performance Analysis:

...

Image Added

If your system is running an earlier release, you can run the script manually from the command line.   Download the script here:  https://www.agiloft.com/public/ performance_analysis.py.

This script is designed to identify the specific activities that may be causing performance problems. It checks the CPU and memory utilization and produces a summary of events and activities for the day. The summary can help determine if an incorrectly configured rule or action should be further investigated be investigated as a potential cause of performance issues.

Note

When

...

you run the script from the admin console, it captures activities

...

beginning at 12:01am.

...

When you run the script manually, you can configure the time frame to use a different starting point

...

.

...

Diagnose Issues on a Self-hosted

...

Server

The following sections are helpful to investigate server performance issues for customers who host their when you host 

Companyname
 instance(s) on their own servers.  on your own server. If you use our hosted service, see Escalate an Issue below.

Verify the Hardware Configuration

It is important to check the hardware configuration to verify Complete these steps to verify your hardware configuration:

  1. Check your hardware configuration to confirm that it follows
    Companyname
     System Requirements for hardware.

...

  1. Run a performance test through the Administrator Consoleto validate the hardware configuration.

...

  1. See Optimizing System Performance

...

  1. for additional details on this performance test and other

...

  1. aspects of your system that can affect performance.  

Check CPU and Memory Utilization

To further investigate any CPU and memory utilization issues reported by the performance_analysis.py script, and to determine if a third-party application is taxing those resources, use the following techniques, depending on your operating system:

  • For Linux servers, use the “uptime” uptime, “top” top, and “free” free commands.
  • For Windows servers, use the Task Manager or the Resource Monitor.

...

If you determine that a third-party application is responsible for the high load or memory utilization, then review the logs log files or thread dumps for that application.

Run
Companyname

...

 Diagnostics

Jboss is the primary process for the

Companyname
 application. On Linux servers, the process appears as java. On  On Windows servers, it appears as ewjboss”.  . Running diagnostics on the process and reviewing log files can help identify any performance issues.

Thread Dump

If a performance problem issue occurs while executing a particular set of steps in the UIinterface, repeat the steps and take a Jboss thread dump in tandem by running the at the same time. To take a thread dump, run the following command on the server as root or an administrator, substituting the directory where  

Companyname
 is installed for [AGILOFT_HOME]:

Code Block
[AGILOFT_HOME]/bin/ew-control -d tr

...

Companyname

...

 

Take two or three thread dumps and review them to isolate the cause of the performance issue.

Heap Dump

If the

Companyname
 logs show memory-related problems, such as "OutOfMemory" errors, then a heap dump may be necessary.

Warning

Heap dumps are resource intensive and can take hours to complete. Either run Run them outside of business hours or be ready to kill end the operation if it is severely affecting performance.

To perform a heap dump, run the following command on the server as root or an administrator, substituting the directory where  

Companyname
 is installed for [AGILOFT_HOME]:

Code Block
[AGILOFT_HOME]/bin/ew-control -d hp

...

Companyname

...

Steps for All Customers

Escalate an Issue

If the previous diagnostics do not reveal the cause of the performance issue, then it should be escalated for further assistanceor if your system is hosted by 

Companyname
, escalate the issue to our support team for further investigation.

Submit Performance Issues for Further Investigation

Submit Log in to our Support Portal and submit a support ticket with ticket with the following information:

  • Steps to reproduce the issue.
  • Knowledgebase credentials.
  • Impact assessment: how many people is this performance issue affecting?Attach the thread dump and logs, including the number of people the issue is affecting.
  • Thread dumps and log files. If the server is hosted by

    Companyname
    , grant access to the location of the logs and document the location in the ticket.


Hide If
displayspecialdefault@anonymous
Go to Advanced

Perform Advanced Level Investigation

Self-hosted developers and experienced system administrators may refer to the article Advanced Investigation of Performance Issues for further investigation.

...