Relativity - Performance Dashboard Guide - 9.0

Relativity - Performance Dashboard Guide - 9.0
Performance Dashboard Guide
March 13, 2015 - Version 9
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
For the most recent version of this document, visit our documentation website.
Table of Contents
1 Overview
5
1.1 System requirements
5
1.2 Installation
5
1.3 Upgrade
5
2 Installing Performance Dashboard
5
2.1 Installing to the Application Library
6
2.2 Creating the Performance Dashboard workspace
6
2.3 Installing PDB to the Performance Dashboard workspace
6
2.4 Adding the Performance Dashboard agents
7
2.5 Installing the script updates
7
2.6 Configuring Performance Dashboard for Trust website
8
2.6.1 Add Performance Dashboard Trust agent
8
2.6.2 Configure Trust settings
8
2.7 Configuring Performance Dashboard when Relativity servers reside in a DMZ
3 Upgrading Performance Dashboard
3.1 Upgrading from PDB 8.2.x or later to PDB 9
3.1.1 Pre-upgrade steps
9
9
9
9
3.1.2 Upgrading the application
10
3.1.3 Configuring Performance Dashboard for Trust website
11
3.1.4 Upgrading an Active Directory authenticated site
12
4 Accessing Performance Dashboard
4.1 Quality of Service page
13
13
4.1.1 Overall score
13
4.1.2 User Experience score
13
4.1.3 System Load score
14
Relativity | Performance Dashboard Guide - 2
4.1.4 Backups and DBCC checks
14
4.1.5 Uptime
15
4.2 User Experience page
15
4.2.1 Page header
15
4.2.2 Server View Report
16
4.2.3 Hours View Report
17
4.2.4 Search Details Report
18
4.2.5 Concurrency Report
19
4.3 System Load page
21
4.3.1 Page header
21
4.3.2 System Load Report
21
4.4 Backups and DBCCs page
22
4.4.1 Server summary
23
4.4.2 Workspace summary
23
4.5 Uptime page
24
4.5.1 Chart
24
4.5.2 Uptime Grid
24
4.5.3 Downtime Grid
25
4.6 Application Health page
25
4.6.1 Page header
25
4.6.2 Data grid
26
4.6.3 Performance metrics
27
4.6.4 Chart
29
4.7 Server Health page
30
4.7.1 Page header
30
4.7.2 Data grid
31
4.7.3 Chart
33
Relativity | Performance Dashboard Guide - 3
4.8 Configuration Page
34
4.9 Backfill Console
35
5 Troubleshooting Performance dashboard
5.1 Installation troubleshooting
36
36
5.1.1 Server connection errors
36
5.1.2 Workspace connection errors
37
5.1.3 Web page connection errors
37
Relativity | Performance Dashboard Guide - 4
1 Overview
Relativity Performance Dashboard helps you monitor and analyze your Relativity environment in
real time. Featuring a suite of reports and metrics, it provides you with greater insight into your
environment to quickly assess potential areas of concern. Performance Dashboard is available for
download through the Relativity Customer Portal.
The latest release of Performance Dashboard features a new set of “Quality of Service” reports,
allowing Infrastructure managers to view the performance of their Relativity environment through
four key areas; user experience, system load, database backups and consistency checks, and uptime.
Weekly and quarterly scores are calculated for based on these areas, allowing you to gauge the
performance of your Relativity environment. Problematic areas can be investigated further using
the performance metrics for all workspaces and servers in your environment, such as long-running
queries, user counts, user kick-outs, and CPU and RAM usage. Using this information, you can make
adjustments to your environment on-the-fly, rather than waiting to find errors over time.
1.1 System requirements
Since PDB is an extension of Relativity, no unique system requirements apply.
1.2 Installation
See Installing Performance Dashboard below for detailed installation instructions.
1.3 Upgrade
See Upgrading Performance Dashboard on page 9 if you haven't run a previous Performance
Dashboard upgrade to include the Performance Status column on the Application Performance
website.
2 Installing Performance Dashboard
The Performance Dashboard (PDB) application consists of components that work together to collect,
store, process, and display performance information for the Relativity environment in which they
are deployed.
These components include the following:
n
n
EDDSPerformance and EDDSQoS Databases – reside on the same database server as the main Relativity database. They are used primarily as a repository for collected and aggregated performance data.
Performance Dashboard Agents – reside on one of the agent servers in the Relativity environment.
They run in the background, kicking off processes that measure overall application health as well as the
Relativity | Performance Dashboard Guide - 5
n
performance of different servers in the environment. It saves the collected data to the Performance
Database.
PDB Web Application – resides on web servers in the Relativity environment and is accessed from the
Admin area of Relativity. It allows Relativity administrators access to performance data via a graphic
user interface.
Performance Dashboard is installed through Relativity’s application deployment system (ADS). You
first need to upload and install the PDB application to Relativity’s Application Library. You then need
to create a workspace for PDB and install the application to that workspace. The last step is to add
an instance of the Performance Dashboard Agent to the Agents list and start the new agent.
2.1 Installing to the Application Library
Perform the following steps to install PDB to Relativity’s Application Library:
1. Log in to Relativity as a system admin.
2. Navigate to the Application Library tab and click the Upload Application button.
3. Click the
button and browse to the .rap file for the PDB application.
Note: The PDB install package can be found on the Relativity Customer Portal.
4. Click Save. The application should now be added to the library.
2.2 Creating the Performance Dashboard workspace
To create a new workspace in Relativity:
1.
2.
3.
4.
Go to Home and click the Workspaces tab.
Click New Workspace.
Name the workspace Performance Dashboard.
Configure the remaining settings as desired.
2.3 Installing PDB to the Performance Dashboard workspace
You can install the PDB application to your new workspace from the Application Library tab from
Home or from the Relativity Applications tab within the new workspace. Follow these steps to install
the application from within the new workspace:
1. Access your Performance Dashboard workspace and navigate to the Relativity Applications tab.
2. Click New Relativity Application.
3. Under the Application Type section, select the radio button for Select from Application Library.
4. Click
to browse the application library.
5. Select the Performance Dashboard application and click Ok.
6. Click Import.
Relativity | Performance Dashboard Guide - 6
2.4 Adding the Performance Dashboard agents
When started, the Performance Dashboard agents will create the EDDSPerformance database and
create the Performance Dashboard tabs visible from Home. Perform the following steps to install
the agents:
1. Click on the name link to display the Home menu, then click Home.
2. Navigate to the Agents tab, and click the New Agent button.
3. Click
next to Agent Type, select the radio button for Performance Dashboard - QoS Worker Agent,
and click Ok.
4. Click
next to Agent Server and select the agent server where you want to install the new agent.
Click Ok.
5. Leave all other settings as default and click Save and New.
6. Click
next to Agent Type, select the radio button for Performance Dashboard - WMI Worker Agent,
and click Ok.
7. Click
next to Agent Server and select the agent server where you want to install the new agent.
Click Ok.
8. Leave all other settings as default and click Save.
The agents should now start up and begin performing their initial tasks. The kCura Relativity Web
Processing web service will pick up the new custom pages for PDB and handle the creation of the web
application in IIS.
9. Ensure that the custom pages are working properly by navigating to them under the Performance Dashboard tab visible from Home.
For installation troubleshooting information, see Installation troubleshooting on page 36.
2.5 Installing the script updates
The first time you open Performance Dashboard, you are prompted to enter system administrator
credentials. Performance Dashboard checks the credentials against all SQL servers in the
environment, so the credentials you enter here must be able to access the Primary and any
Distributed SQL servers. These credentials also must have the 'sysadmin' role on each Primary and
Distributed SQL server in the environment.
Note: Do not enter the EDDSDBO account credentials as this account does not have the 'sysadmin' role
assigned.
Relativity | Performance Dashboard Guide - 7
2.6 Configuring Performance Dashboard for Trust website
This section is only required of Best in Service partners. All Best in Service partners must add the
Performance Dashboard - Trust Worker agent and configure the Trust settings. Other users can skip
this section.
2.6.1 Add Performance Dashboard Trust agent
1. Click the name link to display the Home menu, then click Home.
2. Navigate to the Agents tab, and click New Agent.
3. Click
next to Agent Type, select the radio button for Performance Dashboard - Trust Worker Agent,
and click Ok.
4. Click
next to Agent Server and select the agent server where you want to install the new agent.
Click Ok.
5. Leave all other settings as default and click Save.
2.6.2 Configure Trust settings
1. From the Performance Dashboard tab, navigate to the Configuration tab.
2. Enter your Trust ID, which kCura provided to you.
Note: If you're a Best in Service partner and you haven't received a trust ID, contact kCura Client Services.
3. Enter your Partner name as you would like it to appear on Performance Dashboard reports.
4. Leave Send Scores Automatically set to On to have scores automatically pushed to the Trust website.
5. Set Send Notifications to On to have Trust notifications sent to an email address. Enter the email
address where Trust notifications should be sent in the Recipient field.
Relativity | Performance Dashboard Guide - 8
2.7 Configuring Performance Dashboard when Relativity servers
reside in a DMZ
Performance Dashboard requires WMI communication to be open between the Performance
Dashboard agent and every other Relativity server in the environment. When there is a firewall
between the agent and a server, most times the WMI communication is blocked. This will result in
the error RPC server is unavailable in the Event Viewer on the agent server, and no data will be
collected for that server. If WMI communication cannot be opened between the agent and the
server, data can be collected by using a second Performance Dashboard agent that also resides
behind the firewall (in the DMZ). This configuration requires the agent module of Relativity to be
installed on a server in the DMZ.
Perform the following steps to configure PDB to work inside a DMZ:
1. Verify that an agent server resides in the DMZ
2. Add a second Performance Dashboard agent to the agent server in the DMZ
3. Follow steps 1 – 4 in Adding the Performance Dashboard agent to install the agent.
3 Upgrading Performance Dashboard
This section describes the process to upgrade Performance Dashboard to version 9. If you're
upgrading to a different build, contact Support for the correct guide.
3.1 Upgrading from PDB 8.2.x or later to PDB 9
Note: Please contact [email protected] for assistance upgrading from PDB 8.0.x and earlier.
3.1.1 Pre-upgrade steps
3.1.1.1 Delete the previous Performance Dashboard agent
Perform the following steps to delete the previous PDB agent:
1.
2.
3.
4.
5.
Log in to Relativity as a system admin.
Navigate to the Infrastructure Management tab and click Agents.
Click Performance Dashboard Agent.
Click the Delete button.
Click the Delete agent button.
The previous Performance Dashboard Agent has now been deleted.
Relativity | Performance Dashboard Guide - 9
3.1.2 Upgrading the application
3.1.2.1 Install to the application library
Perform the following steps to install PDB to the application library:
1. Log in to Relativity as a system admin.
2. Navigate to the Application Library tab and click Upload Application.
3. Click Browse and select the .rap file for the PDB application.
Note: Click Yes if prompted to upgrade all workspaces.
4. Click Save.
5. Click Yes when prompted to upgrade the existing application. The application is added to the library.
3.1.2.2 Create the Performance Dashboard Workspace
Create a new workspace in Relativity:
1. From Home, navigate to the Workspaces tab and click New Workspace.
2. Name the workspace Performance Dashboard.
3. Configure the remaining settings as desired.
3.1.2.3 Install the application to the workspace
You can install the Performance Dashboard application to your new workspace from the Application
Library tab from Home or from the Relativity Applications tab within the new workspace. Follow
these steps to install the application from within the new workspace:
1.
2.
3.
4.
Navigate to the Relativity Applications tab and click New Relativity Application.
Under the Application Type section, select the radio button for Select from Application Library.
Click Browse, then select Performance Dashboard and click Ok.
Click Import.
3.1.2.4 Add the new Performance Dashboard agents
Perform the following steps to install the agents:
1. Click on the user drop-down menu and click Home.
2. Navigate to the Agents tab, and click the New Agent button.
3. Click
next to Agent Type, select the radio button for Performance Dashboard - QoS Worker
Agent, and click Ok.
4. Click
next to Agent Server, select the agent server where you want to install the new agent, and
click Ok.
5. Leave all other settings as default and click Save and New.
6. Click
next to Agent Type, select the radio button for Performance Dashboard - WMI Worker
Agent, and click Ok.
7. Click
next to Agent Server, select the agent server where you want to install the new agent, and
Relativity | Performance Dashboard Guide - 10
click Ok.
8. Leave all other settings as default and click Save.
The agents should now start up and begin performing their initial tasks. The kCura Relativity Web
Processing web service will pick up the new custom pages for PDB and handle the creation of the
web application in IIS.
3.1.2.5 Install the script updates
The first time you open the performance dashboard pages, you must enter system administrator
credentials. Enter the SQL credentials for any SQL account with the sysadmin role on all linked
SQL servers.
Note: Do not enter the EDDSDBO account credentials as this account does not have the sysadmin role
assigned.
3.1.3 Configuring Performance Dashboard for Trust website
This section is only required of Best in Service partners. All Best in Service partners must add the
Performance Dashboard - Trust Worker agent and configure the Trust settings. Other users can skip
this section.
3.1.3.1 Add Performance Dashboard Trust agent
1. Click the name link to display the Home menu, then click Home.
2. Navigate to the Agents tab, and click New Agent.
3. Click
next to Agent Type, select the radio button for Performance Dashboard - Trust Worker Agent,
and click Ok.
4. Click
next to Agent Server and select the agent server where you want to install the new agent.
Click Ok.
5. Leave all other settings as default and click Save.
Relativity | Performance Dashboard Guide - 11
3.1.3.2 Configure Trust settings
1. From the Performance Dashboard tab, navigate to the Configuration tab.
2. Enter your Trust ID, which kCura provided to you.
Note: If you're a Best in Service partner and you haven't received a trust ID, contact kCura Client Services.
3. Enter your Partner name as you would like it to appear on Performance Dashboard reports.
4. Leave Send Scores Automatically set to On to have scores automatically pushed to the Trust website.
5. Set Send Notifications to On to have Trust notifications sent to an email address. Enter the email
address where Trust notifications should be sent in the Recipient field.
3.1.4 Upgrading an Active Directory authenticated site
When completing this type of upgrade, the custom pages for Performance Dashboard are created in
the default Forms authenticated Relativity website. If you access Performance Dashboard through
an Active Directory (AD) authenticated site, the Performance Dashboard web pages won't load.
To upgrade an AD authenticated site, perform the following steps:
1. Locate the Custom Pages directory within the Relativity installation folder on your web server Forms
site directory, usually c:\Program Files\kCura Corporation\Relativity\EDDS\CustomPages
2. To copy all custom pages from the Forms site, copy the whole CustomPages directory to the EDDS
folder within the AD site installation directory (for example, C:\Program Files\kCura Corporation\Relativity\AD\EDDS). If you copy the whole directory, skip to step 7.
3. Create a folder called CustomPages in the AD site's installation directory if it doesn't already exist.
4. Copy the folder 60a1d0a3-2797-4fb3-a260-614cbfd3fa0d from the CustomPages folder of the Forms site
to the CustomPages folder of the AD authenticated site.
5. On your web server(s), locate the directory with the CustomPages folder for the Forms site and copy it
to the CustomPages folder for the AD site.
6. Open the 60a1d0a3-2797-4fb3-a260-614cbfd3fa0d folder in the AD site.
7. Edit the web.config file by adding the following lines inside the <system.web> tags:
<authentication mode = "Windows">
</authentication>
<authorization>
<deny users="?" />
</authorization>
8. Save the web.config file.
3.1.4.1 Creating the application and application pools for the AD site
Perform the following steps to create the application and application pools for the AD authenticated
site.
1.
2.
3.
4.
5.
Open IIS Manager.
Expand the Application Pools folder.
Create a new application pool called 60a1d0a3-2797-4fb3-a260-614cbfd3fa0dAD.
Set the .NET Framework Version to v4.0.
Set the Identity to the Relativity Service Account.
Relativity | Performance Dashboard Guide - 12
6. To make the PDB pages accessible through the website, convert the folder copies into applications
using IIS:
a. Expand the AD site folder, then expand the Relativity application > CustomPages folder.
b. Right-click the folder for PDB's custom pages and click Convert to Application.
7. On the Add Application screen, select the application pool that corresponds to the custom page and
click OK.
4 Accessing Performance Dashboard
To access the Performance Dashboard, perform the following steps:
1. In Relativity, click Home on the user drop-down menu. 2. Click the Performance Dashboard tab.
4.1 Quality of Service page
The Quality of Service page provides infrastructure administrators a summarized report of their
Relativity environment performance broken down into four categories:
n
n
n
n
User Experience
System Load
Database Backups and DBCC Checks
Uptime
4.1.1 Overall score
The Overall score reflects the overall performance of a Relativity environment calculated as the
average of the quarterly and weekly scores in the sample range for each of the four categories. The
quarterly sample range is 90 active days before the end date in the sample range. If there are less
than 90 days in the sample range then the quarterly score is based on the total days in the sample.
4.1.2 User Experience score
Relativity | Performance Dashboard Guide - 13
The User Experience score is calculated as both a weekly and a quarterly score, and it reflects
Relativity users’ experience when navigating views, running searches, and performing other
operations in Relativity.
The table provides the details of the worst performing SQL Server including the hours that logged
the lowest scores. This information is provided as a high level summary. More detailed information
is included on the User Experience page. See User Experience page on the next page.
4.1.3 System Load score
The System Load score is also calculated as both a weekly and a quarterly score, and it reflects the
performance of the Relativity SQL Servers and Web Servers during periods of high activity.
The table provides the details of the worst performing SQL Server or Web Server including the hours
that logged the lowest scores. This information is provided as a high level summary. More detailed
information is included on the System Load page. See System Load page on page 21.
4.1.4 Backups and DBCC checks
The Backup and DBCC Checks score is a quarterly score based on the ability of the infrastructure
administrator to complete SQL Backups and DBCC checks for all active Relativity databases.
The table provides the details of any gaps in either the SQL Backup jobs or the DBCC Checks, and it
shows the number of days since the job last completed in the Missed Days column along with details
on whether this gap is compliant within kCura’s recommended practice of performing these jobs
every 7 days.
This information is provided as a high level summary. More detailed information is included on the
Backups and DBCC Checks page. See Backups and DBCCs page on page 22.
Relativity | Performance Dashboard Guide - 14
4.1.5 Uptime
The Uptime score is a quarterly score based on the uptime of the Relativity Agent servers.
The table provides the details of the total number of hours down during a month. This information is
provided as a high level summary. More detailed information is included on the Uptime page. See
Uptime page on page 24.
4.2 User Experience page
The User Experience score is designed to provide a true reflection of the experience of Relativity
users in an environment. It is based on the execution time of user functions including: simple and
complex queries, document views and edits, Relativity scripts, imports and exports, and mass
operations. Full details on the scoring system can be found in the BiS Delivery Metrics document.
4.2.1 Page header
The top of the User Experience page includes three navigation buttons:
n
n
n
Back takes you back to the previous page
QoS Report takes you to the main QoS page
Concurrency Report takes you to the User Experience Concurrency Report Page
Relativity | Performance Dashboard Guide - 15
4.2.2 Server View Report
The User Experience Server View Report table displays the hours used to determine the current
quarterly and weekly user experience scores. The table consists of the following columns:
n
Server
o
n
The name and artifact ID of the server where the workspace resides
Hour
o
Aggregates are based on actions taken in the hour following the time indicated here (expressed
in your local time zone)
n
Score
n
The server's user experience score for a given hour, determined based on the number of active
users and percentage of simple document searches that took longer than two seconds.
Workspace
n
The name and artifact ID of the workspace that the queries were run in
Long-Running Queries
n
The number of document searches exceeding the long-running threshold (two seconds for
simple searches, eight seconds for complex)
Total Users
n
The distinct number of users in the workspace for a given hour
Total Search Audits
n
o The number of document search audits collected by VARSCAT (includes TOP and COUNT audits)
Total Non-Search Audits
n
The number of audits collected by VARSCAT of types other than document search
Total Audits
n
The number of Relativity audits collected by VARSCAT
Total Execution Time
n
o The sum of execution time for all actions expressed in milliseconds
Weekly Sample
o
o
o
o
o
o
o
Indicates whether the given hour was included in the weekly sample set
Relativity | Performance Dashboard Guide - 16
From the Server View Report page you can navigate to the Hours View Report for a particular
server. The page can be accessed by clicking on a row in either the Server or Workspace columns.
4.2.3 Hours View Report
The Hours View Report displays the searches performed on a particular server by hour. The table
consists of the following columns:
n
Workspace
o
The name and artifact ID of the workspace that the search was created in
n
Search
n
Hour
n
Aggregates are based on actions taken in the hour following the time indicated here (expressed
in your local time zone)
Percent LRQ For Workspace
n
o Represents the percentage of the time the search was long-running for this hour
Complex / Simple
n
Indicates whether the search was classified as simple or complex based on its conditions
Total Run Time
n
The total execution time of all runs of a search in the given hour expressed in milliseconds
Average Run Time
n
o The average execution time of all runs of a search in the given hour expressed in milliseconds
Total Runs
n
The number of times a search was run in the given hour
Weekly Sample
o
The name and artifact ID of the search
o
o
o
o
o
Indicates whether the given hour was included in the weekly sample set
From the Hours View Report page you can navigate to the Search Details Report for a particular
workspace. The page is accessed by clicking on a row in either the workspace or search columns.
Relativity | Performance Dashboard Guide - 17
4.2.4 Search Details Report
The Search Details Report page displays the searches performed in a particular workspace by hour.
The table consists of the following columns:
n
Search
o
n
The name and artifact ID of the search
User
o
The name and artifact ID of the user that ran the search
n
Hour
n
Aggregates are based on actions taken in the hour following the time indicated here (expressed
in your local time zone)
Percent Long-Running
n
Represents the percentage of the time this search was long-running for this user and hour
Complex / Simple
n
Indicates whether the search was classified as simple or complex based on its conditions
Total Run Time
n
The total execution time of all runs of a search by this user in the given hour, expressed in milliseconds
Average Run Time
n
The average execution time of all runs of a search by this user in the given hour, expressed in milliseconds
Total Runs
n
The number of times a search was run by this user in the given hour
QoS Hour ID
n
A system identifier for this hour that can be used in EDDSPerformance table queries
Weekly Sample
o
o
o
o
o
o
o
o
Indicates whether the given hour was included in the weekly sample set
By clicking on the name of the search you can view the query text. In order for this text to be run in
SQL you will have to add the database and schema names to the statement.
Relativity | Performance Dashboard Guide - 18
4.2.5 Concurrency Report
4.2.5.1 Page header
The top of the User Experience page includes three navigation buttons:
n
n
n
Back takes you back to the previous page
QoS Report takes you to the main QoS page
Concurrency Report takes you to the User Experience Concurrency Report Page
The bar below these icons includes a drop-down menu displaying all SQL servers in the Relativity
environment. Select a SQL server and click Generate Report to update the chart and table.
You can print the report or save it as a file (PDF/XLS/XLXS/HTML/Image).
Relativity | Performance Dashboard Guide - 19
4.2.5.2 Chart
The User Experience chart provides a visual indication of the user experience score as concurrency
increases including specific data points and trend lines for the following:
n
n
n
% Long Running Simple Queries (%LRSQ)
% Long Running Complex Queries (%LRCQ)
Score
Typically, as the concurrency increases, the system works harder and user experience degrades. It’s
common for the score to diminish as the concurrency increases. In the ideal scenario, concurrency
increases, but the percentage of long running queries doesn’t.
4.2.5.3 Grid
Relativity | Performance Dashboard Guide - 20
The User Experience grid shows the frequency of various queries grouped by concurrency. The
queries include:
n
n
n
n
n
n
Simple Queries
Complex Queries
Views
Edits
Mass Operations
Other
4.3 System Load page
The System Load score shows the performance of the Relativity infrastructure during times of high
activity. This is based on the CPU and RAM %used on all Web and SQL servers in the Relativity
environment. Full details on the scoring system can be found in the Appendix.
By default, the page shows the data for the server currently that has the worst performing system
load score. Change what data you see on the page using the toolbar at the top of the report.
4.3.1 Page header
The top of the System Load page includes three navigation buttons:
n
n
n
Back takes you back to the previous page
QoS Report takes you to the main QoS page
Concurrency Report takes you to the User Experience Concurrency Report Page
4.3.2 System Load Report
The System Load Report displays all the hours used to determine the current quarterly and weekly
system load scores. The table consists of the following columns:
Relativity | Performance Dashboard Guide - 21
n
Server
n
o The name and artifact ID of the server
Server Type
o
The options are SQL or Web
n
Hour
n
Aggregates are based on actions taken in the hour following the time indicated here (expressed
in your local time zone)
Overall Score
n
The server's system load score for a given hour, determined based on CPU/RAM utilization and
RAM paging. When the RAM utilization score is at least 80, paging is excluded from the overall
score.
CPU Utilization Score
n
The server's average CPU utilization should be less than 60%. Points are deducted for higher utilization with a maximum deduction at 85%.
RAM Utilization Score
n
Web Servers should have at least 1 GB of free memory on average. For SQL servers, at least 4 GB
should be free. Points are deducted on a logarithmic scale for higher utilization.
RAM Paging Score
n
If the RAM utilization score falls below 80, RAM pages per second will be factored into the overall
score. The maximum point deduction occurs when the average pages/second reaches 150.
Weekly Sample
o
o
o
o
o
o
Indicates whether the given hour is included in the weekly sample set.
From the System Load Report page you can navigate to the Server Health page for the specific day.
You can access the page by clicking on a row in the Hour, CPU Utilization Score, RAM Utilization
Score, or RAM Paging Score columns. You can also view system information for a particular server
by hovering over the server name. The system information will list the CPU type, total installed
RAM, and total free disk space for the primary disk.
4.4 Backups and DBCCs page
If you are using SQL Server’s native backup process, Performance Dashboard logs backups and
DBCC, tracking the success of each. If you are not using SQL Server’s native backup process, or if you
are offloading DBCC checks, you must provide a report detailing all backups and DBCCs being
performed.
This report is reconciled with the user experience active workspaces report. Please contact
[email protected] if you are offloading DBCC or using a method of backup that is not SQL aware.
Weekly backups and DBCC are required. Any gap greater than nine days is detected as a failing in
the backup or DBCC recommendations. The scoring is point-based, and points begin to accrue on the
tenth day after the last backup per the following formula: TotalPoints = (Days window exceeded by)2
- 1.
Relativity | Performance Dashboard Guide - 22
Failure to backup or perform DBCC of any one active database within seven days results in a failure
for this category. If as many as 128 databases miss one day, this also results in a failure and this
score will drop to zero percent.
4.4.1 Server summary
The Server Summary table lists all the SQL Servers in the Relativity instance, along with the number
of unresolved gaps and the total point deduction for these gaps.
4.4.2 Workspace summary
The Workspace Summary table lists all the Workspaces in the Relativity instance, by Workspace ID
and Friendly Name, along with the details of any missed days in the backup and dbcc schedule and
the point deduction for these missed days.
Relativity | Performance Dashboard Guide - 23
4.5 Uptime page
Uptime in an environment is scored using the audits in the EDDS audit table of agent logins. Scoring
parameters are as follows:
n
98 percent uptime scores 100 percent.
Between 80 – 98 percent uptime scores are calculated using the following:
n
(UptimeScore - 80)*100/18
80 percent or lower uptime results in a score of zero percent.
n
o
4.5.1 Chart
The Uptime chart shows additional data to provide insight into the system load metrics for CPU and
RAM % for the selected instance of the web servers. The data grid matches the data displayed in the
chart.
4.5.2 Uptime Grid
The Uptime grid shows the uptime % over the past 90 days and the uptime score.
Relativity | Performance Dashboard Guide - 24
4.5.3 Downtime Grid
The Downtime grid shows the date of any downtime, the total number of hours of downtime, and
the specific hours of downtime.
4.6 Application Health page
The Application Health page consists of three primary areas:
n
n
n
Page header below
Data grid on the next page
Chart on page 29
And has two primary data views:
n
n
Hourly View
Daily View
By default, the Grid and Chart are toggled on and loaded with the performance data from the past
24 hours. The Start Date and the End Date will be empty. You can return to this default time range
view by clicking Clear in the time range picker. The chart will be empty until a workspace is
selected.
4.6.1 Page header
The Page header contains the name of the page, a subheading that indicates the time range
captured in the dashboard , Grid and Chart toggle buttons, and Start Date and End Date fields.
You can change the Start Date and End Date of the time range for which performance data should
be displayed.
You can also pick from five predetermined date ranges:
n
n
n
n
n
Today
Yesterday
Past 7 days
Past month
Past 3 months
After selecting the desired dates in the date pickers, click Go to refresh the Grid and the Chart.
The Grid panel can be toggled on and off by clicking the Grid button. The Chart panel can be toggled
on and off by clicking the Chart button.
Relativity | Performance Dashboard Guide - 25
4.6.2 Data grid
The Data Grid displays a list of workspaces available in your instance of Relativity, a summary of the
performance of the workspace, the workspace artifact ID, the SQL instance the workspace resides
on, and the aggregated performance metrics.
4.6.2.1 Performance column
This is the overall health of the workspace based on kCura’s service standard. The status can be
Good (Green), Moderate (Yellow), or Poor (Red). The calculation is based on the selected time
frame and local SQL server time.
If you're looking at a time range greater than 24 hours, a number displays next to each status,
indicating the amount of days in the selected time range that were either Moderate or Poor. This is
because performance for a workspace could be Good for a specified time range and still have some
Moderate or Poor performing days.
When you're reviewing a 24-hour time range, no numbers display next to the statuses. Only the 24hour period will be referenced. You can select a 24-hour time range either by setting the Start Date
and End Date to the same date or by clearing the time range so that the Start Date and End Date
fields are empty.
Relativity | Performance Dashboard Guide - 26
Each status on the data grid is a hyperlink. Clicking on the performance status for a specific
workspace will bring up a separate page that shows the state of individual days in the selected time
range.
4.6.2.2 Last known backup
This is the timestamp of the last known backup taken for each database. If a backup has not been
taken for a particular database within the last 7 days, the field will display "Failed." This column
always shows the results for the current day, regardless of the time range selected.
4.6.2.3 Integrity
This is the timestamp of the last known time a DBCC CheckDB was performed against each
database. If a CheckDB has not been performed for a particular database within the last 7 days, the
field will display "Failed." This column always shows the results for the current day, regardless of the
time range selected.
4.6.3 Performance metrics
The metrics that are used to measure Application Performance include the following:
n
Long Running Queries (LRQs)
Any document query that takes longer than two seconds to complete is recorded here. This calculation
is based on the select time frame and the end user's local time.
n
Critical Errors
The following items are polled from the error table in the EDDS database. This calculation is based on
the select time frame and the end user's local time. A hit on any one of these items will result in a tally
of the error:
'%Read Failed%'
'%Delete Failed%'
o '%Create Failed%'
o '%Update Failed%'
o '%object reference not set to an instance of an object%'
o '%SQL Statement Failed%'
o '%Unable to connect to the remote server%'
o 'Native Document Viewer'
Average Latency
o
o
n
While a user is actively viewing documents in Relativity, information about the performance is sent
back to be recorded. This happens every five minutes, and the data is stored in the EDDS database in a
the WebClientPerformance table. Latency information is stored in the Latency column of this table. To
test latency, the client sends an http request to the Relativity WebAPI. The "latency” is the amount of
time it takes from the time of the request to the time the client receives the response. This number will
increase as a web server experiences greater load. It will also be high if there is a network issue. This
calculation is based on the select time frame and the end user's local time.
n
Active Users
The average number of users in the workspace for the specified time range. This calculation is based on
the select time frame and the end user's local time.
Relativity | Performance Dashboard Guide - 27
These metrics are collected at intervals specified during configuration. Refer to the Relativity
Performance Dashboard Configuration Guide for details.
4.6.3.1 Navigating grid data
If the number of workspaces in the environment exceeds the number of records displayed per page
(10 by default), you can navigate the record set using the page navigation buttons.
first page
1 page back
1 page forward
last page
The number of records in a set can be changed using the records-per-page drop-down menu.
4.6.3.2 Sorting grid data
Records in the grid can be sorted by clicking the name of the column in the column header. Clicking
the same column header again reverses the sort order.
4.6.3.3 Filtering grid data
Records in the grid can be filtered by clicking the Show Filter link above the grid, specifying the
filter criteria in the displayed filter fields, and clicking Apply Filters or pressing the Enter key.
The key icon to the right of the filter field can be used to change the type of filtering condition.
Text field conditions include the following:
n
n
n
n
n
n
Begins with
Contains
Doesn't contain
Ends with
Equals
Doesn't equal
Numeric field conditions include the following:
n
n
n
n
n
n
Equals
Doesn't equal
Is less than
Is less than or equal to
Is greater than
Is greater than or equal to
When you click the Show Filter link, the link switches to Hide Filter and vice versa. Click Hide Filter
to hide the filter input fields that were displayed after clicking Show Filter.
Relativity | Performance Dashboard Guide - 28
4.6.3.4 Exporting grid data
Data loaded in the grid can be exported to one of the following formats by clicking the
corresponding button.
n
n
n
CSV - Comma Separated Values
XLS - MS Excel 97-2003
XLSX - MS Excel 2007-2010
4.6.3.5 Selecting records for display on chart
To display only certain workspaces on the chart, select the checkboxes to the left of their names. By
default, if no workspaces are checked when the Chart button is clicked, the chart will have an empty
display.
4.6.4 Chart
The Chart panel contains the following elements:
n
n
n
Fit to Screen button
Chart Type selector
Show Columns selector
4.6.4.1 Fit to screen
Use this function to resize the chart to fit inside the visible area of the screen.
4.6.4.2 Chart type
Use this function to resize the chart to fit inside the visible area of the screen.
Relativity | Performance Dashboard Guide - 29
n
n
Line Graph
Bar Graph
4.6.4.3 Show columns
Use this function to select which metrics to display on the chart:
n
n
n
n
LRQs
Critical Errors
Average Latency
Active Users
4.7 Server Health page
The Server Health page consists of three primary areas:
n
n
n
Page Header
Data Grid
Chart
It has two primary data views:
n
n
Hourly View
Daily View
By default, the Grid and Chart are toggled on and load with the performance data from the past 24
hours. The Start Date and the End Date will be empty. You can return to this default time range view
by clicking Clear in the time range picker. The chart will be empty until a workspace is selected.
4.7.1 Page header
The Page header contains the title of the page , a drop-down menu selector for the type of
performance metrics, a subheading which indicates what timeframe is captured in the dashboard,
Grid and Chart toggle buttons, and Start Date and End Date pickers.
You can select which aspect of server performance to examine by selecting one of the options from
the drop-down selector to the right of the Page Title:
n
n
n
n
Memory (RAM)
Processor
Hard Disks
SQL Server
You can change the Start Date and End Date of the time range for which performance data should
be displayed. After selecting the desired dates in the date pickers, click Go to refresh the Grid and
the Chart.
The Grid panel can be toggled on and off by clicking the Grid button. The Chart panel can be toggled
on and off by clicking the Chart button.
Relativity | Performance Dashboard Guide - 30
4.7.2 Data grid
The Data Grid displays a list of server names available in your Relativity environment, the server
type, and the aggregated performance metrics. The metrics used to measure Server Health depend
on the option selected in the drop-down list next to the page title. These options include:
Memory (RAM):
n
n
Pages/sec - This value is often confused with Page Faults/sec. The Pages/sec counter is a combination
of Pages Input/sec and Pages Output/sec counters. This counter, however, is a general indicator of
how often the system is using the hard drive to store or retrieve memory-associated data.
Page Faults/sec - This is a combination of hard page faults and soft page faults. A page fault is generated and trapped whenever a program accesses a page that is mapped in the virtual address space,
but it isn't in physical RAM (the physical cards on the server). Servers and computers utilize a portion of
the disk, called the swap file, or page file, for additional storage. In a soft page fault, the page actually is
in memory but isn't marked in the memory management unit as being active. These faults don't provoke disk reads, so they're less expensive than hard faults. Hard faults result in a read from disk from
the page file.
Processor:
n
CPU Processor Time % - This counter measures of how much time the processor actually spends
working on productive threads and how often it was busy servicing requests. The processor can never
be sitting idle waiting to the next task, so NT gives the CPU something to do when there's nothing
waiting in the queue. This is called the idle thread. The system can easily measure how often the idle
thread is running as opposed to having to tally the run time of each of the other process threads. The
counter simply subtracts the percentage from 100 percent.
Hard Disk:
n
n
Avg. Disk sec/Read - The value for this counter is generally the number of seconds it takes to do each
read. On less complex disk subsystems involving controllers that don't have intelligent management of
the I/O, this value is a multiple of the disk's rotation per minute. The rotational speed of the hard drive
is the primary factor in the value with the delays imposed by the controller card and support bus system.
Avg. Disk sec/Write - The value for this counter is generally the number of seconds it takes to do each
write. On less complex disk subsystems involving controllers that don't have intelligent management of
the I/O, this value is a multiple of the disk's rotation per minute. The rotational speed of the hard drive
Relativity | Performance Dashboard Guide - 31
is the primary factor in the value with the delays imposed by the controller card and support bus system.
SQL Server:
n
Page Life Expectancy - The number of seconds a page will stay in the buffer pool without references.
These metrics are collected at intervals specified during configuration. See Installing Performance
Dashboard on page 5.
Note: For more information on performance monitor counters, see http://technet.microsoft.com/enus/library/cc768048.aspx.
4.7.2.1 Navigating grid data
If the number of workspaces in the environment exceeds the number of records displayed per page
(10 by default), you can navigate the record set using the page navigation buttons.
first page
1 page back
1 page forward
last page
Use the records-per-page drop-down menu to change the number of records in a set.
4.7.2.2 Sorting grid data
You can sort the records in the grid can be sorted by clicking the name of the column in the column
header. Clicking the same column header again reverses the sort order.
4.7.2.3 Filtering grid data
You can filter the records in the grid by clicking the Show Filter link above the grid, specifying the
filtering criteria in the displayed filter fields, and clicking Apply Filters or pressing the Enter key.
You can use the key icon to the right of the filter field to change the type of filtering condition.
Text field conditions include the following:
n
n
n
Begins with
Contains
Doesn't contain
Relativity | Performance Dashboard Guide - 32
n
n
n
Ends with
Equals
Doesn't equal
Numeric field conditions include the following:
n
n
n
n
n
n
Equals
Doesn't equal
Is less than
Is less than or equal to
Is greater than
Is greater than or equal to
When you click the Show Filter link, the link switches to Hide Filter and vice versa. Click Hide Filter
to hide the filter input fields that appear after clicking Show Filter.
4.7.2.4 Exporting grid data
Data loaded in the grid can be exported to one of the following formats by clicking the
corresponding button:
n
n
n
CSV - Comma Separated Values
XLS - MS Excel 97-2003
XLSX - MS Excel 2007-2010
4.7.2.5 Selecting records for display on chart
To display only certain workspaces on the chart, select the checkboxes to the left of their names. If
no workspaces are selected when the Chart button is clicked, the chart displays all workspaces.
4.7.3 Chart
The Chart panel contains the following elements:
n
n
Fit to Screen button
Chart Type selector
Relativity | Performance Dashboard Guide - 33
n
Show Columns selector
4.7.3.1 Fit to screen
Use this function to resize the chart to fit inside the visible area of the screen.
4.7.3.2 Chart type
Use this function to switch between two types of graphs:
n
n
Line Graph
Bar Graph
4.7.3.3 Show Columns
Use this function to select which metrics appear on the chart (depending on the Server Health
option from the drop-down menu next to the page title):
n
Memory (RAM)
n
Pages/Sec
Page Faults/Sec
Processor
n
CPU Processor Time (%)
Hard Disks
n
Disk Avg Sec/Read
Disk Avg Sec/Write
SQL Server
o
o
o
o
o
o
Page Life Expectancy
4.8 Configuration Page
The configuration page contains a form to input Trust Settings for Best in Service partners
participating in the Trust Website.
Relativity | Performance Dashboard Guide - 34
The form contains the following fields:
n
Trust ID
n
Provided by kCura
Partner
n
The name you would like displayed on reports
Send Scores Automatically
n
Turn on to have the Performance Dashboard - Trust Agent send scores automatically to the
Trust website
Send Notifications
n
Turn on to enter an email address to send Trust notifications to
Last Sent
n
o The date that scores were last sent to the Trust website
Score Date
o
o
o
o
o
The date that the weekly score was last compiled
If scores can also be manually exported with the Export button. The exported file can then be
emailed to kCura for posting to the Trust website.
4.9 Backfill Console
The Backfill Console shows the current status of the Looking Glass call to collect hourly metrics.
From this page you can also backfill up to 90 days of metrics. NOTE: A manual backfill of data
should only be performed after contacting kCura Client Services.
Relativity | Performance Dashboard Guide - 35
The Backfill console consists of two sections; the Current Status and the Backfill Data. The Current
Status has the following fields:
n
Sample Range
o
The date range from the first run of Looking Glass to the last time it ran
n
Status
n
The status of the current run of Looking Glass
Last Run Start
Last Check-in
o
n
The last time Looking Glass wrote to the GlassRunLog table
Run Duration
Last Message
o
n
n
o
The last message written to the GlassRunLog Table
The Backfill Data consists of a field for the number of days back to go for a backfill. The number
should be positive and cannot be greater than 90.
5 Troubleshooting Performance dashboard
5.1 Installation troubleshooting
Three main types of errors can occur when installing PDB:
n
n
n
Server connection errors
Workspace connection errors
Web Page connection errors
5.1.1 Server connection errors
These errors are found in the Event Viewer of the agent server where the Performance Dashboard
Agent is installed. These errors are usually one of two types: an ‘Access is denied’ error, or an ‘RPC
server is unavailable’ error.
The Access is denied error indicates the agent service does not have DCOM access to the remote
server. The IP address is listed in the error.
To resolve this error:
1.
2.
3.
4.
5.
6.
7.
Ensure DCOM is enabled.
Run DCOMCNFG.exe.
Expand Component Services and Computers.
Right-click My Computer and select Properties.
Click Default Properties in My Computer Properties.
Select Enable Distributed COM on this computer.
Make sure the PDB service account is an administrator on the remote server.
Relativity | Performance Dashboard Guide - 36
The RPC server is unavailable error indicates the Windows service cannot find the remote server.
The IP address is listed in the error.
To resolve this error:
1.
2.
3.
4.
5.
Make sure the remote server is powered on and accessible.
Check for any DNS conflicts.
Try to connect via WMI to the remote server.
Make sure WMI or port 135 isn't blocked in a firewall rule.
Check if the remote server is listening on port 135.
a. From the remote server run NETSTAT –a | find “:135”.
6. Copy the installation directory to the AD site and convert the directory to an application.
5.1.2 Workspace connection errors
Workspace connections errors are found in the Windows Event Viewer on the server where the
Performance Dashboard Agent is installed.
The following error indicates the database is in single-user mode:
Message: GetPerformanceMetrics Called - Failure. Details: Database 'EDDS1017071' is already
open and can only have one user at a time.
5.1.3 Web page connection errors
Web page connection errors can occur in Internet Explorer when trying to access the Application
Performance or Server Health web pages.
The following error is a generic error. Log in to a web server where PDB is installed and log in to
Relativity using localhost. Try to open up the web page again to get a more specific error.
Object reference is not set to an instance of an object
Relativity | Performance Dashboard Guide - 37
Proprietary Rights
This documentation (“Documentation”) and the software to which it relates (“Software”) belongs
to kCura LLC and/or kCura’s third party software vendors. kCura grants written license agreements
which contain restrictions. All parties accessing the Documentation or Software must: respect
proprietary rights of kCura and third parties; comply with your organization’s license agreement,
including but not limited to license restrictions on use, copying, modifications, reverse engineering,
and derivative products; and refrain from any misuse or misappropriation of this Documentation or
Software in whole or in part. The Software and Documentation is protected by the Copyright Act of
1976, as amended, and the Software code is protected by the Illinois Trade Secrets Act. Violations
can involve substantial civil liabilities, exemplary damages, and criminal penalties, including fines
and possible imprisonment.
©2015. kCura LLC. All rights reserved. Relativity® and kCura® are registered trademarks of kCura
LLC.
Relativity | Performance Dashboard Guide - 38
Was this manual useful for you? yes no
Thank you for your participation!

* Your assessment is very important for improving the work of artificial intelligence, which forms the content of this project

Download PDF

advertisement