Performance Dashboard Guide

Transcription

1 Performance Dashboard Guide v8.0 May 10, 2013 For the most recent version of this document, visit kcura's Documentation Site.

2 Table of Contents 1 Overview System requirements Installation Upgrade 3 2 Installing Performance Dashboard Installing to the Application Library Creating the Performance Dashboard workspace Installing PDB to the Performance Dashboard workspace Adding the Performance Dashboard agent Server connection errors Workspace connection errors Web page connection errors Configuration details 6 3 Upgrading Performance Dashboard Preparing the web server Removing the Windows service Removing tabs in Relativity Configuring the database component Installing PDB to the Application Library Creating the Performance Dashboard workspace Installing PDB to the Performance Dashboard workspace Adding the Performance Dashboard agent 10 4 Accessing Performance Dashboard Application Health page Page header Data grid Chart Server Health page Page header Data grid Chart 20 Relativity Performance Dashboard Guide - 2

3 1 Overview The Performance Dashboard (PDB) application is a diagnostic measurement reporting tool integrated into Relativity. It enables Relativity administrators to evaluate how the environment performs over time by reviewing specific metrics for their workspaces. The PDB can generate both a grid and a graphical display within the Relativity environment. Both displays include the ability to filter on dates, workspaces, and key performance indicators. 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 7 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: EDDSPerformance Database resides on the same database server as the main Relativity database. It's used primarily as a repository for collected and aggregated performance data. Performance Dashboard Agent resides on one of the agent servers in the Relativity environment. It runs in the background, kicking off processes that measure overall application health as well as the 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: Relativity Performance Dashboard Guide - 3

4 1. Log in to Relativity as a System Administrator and go into Admin mode. 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 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. Go to Workspaces mode. 2. Click New Workspace. 3. Name the workspace Performance Dashboard. 4. All other settings can be whatever you choose. Note: You should delete this workspace after the Performance Dashboard Agent runs and you confirm that PDB s custom pages are functioning properly. 2.3 Installing PDB to the Performance Dashboard workspace You can install the PDB application to your new workspace from the Application Library tab in Admin mode 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. 2.4 Adding the Performance Dashboard agent When started, the Performance Dashboard Agent will create the EDDSPerformance database and create the Performance Dashboard tabs in Admin mode. Perform the following steps to install the agent: 1. Navigate to the Agents tab in Admin mode and click the New Agent button. 2. Click next to Agent Type, select the radio button for Performance Dashboard Agent, and click Ok. 3. Click next to Agent Server and select the agent server where you want to install the new agent. Click Ok. 4. Leave all other settings as default and click Save. The agent should now start up and begin performing its initial tasks. The kcura Relativity Web Pro- Relativity Performance Dashboard Guide - 4

5 cessing web service will pick up the new custom pages for PDB and handle the creation of the web application in IIS. 5. Ensure that the custom pages are working properly by navigating to them under the Performance Dashboard tab in Admin mode. 6. Once you confirm proper functionality, delete the Performance Dashboard workspace as it's no longer needed. For installation troubleshooting information, see Installation troubleshooting below. Installation troubleshooting Three main types of errors can occur when installing PDB: Server Connection Errors, Workspace Connection Errors, and Web Page Connection Errors 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, either an Access is denied error or an RPC server is unavailable error. The Access is denied error indicates that the agent service does not have DCOM access to the remote server. The IP address will be listed in the error. To resolve this error: 1. Ensure DCOM is enabled. 2. Run DCOMCNFG.exe. 3. Expand Component Services and Computers. 4. Right-click My Computer and select Properties. 5. Click Default Properties in My Computer Properties. 6. Select Enable Distributed COM on this computer. 7. Make sure the PDB service account is an administrator on the remote server. The RPC server is unavailable error indicates that the Windows service cannot find the remote server. The IP address will be listed in the error. To resolve this error: 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 is not blocked in a firewall rule. Check if the remote server is listening on port 135. o From the remote server run NETSTAT a find : Workspace connection errors These errors are found in the Event Viewer of the server where the Performance Dashboard Agent is installed. Message: GetPerformanceMetrics Called - Failure. Details: Database 'EDDS ' is already open and can only have one user at a time. The database is in single-user mode. Relativity Performance Dashboard Guide - 5

6 2.4.3 Web page connection errors These errors can show up in Internet Explorer when trying to access the Application Performance or Server Health web pages. Object reference is not set to an instance of an object This is a generic error. Log into one of the web servers where PDB is installed, log into Relativity using localhost and try to bring up the web page. Now you should get a more specific error. 2.5 Configuration details The Measure and ProcessControl tables contain the configuration information for Performance Dashboard. The Measure table contains information about the performance measurements collected in the environment. MeasureCd 1 LRQ Long Running Queries 2 Errors Critical Errors 3 Latency Average Latency 4 Users Active Users 5 RAMPagesPer- Sec 6 RAMPageFaultsPerSec 7 DiskAvgSecPer- Read 8 DiskAvgSecPer- Write 10 CPUProcessorTimePct 11 SQLPageLifeExpectancy /4/12 14: /4/12 14: /4/12 14: /4/12 14:31 RAM /4/12 Pages/Sec 14:31 RAM Page Faults/Sec Disk Avg Sec/Read Disk Avg Sec/Write CPU Processor Time (%) Page Life Expectancy /4/12 14: /4/12 14: /4/12 14: /4/12 14: /4/12 14:31 MeasureID MeasureDesc MeasureTypeId IsActive IsDeleted CreatedOn UpdatedOn Frequency LastDataLoadDateTime NULL 60 6/29/12 20:41 NULL 60 6/29/12 20:02 NULL 60 6/29/12 20:02 NULL 5 6/29/12 15:57 NULL 5 NULL NULL 5 NULL NULL 5 NULL NULL 5 NULL NULL 5 NULL NULL 5 NULL Relativity Performance Dashboard Guide - 6

7 Note: MeasureDesc describes the measurement that is used in column headings. Frequency defines the interval in minutes at which individual measurements are taken. The ProcessControl table contains information about the execution of data collection services. ProcessControlID ProcessTypeDesc LastProcessExecDateTime Frequency 1 Application Metrics DW Load 6/29/12 20: Server Health Summary 6/29/12 20: Server Info Refresh 6/29/12 20: BISSummary Refresh 6/29/12 15: Note: LastProcessExecDateTime reflects the date and time at which the process was most recently executed. Frequency defines the interval in minutes at which individual measurements are taken. 3 Upgrading Performance Dashboard This section describes the process to upgrade Performance Dashboard for Relativity 7.5. Note: Upgrading Performance Dashboard is applicable only if you haven't run a previous upgrade to include the Performance Status column on the Application Performance web site. When the new Performance Dashboard Agent starts for the first time, it alters and re-populates the LRQ table with new values. Depending on the number of workspaces in the environment, this could take many hours to complete. We recommend running this upgrade during off-peak hours. 3.1 Preparing the web server The upgrade process for this build will automatically install and configure web server components. Because of this, you must first remove the applications and application pools in IIS. To do so, follow these steps: 1. Open IIS. Stop the PDBApplicationPool and the PDBSVCApplicationPool (if it exists). 2. Remove the kcura.pdb.web and kcura.pdb.webservice (if it exists) applications. 3. Delete the kcura.pdb.web and kcura.pdb.webservice (if it exists) folders from the installation directory. 4. Remove the PDBApplicationPool and the PDBSVCApplicationPool (if it exists). 3.2 Removing the Windows service In this build of PDB, the Windows service is replaced by the Performance Dashboard Agent, which installs to one of your agent servers. Because of this, you need to first remove the old Windows service to avoid conflict. Perform the following steps to uninstall the windows service: Relativity Performance Dashboard Guide - 7

8 1. Stop the Windows service: a. Start Menu > Administrative Tools > Services b. Select the Relativity Performance Data Collection Service. c. Stop the service. 2. From the command prompt, use the following command to change the directory to the kcura.pdb.windowsservice directory: cd <PDB_ROOT>\kcura.pdb.windowsservice 3. In the command prompt, use the following command to uninstall the service: c:\windows\microsoft.net\framework\v \installutil.exe kcura.pdd.windowsservice.exe u 4. Remove the kcura.pdb.windowsservice folders from the installation directory. At this point, you may completely remove the Performance Dashboard installation directory. 3.3 Removing tabs in Relativity This build of PDB creates tabs in the Admin mode of Relativity. The new tabs point to the new location of the PDB web application, so the old tabs are no longer needed. Remove these tabs from Relativity by following these steps: 1. Log into Relativity and go into Admin mode. 2. Navigate to the Tabs tab. 3. Select the checkbox next to the Application Performance and Server Health tab. You must delete these tabs before the parent tab or you'll receive a dependency error. 4. Select the Delete mass operation in the bottom left corner and click the Go button. 5. Click OK. 6. Repeat steps 3-5 for the Performance Dashboard parent tab. 3.4 Configuring the database component Note: If you're upgrading from a version of Performance Dashboard prior to , you must first run the EDDSPerformance_DB_BIS.sql script against the primary SQL instance. This script is included in the PDB package, which can be found on the Customer Portal. 1. Change the owner to the EDDSPerformance database to the eddsdbo SQL login. This is required prior to running the Relativity application. 2. Open SQL Server Management Studio, connect to the primary SQL instance, and expand the Security section. 3. Expand Logins and select the eddsdbo login. 4. Right-click the eddsdbo login and select Properties. Relativity Performance Dashboard Guide - 8

9 5. Select the User Mapping page and then select the EDDSPerformance database. 6. In the lower section, ensure that the db_owner and public record role memberships are selected. 7. Click OK. 3.5 Installing PDB to the Application Library Perform the following steps to install Performance Dashboard to Relativity s Application Library: 1. Log into Relativity as a System Administrator and go into Admin mode. 2. Navigate to the Application Library tab and click the Upload Application button. 3. Click the Browse button and browse to the.rap file for the PDB application. 4. Click Save. The application should now be added to the library. 3.6 Creating the Performance Dashboard workspace Create a new workspace in Relativity as you normally would: 1. Go to Workspaces mode. 2. Click New Workspace. 3. Name the workspace Performance Dashboard. 4. All other settings can be whatever you choose. Note: This workspace should be deleted after the Performance Dashboard Agent runs and you confirm that PDB s custom pages are functioning properly. 3.7 Installing PDB to the Performance Dashboard workspace The PDB application can be installed to your new workspace from the Application Library tab in Admin mode 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. Under the Application Type section, select the radio button for Select from Application Library. 3. Click to browse the application library. Relativity Performance Dashboard Guide - 9

10 4. Select the Performance Dashboard application and click OK. 5. Click Import. 3.8 Adding the Performance Dashboard agent When started, the Performance Dashboard Agent will create the Performance Dashboard tabs in Admin mode. Perform the following steps to install the agent: 1. Navigate to the Agents tab in Admin mode and click the New Agentbutton. 2. Click next to Agent Type, select the radio button for Performance Dashboard Agent, and click OK. 3. Click next to Agent Server and select the agent server on which you would like to install the new agent. Click OK. 4. Leave all other settings as default and click Save. The agent should now start up and begin performing its initial tasks. The kcura Relativity Web Processing web service picks up the new custom pages for PDB and handles the creation of the web application in IIS. 5. Ensure that the custom pages are working properly by navigating to them under the Performance Dashboard tab in Admin mode. 6. Once you confirm proper functionality, delete the Performance Dashboard workspace as it's no longer needed. 4 Accessing Performance Dashboard To access the Performance Dashboard, perform the following steps: 1. In Relativity, select Admin mode. 2. Click the Performance Dashboard tab and select Application Health or Server Health. For detailed information, see Application Health page below and Server Health page on page Application Health page The Application Health page consists of three primary areas: Page header on the next page Data grid on page 12 Chart on page 15 And has two primary data views: 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. Relativity Performance Dashboard Guide - 10

11 4.1.1 Page header The Page header contains the name of the page (in the following example, Performance Dashboard: Application Performance), a subheading that indicates the time range captured in the dashboard (from 10/6/ :01:40 through 10/7/ :01:39), 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. 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 - 11

12 4.1.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 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). 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 24-hour 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 - 12

13 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 Performance metrics The metrics that are used to measure Application Performance include the following: Long Running Queries (LRQs) Any document query that takes longer than two seconds to complete is recorded here. Critical Errors The following items are polled from the error table in the EDDS database. A hit on any one of these items will result in a tally of the error: o o o o o o o o '%Read Failed%' '%Delete Failed%' '%Create Failed%' '%Update Failed%' '%object reference not set to an instance of an object%' '%SQL Statement Failed%' '%Unable to connect to the remote server%' 'Native Document Viewer' Relativity Performance Dashboard Guide - 13

14 Average Latency 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. Active Users The average number of users in the workspace for the specified time range. These metrics are collected at intervals specified during configuration. Refer to the Relativity Performance Dashboard Configuration Guide for details 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 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 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: Begins with Contains Doesn't contain Ends with Equals Doesn't equal Numeric field conditions include the following: Equals Doesn't equal Relativity Performance Dashboard Guide - 14

15 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 Exporting grid data Data loaded in the grid can be exported to one of the following formats by clicking the corresponding button. CSV - Comma Separated Values XLS - MS Excel XLSX - MS Excel 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 Chart The Chart panel contains the following elements: Fit to Screen button Chart Type selector Show Columns selector Fit to screen Use this function to resize the chart to fit inside the visible area of the screen. Relativity Performance Dashboard Guide - 15

16 Chart type Use this function to resize the chart to fit inside the visible area of the screen. Line Graph Bar Graph Show columns Use this function to select which metrics to display on the chart: LRQs Critical Errors Average Latency Active Users 4.2 Server Health page The Server Health page consists of three primary areas: Page Header Data Grid Chart It has two primary data views: Hourly View Daily View Continue to the following sections for further details on these page areas and data views. 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 Page header The Page header contains the title of the page (in the following example, Performance Dashboard: Server Health), a drop-down selector for the type of performance metrics, a subheading which indicates what timeframe is captured in the dashboard (from 10/05/ :06:11 through 10/06/ :06:10), Grid and Chart toggle buttons, and Start Date and End Date pickers. Relativity Performance Dashboard Guide - 16

17 You can select which aspect of server performance to examine by selecting one of the options from the dropdown selector to the right of the Page Title: 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 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): 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: 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 Relativity Performance Dashboard Guide - 17

18 Hard Disk: 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. 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 is the primary factor in the value with the delays imposed by the controller card and support bus system. SQL Server: 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 Configuration details on page 6. Note: For more information on performance monitor counters, see 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 to change the number of records in a set 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 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. Relativity Performance Dashboard Guide - 18

19 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: Begins with Contains Doesn't contain Ends with Equals Doesn't equal Numeric field conditions include the following: 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 Exporting grid data Data loaded in the grid can be exported to one of the following formats by clicking the corresponding button: CSV - Comma Separated Values XLS - MS Excel XLSX - MS Excel 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. Relativity Performance Dashboard Guide - 19

20 4.2.3 Chart The Chart panel contains the following elements: Fit to Screen button Chart Type selector Show Columns selector Fit to screen Use this function to resize the chart to fit inside the visible area of the screen Chart type Use this function to switch between two types of graphs: Line Graph Bar Graph Show Columns Use this function to select which metrics appear on the chart (depending on the Server Health option from the drop down next to the page title): Memory (RAM) o Pages/Sec o Page Faults/Sec Processor o CPU Processor Time (%) Hard Disks o Disk Avg Sec/Read o Disk Avg Sec/Write SQL Server o Page Life Expectancy Relativity Performance Dashboard Guide - 20

21 Proprietary Rights This documentation ( Documentation ) and the software to which it relates ( Software ) belongs to kcura Corporation 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 kcura Corporation. All rights reserved. Relativity and kcura are registered trademarks of kcura Corporation. Relativity Performance Dashboard Guide - 21