PBS Analytics 12.2 Administrator’s...

PBS Works is a division of

PBS AnalyticsTM 12.2

Administrator’s Guide

Altair PBS Analytics 12.2 Administrator’s Guide Administrators Guide updated 12/10/13

Copyright© 2003-2013 Altair Engineering, Inc. All Rights Reserved

Altair PBS Works, Compute Manager™, Display Manager™, PBS™, PBS Works™, PBS Professional®, PBS Application Services™, PBS Analytics™, PBS Desktop™, PBS Por-tal™, e-BioChem™, e-Compute™ and e-Render™ are trademarks of Altair Engineering, Inc. and are protected under U.S. and international laws and treaties.

All other marks are the property of their respective owners.

Copyright notice does not imply publication. Contains trade secrets of Altair Engineering, Inc. Decompilation or disassembly of this software is strictly prohibited. This software is pro-tected under patent #6,859,792 and other patents pending. Usage of Altair Engineering, Inc. software is only as explicitly permitted as stated in the end user software license agreement.

Third Party Agreements

http://www.altairhyperworks.com/ClientCenter3rdPartyLicense.aspx

Table of Contents

1 About PBS Analytics™ 11.1 System Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21.2 Supported Platforms and Browsers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51.3 Chart rendering response time. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

2 Deployment Options 72.1 Deployment Option One . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82.2 Deployment Option Two. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92.3 Deployment Option Three. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

3 Pre-installation Preparation 113.1 Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113.2 Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143.3 Parsing the accounting logs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143.4 PBS Professional considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

4 Installing PBSA GUI mode 194.1 Installing on a single server. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194.2 Installing on separate servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

5 Installing PBSA console mode 635.1 Installing on a single server. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 635.2 Installing on separate servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76

6 Uninstalling PBSA 936.1 Uninstalling using the GUI mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 936.2 Uninstalling using the console mode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97

PBS Analytics 12.2 Administrator’s Guide iii

Table of Contents

7 Post-installation 997.1 Setting up the system path. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1007.2 Opening the web application port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1007.3 Resetting the database user password . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1017.4 Providing a license server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1017.5 Configuring PBSA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1027.6 Starting PBSA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1037.7 Parsing the accounting logs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1037.8 Logging into the PBSA web application. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104

8 Configuring node details 1058.1 Obtain node information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1068.2 Run the node configuration command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1068.3 Evaluate offline or downed nodes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1078.4 Node configuration for previous years . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108

9 Optional configuration 1119.1 Configuring holidays. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1129.2 Configuring prime and non-prime hours . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1139.3 Configuring custom groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1159.4 Configuring exit codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1169.5 Configuring custom resources. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117

10 Starting PBSA 11910.1 Configuring the PBSA data collector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11910.2 Configuring the PBSA parser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12010.3 Starting the web application and parser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12110.4 Starting the data collectors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122

11 Parsing the accounting logs 12511.1 Initial parsing of the accounting logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12711.2 Daily parsing of the accounting logs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12811.3 Configuration changes after initial parsing . . . . . . . . . . . . . . . . . . . . . . . . . . . 128

12 PBSA service commands 13112.1 Web application service commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13112.2 Data collector service commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133

iv PBS Analytics 12.2 Administrator’s Guide

Table of Contents

13 PBSA commands 13513.1 Configuring nodes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13513.2 Configuring holidays. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14313.3 Configuring custom groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15413.4 Configuring exit codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16213.5 Configuring the data collector. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16913.6 Configuring the parser. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17413.7 Resetting the PBSA dataset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17913.8 Resetting the data collector dataset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18413.9 Change the PBSA database password . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186

14 Log files 191

15 PBSA Measures & Dimensions 19315.1 Dimensions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19315.2 Measures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199

16 Troubleshooting 20916.1 Troubleshooting PBSA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209

17 PBSA configuration files 21917.1 Holiday configuration file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21917.2 Exit code configuration file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22617.3 Custom group configuration file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22917.4 Custom resource configuration file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23717.5 Node details file. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243

18 Advanced Configuration 26918.1 Configuring SSL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26918.2 Configuring logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27518.3 Configuring the license server. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27718.4 Configuring JVM Performance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28118.5 Configuring SSH Authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28318.6 Changing the accounting log location . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28418.7 Changing web application hostname:port . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28418.8 Configuring plot point decimation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28618.9 Changing the license schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28918.10 Configuring raw data fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29018.11 Creating custom queries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296

19 Reparsing the accounting logs 30519.1 Deployment on a single machine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30519.2 Deployment on separate machines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306

PBS Analytics 12.2 Administrator’s Guide v

Table of Contents

20 Disaster Recovery 30720.1 Backing up PBSA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30720.2 Restoring PBSA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31020.3 Backing up the PBSA database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31120.4 Restoring the PBSA database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312

Index 315

vi PBS Analytics 12.2 Administrator’s Guide

Chapter 1

About PBS Analytics™

Altair PBS Analytics™ (PBSA) is a graphical web-based accounting, analytics and reporting solution. Historical usage data can be queried with respect to jobs, applications, users, proj-ects, groups, and many more. The application provides PBS Works™ administrators with advanced job and license analysis to support data-driven planning and decision-making.

Companies and institutions of all sizes use high performance computing to develop innova-tive new products and create entirely new markets. As a result, application workloads have become much larger and more complex than ever before. Comprehensive and robust analysis and visualization features are needed to help ensure limited computing resources are being used effectively and efficiently. As a core part of a PBS Works™ solution, PBS Analytics turns oceans of data into insight, knowledge and intelligence.

With PBS Analytics users can:

• Access and view charts and graphs via a web browser interface, anytime and anywhere

• Validate project planning assumptions and easily rebalance workloads to meet changing priorities

• Generate detailed billing details to support chargeback accounting

• Easily build customized performance dashboards for users, administrators and manage-ment

• Dynamically create and graph historic usage data from one or many PBS Professional servers

PBS Analytics 12.2 Administrator’s Guide 1

Chapter 1 About PBS Analytics™

1.1 System Requirements

The machine where PBSA is being installed must be running Python 2.4 or greater.

1.1.1 Optimal hardware requirements for PBSA engine

Notes:

• Two (2) GB of free RAM and ten (10) GB of free hard disk space are recommended for each instance of a data collector.

• Swap space is recommended in a separate physical drive.

Table 1-1: Optimal hardware requirements per license schema

Licensing recordsLicense

typeCPU

RAM(GB)

Swap(GB)

Disk Space(GB)

up to 0.5 million Base 4 core 16 32 32

0.5 million to 2 million Standard 4 core 16 64 32

2 million to 5 million Standard 4 core 32 128 64

5 million to 50 million Advanced Consult PM team

2 PBS Analytics 12.2 Administrator’s Guide

P 3

Chapter 1

1

E ing specifications:

•

•

•

Parsing time

Browser

56 min

19 sec

Chrome 29

5 hours

44 min

Chrome 29

48 min

29 sec

Chrome 29

1 hour

26 min

50 sec

Chrome 29

BS Analytics 12.2 Administrator’s Guide

About PBS Analytics™

.1.2 Parsing benchmarking data

ach row indicates benchmarking based on a specific customer’s data on a machine with the follow

Operating system: CentOS 6.3

Number of CPUs: 8

Memory (GB): 68

Table 1-2: Parsing Benchmarking Data

No. of E Recs

No. of License

Recs

No. of DB Recs

No. of Nodes

DB Size (GB)

MonetdbRAM

consumed (GB)

Java PortalRAM

consumed(GB)

316,858 1,752,317 2,894,188 3,597 6.1 10.10 5.24

1,078,313 4,362,775 14,433,546 1,375 28 31.36 6.99

387,793 940,538 2,631,236 428 5.1 8.90 4.55

1,381,555 1,601,350 3,171,101 175 15 14.33 3.01

C

4 S Analytics 12.2 Administrator’s Guide

1

I st 10 GB of free hard disk space should b Professional accounting log dataset (30-5 ing used by the PBS Professional a

46 min Firefox ESR 24.0



45 min

23 sec

Firefox ESR 17.0.6

17 min

24 sec

Firefox ESR 17.0.6

Parsing time

Browser

hapter 1 About PBS Analytics™

PB

.1.3 Minimum hardware requirements for data collectors

f the data collector is installed on a separate server from the web application and parser, then at leae available on each server where the data collectors are installed. For sites with a very large PBS0 million job records), allow for free hard disk space which is larger than the current disk space beccounting log directory.

33,025 392,743 1,187,976 256 2.3 2.70 4.69

110,219 346,911 1,438,503 576 3.4 4.16 5.70

81,559 798,933 1,014,610 144 2.4 3.48 5.40

31,834 211,340 1,283,717 367 2.6 1.10 5.62

48,960 52,152 122,406 13 0.31 0.53 1.64c

Table 1-2: Parsing Benchmarking Data

No. of E Recs

No. of License

Recs

No. of DB Recs

No. of Nodes

DB Size (GB)

MonetdbRAM

consumed (GB)

Java PortalRAM

consumed(GB)

About PBS Analytics™ Chapter 1

1.2 Supported Platforms and Browsers

PBSA is supported on the following platforms:

Supported Operating Systems

Linux 64 bit

• SLES 10 SP4 and SLES 11 SP2

• RHEL 5.4+ and 6.x

• Cent OS 5.5+ and 6.x

Supported Browsers

Windows

• Firefox 10.x ESR+ (Only Enterprise Service Release is supported. Please refer to https://www.mozilla.org/en-US/firefox/organizations/.

• Chrome 15-24

• Internet Explorer 9

Linux

• Firefox 10.x ESR+ (Only Enterprise Service Release is supported. Please refer to https://www.mozilla.org/en-US/firefox/organizations/.

• Mac OS X

• Safari 5 (limited testing)

1.3 Chart rendering response time

The data parsed from the PBS Professional accounting logs and loaded into the PBSA data-base is analyzed by PBSA using ROLAP technology. This technology was implemented because it provides a speedy web application experience while using a minimum of memory and resources.

ROLAP analyzes and calculates aggregations once a unique measure and dimension combi-nation is requested (see Chapter 15, "PBSA Measures & Dimensions", on page 193). For instance, when a user creates a new chart using the PBSA web application, the PBSA web application caches the results for future similar queries.

The data associated with the charts that come with PBSA is analyzed and cached when the PBSA web application is started, and when new accounting log data is parsed. In addition, data associated with any charts created by the user that exists when the web application is started is also analyzed and cached. This caching improves the overall response time of the


https://www.mozilla.org/en-US/firefox/organizations/




Chapter 1 About PBS Analytics™

PBSA web application. However, when a user creates a chart using a dimension or measure combination that is has not yet been cached, a noticeable slow-down in response time may be experienced due to the time necessary for analysis, aggregation, and caching of data. Further queries against this same data should not experience any degradation in response time.

This strategy also ensures that the customer is paying computational cost for charts which are out-of-the-box, or created based on their priority only.


Chapter 2

Deployment OptionsThe PBSA application consists of three components:

• PBSA data collector

• PBSA parser

• PBSA web application

The main responsibility of the PBSA data collector is to make the PBS Professional account-ing logs accessible to the PBSA web application. The data collector has two functions. It first copies the accounting logs from your site’s PBS Professional accounting log location to an intermediate holding area. Secondly, it transports the information stored in the holding area to the machine where the PBSA web application and parser are installed.

The PBSA parser reads the PBS Professional accounting logs, parses the appropriate informa-tion from the accounting logs, and then loads this information into a database.

The PBSA web application is a graphical web-based accounting, analytics and reporting application.

Due to the I/O intensive workload of PBSA, it is recommended that the PBSA web applica-tion and parser be installed on a server that is either a dedicated web portal server (a server that may have other Altair products deployed such as Compute Manager or Display Man-ager), or a server dedicated solely to the PBSA application (see section 1.1, “System Require-ments”, on page 2).

Each PBSA data collector is dedicated to a PBS Professional complex, therefore a PBSA data collector must be installed for each PBS Professional complex.

Three deployment options are available for PBSA:

• The PBSA parser, web application and data collector are deployed on a single server (see


Chapter 2 Deployment Options

section 2.1, “Deployment Option One”, on page 8).

• The PBSA web application and parser are deployed on a separate server from the data collector (see section 2.2, “Deployment Option Two”, on page 9).

• Install PBSA with a demonstration database (see section 2.3, “Deployment Option Three”, on page 10).

2.1 Deployment Option One

The first deployment option is recommended for sites where there is only one PBS Profes-sional complex. This option deploys the PBSA web application. parser, and data collector on a single server. Requirements for this deployment option are:

• The PBSA data collector must have access to the PBS Professional accounting logs. For example, through a shared file system.

• This option cannot be used if there are multiple PBS Professional complexes.

• Installation of the PBSA web application, parser, and data collector must be installed through a single installation process.

.

If you want all three components installed, then you must do so through a single installation process. The data collector cannot be installed separately, after installation of the web application/parser.


Deployment Options Chapter 2

2.2 Deployment Option Two

The second deployment option is recommended for sites where there are one to many PBS Professional complexes. This option deploys the PBSA web application and parser on a sep-arate server from the data collector. Requirements for this deployment option are:

• The PBSA data collector is deployed on each server where the PBS Professional account-ing logs are located (typically the PBS Professional head node).

• Communication between the PBSA web application and data collector is done over http, and is configured during installation of the PBSA components.

• Installation of the PBSA web application and parser must be done separately from the data collectors, and a data collector must be installed for each PBS Professional complex.


Chapter 2 Deployment Options

2.3 Deployment Option Three

The third deployment option is recommended for sites where a quick installation of PBSA for evaluation purposes is the priority. This option does not install the PBSA parser component, therefore access to PBS Professional accounting logs is not necessary. Instead, a fully loaded demonstration database is installed so that all out-of-the box charts, dashboards, and slide-shows can be viewed, and all key features of PBSA can be accessed and evaluated.

This option is similar to option one where the PBSA web application, parser and data collec-tor are deployed on a single server. However, during installation you will direct PBSA to use the demonstration database, rather than providing the location to the PBS Professional accounting logs.

If you choose to install the demonstration database, then the PBSA parser will not be installed.


Chapter 3

Pre-installation PreparationInstallation of PBSA requires the following steps to be completed:

• Installation of the PBSA web application, parser and data collectors.

• Configuration of PBSA to supply site specific information enabling PBSA to provide uti-lization metrics suitable for your site.

• Parsing of the PBS Professional accounting logs.

3.1 Installation

Installation of PBSA is similar to the installation of other PBS Works™ products. A binary or executable needs to be downloaded from the PBS Works™ user area and installed on the appropriate Linux servers.

3.1.1 Accounting logs or demonstration database

During installation you will have a choice between installing a fully loaded demonstration database, or using your site’s accounting logs to load the PBSA database.

The demonstration database is useful when a quick installation for evaluation of the default charts and dashboards available with the PBSA web application is the priority.

When you choose the demonstration database option, the PBSA parser component is not installed, and post-installation configura-tion and parsing are not necessary.


Chapter 3 Pre-installation Preparation

If you choose to use your site’s accounting logs, then post-installation configuration and pars-ing of the accounting logs must be completed before the PBSA web application service can be started and available for use.

3.1.2 Authentication

PBSA uses SSH to verify credentials of users who login.

3.1.3 Default installation directory

The default installation directory is:

/opt/pbsworks/12.2

3.1.4 Licensing

During installation of PBSA, there are three licensing options (HWU is Hyper Works Unit):

• Base - up to 500,000 licensing records at 10 HWU + 1 HWU per user

• Standard - up to 5 million licensing records at 30 HWU + 1 HWU per user

• Advanced - up to 50 million licensing records at 60 HWU + 1 HWU per user

Licensing is dependent on the number of “licensing records”. A “licensing record” is not equivalent to a PBS Professional job accounting log "E" record. There is a “licensing record” for every “job node”. For example:

• A single job that runs on 100 nodes equates to 100 records for licensing.

• Ten jobs that ran on 1 node equates to 10 records for licensing.

• Ten jobs that each use 4 nodes equates to 40 licensing records.

• A single job that runs on 20 nodes for 1 hour equates to 20 licensing records.

• A single job that runs on 4 virtual nodes equates to 4 licensing records.

If a site adds additional data to the PBS Analytics database (not related to jobs), that data is also counted as far as licensing is concerned. For example, if a site adds "node temperature" once per day on 256 nodes, that would add 256 * 365 = 93,440 license records per year.

PBSA will display the most recent accounting log data up to the amount of data that it is licensed for, effectively filtering out any data that exceeds the licensing limit (older data).


Pre-installation Preparation Chapter 3

PBSA will parse all accounting log data, regardless of the chosen licensing schema. If the amount of licensing records exceeds the licensing schema, then the PBSA web application will display the most recent accounting log data up to the amount of data that it is licensed for, effectively filtering out any data that exceeds the licensing limit (older data). For instance, if a licensing option of “base” is selected during installation, then PBSA will display the most recent PBS Professional accounting log data up to 500,000 licensing records.

Over time the licensing schema may need to be changed to accommodate an increase in the number of accounting log job records. Upgrading the licensing schema is a manual process. See section 18.9, “Changing the license schema”, on page 289 for instructions. Upon upgrad-ing the license schema, all data will become visible, unless the accounting log activity exceeds the newest licensing schema.

3.1.5 Web application port

Typically, the PBSA web application is configured to use port 9000. If this port is not avail-able during installation, then PBSA will increment the port number by one and try again. This will continue until a free port is found, or until 100 consecutive ports are refused at which point the installer will ask for a port.

Once installation is complete, this port must be opened by a site’s system administrator for incoming TCP traffic to allow communication between the web application and the data col-lectors.

3.1.6 Database port and super user

A PBSA database is installed and configured to use port 9200. If this port is not available during installation, then the installer will increment the port number by one and try again. This will continue until a free port is found, or until 100 consecutive ports are refused at which point the installer will ask for a port.

PBSA will parse all accounting log data, regardless of the chosen licensing schema.

Please note the port assigned to the web application during installa-tion. The port information is displayed during the “Pre-Installation Summary” and “Installation Complete” steps of the installation pro-cess.



The installer will create a default user as the database super user - “pbsworks” having a pass-word of “pbsworks@123”.

3.2 Configuration

Configuration provides site specific information that is necessary for tracking utilization at multiple levels. At an absolute minimum, providing node detail information for a PBS Pro-fessional complex is necessary prior to starting the PBSA web application service. In addi-tion, further information can be configured that allows PBSA to provide more detailed utilization tracking. For instance:

• holidays - non-working days

• prime and non-prime time hours - working and non-working hours

• exit codes - job failures

• custom groups - projects

• custom resources - PBS Professional custom resources

More information about configuring PBSA is available in Chapter 7, "Post-installation", on page 99.

3.3 Parsing the accounting logs

3.3.1 Initial PBSA parsing

The parsing of the accounting logs is necessary to make PBS Professional job data available to the PBSA web application. The parser reads the PBS Professional accounting logs, parses the appropriate information from the accounting logs, and then loads this information into a database used by the web application.

The initial parsing process may take anywhere from several hours to several days depending upon the amount of data stored in the PBS Professional accounting log(s), number of proces-sors, and amount of available RAM.

For a site that is installing PBSA for the first time, configuration of PBSA followed by pars-ing, may be an iterative process requiring several parsing cycles before PBSA is configured appropriately by the system administrator. If after running a parsing cycle, you find that addi-tional configuration is required, you may discard the data from the previous parsing cycle (see Chapter 19, "Reparsing the accounting logs", on page 305), modify your configuration, and run the parsing cycle again.



Configuration of PBSA and parsing of the PBS Professional accounting logs may take some time and thought, so please plan to take time prior to installing PBSA to determine the level of tracking that is required at your site.

3.3.2 Daily PBSA parsing cycle

Once PBSA is configured properly and the PBS Professional accounting logs have been ini-tially parsed, the parsing cycle runs on a daily basis parsing the newly generated accounting logs.

3.4 PBS Professional considerations

PBSA provides metrics for node classes, for applications, and for projects. There are various charts, provided default with the PBSA web application, that report on these attributes. How-ever, to get the full benefit of this reporting, there are several steps that must be done within PBS Professional to make this possible.

3.4.1 Nodeclass metrics - classify PBS Professional nodes

PBSA can provide utilization metrics for groups or classifications of PBS Professional nodes, but to obtain these metrics a PBS Professional node must be assigned or classified to a nodeclass. This is accomplished by creating a PBS Professional custom resource called “nodeclass” on each PBS Professional node.

You can classify your PBS Professional nodes in any way that you choose for your site’s installation. For example, your site may have purchased HP hardware in 2008, and then pur-chased IBM hardware in 2012, so you may want to classify your nodes by hardware configu-ration. A nodeclass called “HP” could be defined for each node within the HP hardware configuration. A second nodeclass could be defined called “IBM” for each node in the second hardware configuration. PBSA can then provide utilization metrics based on these hardware configurations.

To discard all parsed data and reparse the PBS Professional accounting logs, see Chapter 19, "Reparsing the accounting logs", on page 305.



Another example is to classify nodes by discipline. Some sites may assign certain disciplines to specific nodes, such as CFD is assigned to node A, while CAD is assigned to node B. PBSA can provide utilization metrics for disciplines by defining a nodeclass of “CFD” on node A, and defining a nodeclass of “CAD” on node B.

For more information on how to define a PBS Professional custom resource see the PBS Pro-fessional Administrator’s Guide - PBS Resources - Custom Resources.

3.4.2 Application metrics - use PBS resource “software”

PBSA can provide metrics at the application level, if the PBS Professional built-in resource “software” is utilized. For a description of the built-in resource “software” see the PBS Pro-fessional Reference Guide - Resources - Built-in Resources. Using the built-in resource “soft-ware” allows PBSA to track how often a particular solver is utilized, for instance PBSJobApp.

The “software” built-in resource is requested as part of the qsub command. To request a value for software, add this to the qsub command:

-l software=<requested software>

or add this to the job script:

#PBS -l software=<requested software>

For more information see the PBS Professional User’s Guide - Submitting a PBS Job - Requesting Resources.

If you are using Compute Manager to submit jobs, then the “software” built-in resource is automatically set, therefore no special steps are necessary.

Prior to parsing the PBS accounting logs, create a custom resource on each PBS Professional node called “nodeclass” so that PBSA can provide utilization statistics for groups or classifications of PBS Professional nodes.

Use the PBS Professional “software” built-in-resource to track solver utilization.



3.4.3 Project metrics - use the qsub -P option

PBSA can provide metrics at a project level, if the -P option is utilized when submitting a job (introduced in the 11.2 release of PBS Professional). It is highly recommended that all job submissions use this option for optimal utilization reporting. For more information see the PBS Professional User’s Guide - Submitting a PBS Job - Specifying a Job’s Project. Using the -P option allows PBSA to track utilization at a project level.

To submit a job and set the project add this to the qsub command:

qsub .... -P <project name>

or add this to the job script:

#PBS ..... -P <project name>

If your site is using an earlier version of PBS Professional (prior to 11.2), or is submitting jobs via an application definition, PBSA provides an alternative to track utilization at the project level. Please refer to section 13.3, “Configuring custom groups”, on page 154 for more infor-mation. Keep in mind that this alternative has been made available for legacy purposes only, and may be deprecated in future releases of PBSA. The use of the qsub -P option is highly recommended as the preferred method of tracking utilization at a project level.

Use the qsub -P option so that PBSA can provide metrics at a proj-ect level.


Chapter 4

Installing PBSA GUI modeInstalling PBSA is quick and easy. The GUI based installer walks you through the process, requesting installation and configuration information along the way. Once installation is com-plete, there are post-installation tasks that need to be completed before PBSA is ready for use (see Chapter 7, "Post-installation", on page 99).

4.1 Installing on a single server

This option is recommended for:

• Deployment Option 1 - A site that has only one PBS Professional complex.

• Deployment Option 3 - A site that has chosen to configure PBSA to use the demonstra-tion database.

This option CANNOT be used if there are multiple PBS Professional complexes.

If you are installing the demonstration database, the PBSA parser will not be installed.



Chapter 4 Installing PBSA GUI mode

Prerequisites for installation of this product are:

• system administrator privileges (root privileges)

• The PBSA service user - must be an existing user on the server where PBSA is being installed and will be used to register the PBSA service. The PBSA web application and database services will be started under this user.

• removal of any old instances of PBSA

• a SSH server installed and running

• adherence to the minimum system requirements (see section 1.1, “System Require-ments”, on page 2).

4.1.1 Download the installer

To install PBSA, download the installer appropriate for your platform from the user area.

4.1.2 Starting the installer

Start the installer by executing the following command:

./PBSA_12.2_Linux_x86_64.bin -i swing

It is recommended that the PBSA web application and parser be installed on a server that is either a dedicated web portal server (a server that may have other Altair products deployed such as Com-pute Manager or Display Manager), or a server dedicated solely to the PBSA application.


Installing PBSA GUI mode Chapter 4

4.1.3 Splash screen

After extracting the files, the installation will proceed by displaying the splash screen.



4.1.4 Introduction

An Introduction dialog box will be displayed. Please read through the instructions before pro-ceeding with the installation. To ensure a successful installation, please note the prerequisites for the installation. At anytime during the installation process, you may click Previous to go back to a previous installation step. To cancel the installation process, click Cancel. To con-tinue the installation process, click Next.



4.1.5 License Agreement

License agreement information will be displayed. Please read through the License Agreement before proceeding with the installation. To accept the terms of the license agreement, select I accept the terms of the License Agreement, and click Next.



4.1.6 Install options

If you are installing the demonstration database, select the following component:

• Analytics Application and Parser

Otherwise, if you are installing the web application, parser and data collector on a single server (see section 2.1, “Deployment Option One”, on page 8), select both components:


• Data collector

Click Next.

If the demonstration database is chosen only the web application will be installed. PBSA will automatically forgo the installation of the parser since accounting logs are not accessible with this option.

The data collector cannot be installed after installing the web appli-cation/parser. If you want all three components installed, it must be done through a single installation process.



4.1.7 Dataset

Select whether to configure PBSA to use a demonstration database that is already loaded with test data, or to configure PBSA to use your site’s accounting logs by selecting the appropriate choice.

The demonstration database is handy for quick installations where a demonstration of default charts is the priority.

If you choose to use your accounting logs, then you will be asked to specify a path to your PBS Professional accounting logs.

Make your selection and then click Next.

If you choose to install PBSA with the demonstration database, the PBSA parser component will not be installed.



4.1.8 Accounting logs location

If you have chosen to configure PBSA to use your site’s PBS Professional accounting logs, then you will be prompted to specify the location of the accounting logs. The accounting logs can be available locally or via a mounted path on a shared file system. To restore the default location, click Restore Default. Once you have entered the location of the accounting logs, click Next.



4.1.9 Authentication server

PBSA uses SSH to verify credentials of users who login. You can either specify the SSH server running on the local machine, or specify a different host running SSH. Click Next to proceed with the default authentication server, or specify the SSH server hostname, and click Next.



4.1.10 PBSA service user

Enter a user id that will be used to run the PBSA services. This user must be a pre-existing and preferably non-privileged user on the server where PBSA is being installed. Click Next.

See section 16.1.2, “Troubleshooting the PBSA service user”, on page 211 for any problems experienced while entering the PBSA service user.

The PBSA web application and database will run under the service user.



4.1.11 Installation location

Specify a location where the selected PBSA components will be installed. These components can be installed to the default location, another location locally, or a mounted location on a shared file system. To select a custom directory click Choose. To restore the default direc-tory, click Restore Default Folder. The default installation directory is:

/opt/pbsworks/12.2

Once an installation location is specified, click Next.



4.1.12 License server

Choose the type of licensing schema you want to use (see section 3.1.4, “Licensing”, on page 12 for more information). The default is base (HWU is Hyper Works Unit).




Click Next after making your choice.

See section 16.1.3, “Troubleshooting the PBSA license server”, on page 212 for any problems experienced while specifying the license server.

It is not required to provide the license server at installation time. You will however be required to configure the license server infor-mation prior to starting the PBSA web application (see section 18.3.1, “Initial license server configuration”, on page 277).



4.1.13 Pre-installation summary

As a last step before installation a pre-installation summary will be displayed. If the listed specifications are incorrect, use the Previous button to go back and make any necessary changes. If all specifications are correct then proceed with the PBSA installation using the Install button.

IMPORTANT - Please note the port number where the PBSA web application was installed. This information will be needed for opening the web application port for incoming TCP traffic.



4.1.14 Installation progress

You can monitor the progress of your installation via the installation progress bar..



4.1.15 Start PBSA services

If you chose to install the demonstration database, then during the installation process a mes-sage will be displayed asking if the PBSA services should be started.

If a license server was not configured for PBSA during installation, do no start the PBSA ser-vice. You will need to configure the license server prior to starting the PBSA service.

Otherwise, select “Yes” and click Next to start the PBSA service.

If the PBSA service is not started, then it must be manually started once the installation pro-cess is complete - see section 12.1.1, “Starting the PBSA web application service”, on page 131.

See section 16.1.4, “Troubleshooting the web application”, on page 212 for any problems experienced during PBSA web application start-up.



4.1.16 Confirm PBSA services should not be started

If you choose to defer the startup of the PBSA web application service, you will be asked to confirm your choice. Click OK to confirm this action. .



4.1.17 Installation complete

Once the installation of PBSA is complete the installation details will be displayed. Click Done to exit the installation.

4.1.18 Post-installation

4.1.18.1 PBSA is configured to use the demonstration database

If you have configured PBSA to use the demonstration database, and did not provide a license server during installation, then you must now configure PBSA with a valid license server before proceeding (see section 18.3.1, “Initial license server configuration”, on page 277).

Once a valid license server is known to PBSA, the web application is available for use. Use any of the supported browsers (see section 1.2, “Supported Platforms and Browsers”, on page 5) to login to PBSA through the URL http://<hostname>:<port>/pbsworks.



4.1.18.2 PBSA is configured to use the PBS accounting logs

If you have configured PBSA to use the PBS Professional accounting logs, please complete the post-installation activities (see Chapter 7, "Post-installation", on page 99) before using the PBSA web application.

4.2 Installing on separate servers

This deployment option is required for sites which want to analyze more than one PBS Pro-fessional complex:

• The PBSA web application and parser are installed on a separate machine from the data collectors.

• A PBSA data collector must be installed either on the head node of each PBS Profes-sional complex, or on a machine that has access to the PBS Professional accounting logs for that complex.








To install PBSA download the installer appropriate for your platform from the user area.



4.2.2 Installing the PBSA web application and parser

4.2.2.1 Starting the installer






4.2.2.2 Splash screen




4.2.2.3 Introduction

An Introduction dialog box will be displayed. Please read through the instructions before pro-ceeding with the installation. To ensure a successful installation, please note the prerequisites for the installation. At anytime during the installation process, you may click Previous to go back to a previous installation step. To cancel the installation process, click Cancel. To con-tinue the installation process, click Next.



4.2.2.4 License Agreement




4.2.2.5 Install options

Verify that only the PBSA web application and parser component is selected. Click Next.

Only the PBSA web application and parser will be installed.



4.2.2.6 Confirm PBSA web application install

A message will be displayed stating that you are installing only the PBSA web application and parser. Click OK.



4.2.2.7 Dataset

Configure PBSA to use your site’s accounting logs. Do not select the demonstration database option. Click Next.



4.2.2.8 Authentication server

PBSA uses SSH to verify credentials of users who login. You can either specify the SSH server running on the local machine, or specify a different host running SSH. Click Next to proceed with the default authentication server, or specify the SSH server hostname, and click Next.



4.2.2.9 PBSA service user

Enter a user id that will be used to run the PBSA services. This user must be a pre-existing and preferably non-privileged user on the server where PBSA is being installed. Click Next.

See section 16.1.2, “Troubleshooting the PBSA service user”, on page 211 for any problems experienced while specifying the PBSA service user.




4.2.2.10 Installation location

Specify a location where the selected PBSA components will be installed. These components can be installed to the default location, another location locally, or a mounted location on a shared file system. To select a custom directory click Choose. To restore the default direc-tory, click Restore Default Folder. The default installation directory is:

/opt/pbsworks/12.2

Once an installation location is specified, click Next.



4.2.2.11 License server

Choose the type of licensing schema you want to use (see section 3.1.4, “Licensing”, on page 12 for more information). The default is base (HWU is Hyper Works Units).




Click Next.

See section 16.1.3, “Troubleshooting the PBSA license server”, on page 212 for any problems experienced while specifying the license server.




4.2.2.12 Pre-installation summary


IMPORTANT - Please note the port number where the PBSA web application was installed. This information will be needed during the installation of the PBSA data collectors, and for opening the web application port for incoming TCP traffic.



4.2.2.13 Installation progress




4.2.2.14 Installation complete

Once the installation of the PBSA web application and parser is complete, the installation details will be displayed.

Now the installation of the PBSA data collectors on each of the PBS Professional complexes must be completed (see section 4.2.3, “Installing the PBSA data collector”, on page 51).

Click Done.



4.2.3 Installing the PBSA data collector

These installation steps must be repeated for each PBS Professional complex. A PBSA data collector must be installed either on the head node of each PBS Professional complex, or on a machine that has access to the PBS Professional accounting logs for that complex.




4.2.3.2 Splash screen





An Introduction dialog box will be displayed. Please read through the instructions before pro-ceeding with the installation. To ensure a successful installation, please note the prerequisites for the installation. At anytime during the installation process, you may click Previous to go back to a previous installation step. To cancel the installation process, click Cancel. To con-tinue the installation process, click Next .



4.2.3.4 License Agreement





Verify that only the Data Collector component is selected. Click Next.

Only the PBSA data collector will be installed.



4.2.3.6 Confirm PBSA data collector install

A message will be displayed stating that you are installing only the PBSA data collector. Click OK.



4.2.3.7 PBSA web application server

Specify the hostname and port number of the PBSA web application server. Click Next.



4.2.3.8 Accounting logs location

Specify the location of the PBS Professional accounting logs. The accounting logs can be available locally or via a mounted path on a shared file system. To restore the default loca-tion, click Restore Default. Once you have entered the location of the accounting logs, click Next.

.




You may install PBSA in the default directory, or you may select a custom directory by click-ing Choose. To restore the default directory, click Restore Default Folder. The default installation directory is:

/opt/pbsworks/12.2

Once an installation location is entered, click Next.




Once the installation of the PBSA data collector is complete the installation details will be displayed. Click Done to exit the installation.

Repeat this installation process for each PBS Professional complex.

After data collectors are installed on every PBS Professional complex, perform the post instal-lation activities (see Chapter 7, "Post-installation", on page 99) to configure PBSA and make it ready for use.


Chapter 5

Installing PBSA console modeInstalling PBSA is quick and easy. The console based installer walks you through the process, requesting installation and configuration information along the way. Once installation is com-plete, there are post-installation tasks that need to be completed before PBSA is ready for use (see Chapter 7, "Post-installation", on page 99).

5.1 Installing on a single server

This option is recommended for:

• Deployment Option 1 - A site that has only one PBS Professional complex.

• Deployment Option 3 - A site that has chosen to configure PBSA to use the demonstra-tion database.

This option CANNOT be used if there are multiple PBS Professional complexes.

If you are installing the demonstration database, the PBSA parser will not be installed.



Chapter 5 Installing PBSA console mode








To install PBSA, download the installer appropriate for your platform from the user area.

5.1.2 Starting the installer


./PBSA_12.2_Linux_x86_64.bin -i console



Installing PBSA console mode Chapter 5

5.1.3 Introduction

The console installer will launch. To ensure a successful installation, please note the prerequi-sites for the installation..

Press <ENTER> when you are ready to initiate the installation. You may cancel the installa-tion process at anytime by entering "quit" and pressing <ENTER>. At anytime during the installation process, you may enter "back" and press <ENTER> to go back to a previous installation step.



5.1.4 License agreement

Please page through the License Agreement by pressing <ENTER> until you are prompted to accept the License Agreement. To accept the License Agreement terms and conditions and continue with the installation process, enter "Y" and press <ENTER>



5.1.5 Install options

If you are installing the demonstration database, select the following component:


by entering “1” and pressing <ENTER>.

Otherwise, if you are installing the web application, parser and data collector on a single server (see section 2.1, “Deployment Option One”, on page 8), select both components by pressing <ENTER>:

If the demonstration database is chosen only the web application will be installed. PBSA will automatically forgo the installation of the parser since accounting logs are not accessible with this option.

The data collector cannot be installed after installing the web appli-cation/parser. If you want all three components installed, it must be done through a single installation process.



5.1.6 Dataset

Select whether to configure PBSA to use a demonstration database that is already loaded with test data, or to configure PBSA to use your site’s accounting logs by selecting the appropriate choice.

The demonstration database is handy for quick installations where a demonstration of default charts is the priority.

If you choose to use your accounting logs, then you will be asked to specify a path to your PBS Professional accounting logs.

Make your selection and then press <ENTER>.

If you choose to install PBSA with the demonstration database, the PBSA parser component will not be installed.



5.1.7 Accounting logs location

If you have chosen to configure PBSA to use your site’s PBS Professional accounting logs, then you will be prompted to specify the location of the accounting logs. The accounting logs can be available locally or via a mounted path on a shared file system.

5.1.8 Authentication server

PBSA uses SSH to verify credentials of users who login. You can either specify the SSH server running on the local machine, or specify a different host running SSH. Press <ENTER> to proceed with the default authentication server, or specify the SSH server host-name, and press <ENTER>.



5.1.9 PBSA service user

Enter a user id that will be used to run the PBSA services. This user must be a pre-existing and preferably non-privileged user on the server where PBSA is being installed. Press <ENTER>.





5.1.10 Installation location

Specify a location where the selected PBSA components will be installed. These components can be installed to the default location, another location locally, or a mounted location on a shared file system. You may install PBSA in the default directory by pressing <ENTER>, or you may select a custom directory by entering a directory and pressing <ENTER>. The default installation directory is:

/opt/pbsworks/12.2

5.1.11 Licensing schema





Enter the appropriate option and press <ENTER>.



5.1.12 License server

Enter the license server and press <ENTER>.

.

See section 16.1.3, “Troubleshooting the PBSA license server”, on page 212 for any problems experienced while entering the license server.




5.1.13 Pre-installation summary

As a last step before installation a pre-installation summary will be displayed. If the listed specifications are incorrect, enter "back" and press <ENTER> to go back and make any nec-essary changes. If all specifications are correct, proceed with the PBSA installation by press-ing <ENTER>.

IMPORTANT - Please note the port number where the PBSA web application was installed. This information will be needed for opening the web application port for incoming TCP traffic.



5.1.14 Installation progress

You can monitor the progression of the installation by viewing the console progress bar. .

5.1.15 Start PBSA services

If you chose to install the demonstration database, then during the installation process a mes-sage will be displayed asking if the PBSA services should be started.

If a license server was not configured for PBSA during installation, do no start the PBSA ser-vice. You will need to configure the license server prior to starting the PBSA service. Enter "2” and press <Enter>.

Otherwise, enter "1" and press <Enter> to start the PBSA service.

If the PBSA service is not started, then you must manually start it once the installation process is complete - see section 12.1.1, “Starting the PBSA web application service”, on page 131.

See section 16.1.4, “Troubleshooting the web application”, on page 212 for any problems experienced during PBSA web application service start-up.



5.1.16 Confirm PBSA services should not be started

If you choose to defer the startup of the PBSA web application service, you will be asked to confirm your choice. Enter "1" and press <ENTER> to confirm this action.

5.1.17 Installation complete

Once the installation of PBSA is complete the installation details will be displayed. Press <ENTER> to exit the installation.



5.1.18 Post-installation

5.1.18.1 PBSA is configured to use the demonstration database

If you have configured PBSA to use the demonstration database, and did not provide a license server during installation, then you must now configure PBSA with a valid license server before proceeding (see section 18.3.1, “Initial license server configuration”, on page 277).

Once a valid license server is known to PBSA, the web application is available for use. Use any of the supported browsers (see section 1.2, “Supported Platforms and Browsers”, on page 5) to login to PBSA through the URL http://<hostname>:<port>/pbsworks.

5.1.18.2 PBSA is configured to use the PBS accounting logs

If you have configured PBSA to use the PBS Professional accounting logs, please complete the post-installation activities (see Chapter 7, "Post-installation", on page 99) before using the PBSA web application.

5.2 Installing on separate servers

This deployment option is required for sites which want to analyze more than one PBS Pro-fessional complex:

• The PBSA web application and parser are installed on a separate machine from the data collectors.

• A PBSA data collector must be installed either on the head node of each PBS Profes-sional complex, or on a machine that has access to the PBS Professional accounting logs for that complex.






adherence to the minimum system requirements (see section 1.1, “System Requirements”, on page 2).




To install PBSA download the installer appropriate for your platform from the user area.

5.2.2 Installing the PBSA web application and parser







5.2.2.3 License agreement



Select the PBSA web application and parser component by entering “1” and pressing <ENTER>.

Only the PBSA web application and parser will be installed.



5.2.2.5 Confirm PBSA web application install

A message will be displayed stating that you are installing only the PBSA web application and parser. Enter “1” and press <ENTER> to confirm this action.

5.2.2.6 Dataset

Configure PBSA to use your site’s accounting logs. Do not select the demonstration database option. Enter “2”. and press <ENTER>.



5.2.2.7 Authentication server

PBSA uses SSH to verify credentials of users who login. You can either specify the SSH server running on the local machine, or specify a different host running SSH. Press <ENTER> to proceed with the default authentication server, or specify the SSH server host-name, and press <ENTER>.

5.2.2.8 PBSA service user

Enter a user id that will be used to run the PBSA services. This user must be a pre-existing and preferably non-privileged user on the server where PBSA is being installed. Press <ENTER>.






Specify a location where the selected PBSA components will be installed. These components can be installed to the default location, another location locally, or a mounted location on a shared file system. You may install PBSA in the default directory by pressing <ENTER>, or you may select a custom directory by entering a directory and pressing <ENTER>. The default installation directory is:

/opt/pbsworks/12.2

5.2.2.10 Licensing schema





Enter the appropriate option and press <ENTER>.



5.2.2.11 License server

Enter the license server and press <ENTER>.

See section 16.1.3, “Troubleshooting the PBSA license server”, on page 212 for any problems experienced while entering the license server.





As a last step before installation a pre-installation summary will be displayed. If the listed specifications are incorrect, enter "back" and press <ENTER> to go back and make any nec-essary changes. If all specifications are correct, proceed with the PBSA installation by press-ing <ENTER>.

IMPORTANT - Please note the port number where the PBSA web application was installed. This information will be needed during the installation of the PBSA data collectors, and for opening the web application port for incoming TCP traffic




You can monitor the progression of the installation using the console progess bar. .


Once the installation of the PBSA web application and parser is complete, the installation details will be displayed.

Now the installation of the PBSA data collectors on each of the PBS Professional complexes must be completed (see section 5.2.3, “Installing the PBSA data collector”, on page 86).

Press <ENTER> to exit the installation.



5.2.3 Installing the PBSA data collector

These installation steps must be repeated for each PBS Professional complex. A PBSA data collector must be installed either on the head node of each PBS Professional complex, or on a machine that has access to the PBS Professional accounting logs for that complex.









5.2.3.3 License agreement



Select the PBSA data collector component by entering “2” and pressing <ENTER>.

Only the PBSA data collector will be installed.



5.2.3.5 Confirm PBSA data collector install

A message will be displayed stating that you are installing only the PBSA data collector. Enter "1" and press <ENTER> to confirm this action.

5.2.3.6 PBSA web application hostname

Specify the hostname of the PBSA web application server. Press <ENTER>.



5.2.3.7 PBSA web application port

Specify the port number of the PBSA web application server. Press <ENTER>.

5.2.3.8 Accounting logs location

Specify the location of the PBS Professional accounting logs. The accounting logs can be available locally or via a mounted path on a shared file system. You may choose the default location of the accounting logs, or you may select another directory by specifying another directory path and pressing <ENTER>.




You may install PBSA in the default directory by pressing <ENTER>, or you may select a custom directory by entering a directory and pressing <ENTER>. The default installation directory is:

/opt/pbsworks/12.2




As a last step before installation a pre-installation summary will be displayed. If the listed specifications are incorrect, enter "back" and press <ENTER> to go back and make any nec-essary changes. If all specifications are correct, proceed with the PBSA installation by press-ing <ENTER>. .


You can monitor the progression of the installation using the console progress bar. .




Once the installation of the PBSA data collector is complete the installation details will be displayed. Press <ENTER> to exit the installation.

Repeat this installation process for each PBS Professional complex.

After data collectors are installed on every PBS Professional complex, perform the post instal-lation activities (see Chapter 7, "Post-installation", on page 99) to configure PBSA and make it ready for use.


Chapter 6

Uninstalling PBSAThe uninstallation process must be repeated on each machine where a PBSA component was installed.

If all three components (web application, parser, and data collector) have been installed on a single machine, all three components will be uninstalled. You cannot uninstall components separately.

6.1 Uninstalling using the GUI mode

6.1.1 Starting the uninstaller

Navigate to the PBSA installation directory. The installation directory for a typical installa-tion of PBSA is:

/opt/pbsworks/12.2

Enter the following at the Linux command line prompt (command must contain spaces with escape characters):

cd _PBS\ Analytics_installation

Prior to uninstalling, stop the PBSA web application and data col-lectors.


Chapter 6 Uninstalling PBSA

Execute the uninstall script by entering the following command at the Linux command line prompt (command must contain spaces with escape characters)

./Change\ PBS\ Analytics\ Installation -i swing

6.1.2 Splash screen

After extracting the files, the uninstaller will proceed by displaying the splash screen..


Uninstalling PBSA Chapter 6

6.1.3 Starting the uninstallation process

Click Next to uninstall PBSA.



6.1.4 Uninstall PBSA

Please read the instructions before proceeding with the uninstall. Click Uninstall to initiate the uninstall process. To cancel the uninstall process, click Cancel.

6.1.5 Uninstallation progress

You can monitor the progess of the uninstall process via the uninstall progress bar.


Uninstalling PBSA Chapter 6

6.1.6 Completing the uninstallation process

Items that could not be removed are listed. Please delete them manually. To complete the uninstallation, click Done.

6.2 Uninstalling using the console mode

6.2.1 Starting the uninstaller

Navigate to the PBSA installation directory. The installation directory for a typical installa-tion of PBSA is:

/opt/pbsworks/12.2

Enter the following at the Linux command line prompt (command must contain spaces with escape characters):

cd _PBS\ Analytics_installation

Execute the uninstall script by entering the following command at the Linux command line prompt (command must contain spaces with escape characters)

./Change\ PBS\ Analytics\ Installation -i console



6.2.2 Starting the uninstallation process

The console uninstaller will launch. Press <ENTER> to continue with the uninstall.

6.2.3 Completing the uninstallation process

Items that could not be removed are listed. Please delete them manually.


Chapter 7

Post-installationThe installation directory (denoted in this document as <INSTALL_DIR>) for a typical instal-lation of PBSA is:

/opt/pbsworks/12.2

Post-installation activities:

1. Set up the system path

2. Open the web application port

3. Reset the database user password

4. Provide a license server if one was not supplied during installation

5. Configure PBSA

6. Start PBSA

7. Parse the accounting logs

8. Login to the PBSA web application


Chapter 7 Post-installation

7.1 Setting up the system path

A number of commands are provided for configuring PBSA. Update the system path with the absolute path of these commands.

7.1.1 Single machine deployment

If the web application, parser, and data collector have been deployed on a single machine, then execute the following command:

export PATH=$PATH:<INSTALL_DIR>/portal/scripts/pbsa-commands/bin:<INSTALL_DIR>/dc/scripts/pbsa-commands/bin

7.1.2 Multiple machine deployment

If the web application and parser have been deployed on a separate machine than the data col-lectors, then execute the following command on the machine where the web application and parser have been deployed:

export PATH=$PATH:<INSTALL_DIR>/portal/scripts/pbsa-commands/bin

Execute the following command on all machines where the data collector has been deployed:

export PATH=$PATH:<INSTALL_DIR>/dc/scripts/pbsa-commands/bin

7.2 Opening the web application port

Ensure the port assigned to PBSA is open for incoming TCP traffic. The port information is displayed in the “Pre-Installation Summary” screen and “Installation Complete” screen during installation. This port must be opened for incoming TCP traffic to allow communica-


Post-installation Chapter 7

tion between the web application and the data collectors. If the port is not opened, then the following error will be seen in the data collector log file when the data collector attempts to transport the accounting log information to the web application:

7.3 Resetting the database user password

Changing the PBSA database password from the default of “pbsworks@123” to a secure site-specific password is recommended. The database password can be changed using the pbsa-data-password command - see section 13.9, “Change the PBSA database password”, on page 186.

7.4 Providing a license server

If you did not supply a license server during installation, then you must now specify a license server before proceeding. See section 18.3.1, “Initial license server configuration”, on page 277 for instructions on how to configure the license server.

ERROR, 11 Sep 13 01:48:25,332 -{DataTransportManager.java: 91} - Not able to send file 20110503

com.altair.pbsworks.dc.framework.DCException: File Transport proxy encountered a problem while processign request.

at com.altair.pbsworks.dc.transport.http.HTTPFileTransport.sendData(HTTPFileT-ransport.java:113)

at com.altair.pbsworks.dc.transport.DataTransportManager.transportFile(DataTrans-portManager.java:83)

at com.altair.pbsworks.dc.transport.DataTransportManager.doWork(DataTransportMan-ager.java:73)

at com.altair.pbsworks.dc.framework.AbstractWorker.run(AbstractWorker.java:79)

at java.lang.Thread.run(Thread.java:662)

Caused by: java.io.IOException: Server returned HTTP response code: 500 for URL: http://192.168.33.244:9000/parser/upload

at sun.net.www.protocol.http.HttpURLConnection.getInputStream(HttpURLConnec-tion.java:1436)


... 4 more



7.5 Configuring PBSA

7.5.1 Configuring site specific node information

Providing site specific PBS Professional node information is necessary prior to starting PBSA. If you prefer to perform an “express” configuration using the defaults, then the only configuration necessary will be your site’s PBS Professional complex node information, see Chapter 8, "Configuring node details", on page 105.

7.5.2 Configuring optional site specific information

Further site specific information can also be provided for the following categories:






Providing site specific information for these categories will increase the usefulness of the PBSA default charts. See Chapter 9, "Optional configuration", on page 111 for further infor-mation on how to proceed with this configuration. However, you may forgo this configura-tion and accept the defaults for holidays, prime/non-prime time hours, exit codes, and custom groups. Default values are summarized in Table 7-1, “Configuration defaults”.

Table 7-1: Configuration defaults

Configuration Year(s) Default

Holiday 2011-2013 New Year’s Day

Prime

Non-prime time

2011-2013 Monday - Friday

Saturday

Sunday

Prime time begins at 09:00 am

Non-prime time begins at 5:30 pm

Day is scheduled as non-prime time

Day is scheduled as non-prime time


Post-installation Chapter 7

7.6 Starting PBSA

Once the installation and initial configuration of PBSA is complete, it is time to start PBSA. The web application service should be started first. Once the web application service has been started, the data collector can be started. Refer to section , “Starting PBSA”, on page 119 for more information on how to start PBSA.

7.7 Parsing the accounting logs

Once the web application and parser services are started, and the delay for processing the accounting log has expired, the parser will begin processing any PBS Professional accounting log information that has been made available by the data collector. Refer to section , “Parsing the accounting logs”, on page 125 for more information about parsing the accounting logs.

Exit codes N/A Successful

Unsuccessful

0

Refer to section 17.2.3, “Default exit code configuration data”, on page 228.

Custom group 2011-2013 “OTHERS” Required by PBSA - do NOT delete

The PBSA web application defines prime and non-prime time as:

Prime Time : 08:00 AM to 17:30 PM Non Prime Time Morning: 12:00 AM to 8:00 AM Non Prime Time Evening : 17:30 PM to 12:00 AM

Table 7-1: Configuration defaults

Configuration Year(s) Default



7.8 Logging into the PBSA web application

Once parsing is complete, you will see a message similar to the following in the web applica-tion log file, <INSTALL_DIR>/portal/logs/pbsworks.log:

You may now login to the PBSA web application by using any of the supported web browsers through the URL http://<hostname>:<port>/pbsworks.

See section 16.1.5, “Troubleshooting logging into PBSA”, on page 214 to solve problems experienced while logging into PBSA.

Initialization of the analytics engine completed successfully in X minutes. You may now login to the PBSA web application using the URL http://<hostname>:<port>/pbsworks


Chapter 8

Configuring node detailsPBSA requires specific details about your site’s PBS Professional cluster, therefore informa-tion about each PBS complex (each PBS Professional server and its associated execution hosts) is required. PBSA does this by storing a detailed node configuration map for each PBS complex.

Steps for creating this map for each PBS Professional complex are:

1. obtain PBS complex node information using the pbsnodes -av command

2. run the PBSA node configuration command pbsa-config-nodes

3. evaluate nodes that are offline or down

4. re-run the PBSA node configuration command after down/offline evaluation

5. repeat steps 2-4 for every year for which the PBS Complex has accounting log data

These steps must be completed for every PBS Professional complex BEFORE parsing is initi-ated. PBSA expects that all accounting log data from previous years will be parsed during the initial parsing cycle. Once the initial parsing cycle is complete, subsequent parsing cycles will only parse newly generated accounting logs (accounting logs that have not been parsed by PBSA). For example, you cannot

1. create a node configuration map for PBS complex #1 using the above steps

2. parse the accounting logs

3. create a node configuration map for PBS complex #2

4. run the parsing cycle again

Only the current year’s accounting logs will be parsed for PBS complex #2.


Chapter 8 Configuring node details

8.1 Obtain node information

To build a node configuration map for a PBS cluster obtain node information by executing the PBS Professional command pbsnodes -av for each PBS Professional complex. The out-put of this command should be written to an output file, for instance

pbsnodes -av > pbsnodes1.out

The data in the pbsnodes -av output file is basically a snapshot of the current PBS com-plex node configuration. PBSA assumes that your site’s nodes have always been configured this way, and will provide utilization statistics based on those details.

The data contained in these output files is used as input to a PBSA configuration command, pbsa-config-nodes.

8.2 Run the node configuration command

Use the output files from the pbsnodes -av command as input to the PBSA configuration command, pbsa-config-nodes. The basic usage for the pbsa-config-nodes com-mand is:

pbsa-config-nodes PRIMARY_SERVER SECONDARY_SERVER PATH_TO_PBSNODES.OUT --start-date=STARTDATE --end-date=ENDDATE

where:

PRIMARY_SERVER is the name of the PBS Professional primary server

SECONDARY_SERVER (optional) is the name of the PBS Professional failover server

PATH_TO_PBSNODES.OUT is the output from the command: pbsnodes -av

--start-date,--end-date is the date range when the node configuration is in effect

The pbsa-config-nodes command will need to be executed for each PBS Professional complex, that is for each pbsnodes -av output file. The pbsa-config-nodes com-mand must be executed on the machine where the parser is deployed.

The PRIMARY_SERVER must be the fully qualified domain name (as specified in the PBS accounting logs).


Configuring node details Chapter 8

‘For example, if a site has three PBS Professional complexes: complex A, complex B, and complex C, then execute the following commands for:

Complex A:

pbsnodes -av > pbsnodes_complexA.out

Complex B:

pbsnodes -av > pbsnodes_complexB.out

Complex C.:

pbsnodes -av > pbsnodes_complexC.out

Execute these commands on the server where the PBSA parser is installed:

pbsa-config-nodes serverA pbsnodes_complexA.out --start-date=2013-01-01

pbsa-config-nodes serverB pbsnodes_complexB.out --start-date=2013-01-01

pbsa-config-nodes serverC pbsnodes_complexC.out --start-date=2013-01-01

These commands will create a node details file for the year 2013, making it effective from January 1, 2013 until “now” (--end-date defaults to “now” which means the node configura-tion is in effect going forward). For more information about the node details file see section 17.5, “Node details file”, on page 243.

8.3 Evaluate offline or downed nodes

If any nodes are offline or down, the pbsa-config-nodes command will return a mes-sage similar to the following:

This message will be returned for nodes having a comment equal to “node down:communica-tion closed”, or having the following states:

• down,unresolvable

• state-unknown,offline

• state-unknown,down

Please check the pbsanodes-av output file, some of the nodes are offline. Following nodes are offline: ['tribm3550m3-02']



The system administrator must perform some analysis at this point to determine the cause of the downed node. For instance, there may be a communication problem between the PBS Professional MOM and headnode that is causing the node to be marked as down, when actu-ally the node is up and running. In this case correct the communication problem, verify that node resources are correct, re-run the pbsnodes -av command, and issue the pbsa-config-nodes command again.

If the node is down for a valid reason, such as maintenance, then you will have to manually edit the pbsnodes.out file. You may:

• change the state of the node to an online state such as “free”. If you choose to set the state of a downed node to “free”, verify that the following two parameters are present in the pbsnodes -av output for that node:

• resources_available.ncpus

• resources_assigned.mem

If these parameters are not present, then manually enter this information for that node.

• delete the node from the pbsnodes.out file. You can configure PBSA at a later date when the node comes online (see section 11.3, “Configuration changes after initial pars-ing”, on page 128). However, deleting the node from the file creates a situation where PBSA is “unaware” of this node during the initial parsing of the accounting logs, thereby skewing the parsing results.

Once all manual editing is complete, issue the pbsa-config-nodes command again.

8.4 Node configuration for previous years

You will need to create a node details file for every year for which your site has accounting log data.

For example, if your site has accounting log data for the years 2011-2013, then execute the following commands to create a node details file for 2011 for each PBS Professional complex:

pbsa-config-nodes serverA pbsnodes_conplexA.out --start-date=2011-01-01 --end-date=2011-12-31

pbsa-config-nodes serverB pbsnodes_conplexB.out --start-date=2011-01-01 --end-date=2011-12-31

pbsa-config-nodes serverC pbsnodes_conplexC.out --start-date=2011-01-01 --end-date=2011-12-31


Configuring node details Chapter 8

Execute the following commands to create a node details file for 2012 for each PBS Profes-sional complex:

pbsa-config-nodes serverA pbsnodes_conplexA.out --start-date=2012-01-01 --end-date=2012-12-31

pbsa-config-nodes serverB pbsnodes_conplexB.out --start-date=2012-01-01 --end-date=2012-12-31

pbsa-config-nodes serverC pbsnodes_conplexC.out --start-date=2012-01-01 --end-date=2012-12-31

This assumes that the node configuration did not change from 2011 to 2013.


Chapter 9

Optional configurationPBSA has default charts that provide utilization tracking for the following categories:






Providing site specific information for these categories will increase the usefulness of the PBSA default charts. However, providing this information is optional and PBSA has defaults for some of these categories - see Table 7-1, “Configuration defaults,” on page 102.

The following sections will show how to use the PBSA commands to provide this site specific information. If you prefer to use the defaults, then you can skip these steps and start PBSA.

PBSA provides defaults for holidays, prime/non-prime time hours, and custom groups for the last three years, and also defaults for exit codes.


Chapter 9 Optional configuration

9.1 Configuring holidays

In order to provide utilization information for holidays (non-working days), PBSA must be configured with the yearly holiday schedule.

PBSA is configured by default for three years (2011 to 2013) with the single holiday for each year of New Year's day.

The command, pbsa-config-holidays, can be used to add further holiday information to PBSA. The pbsa-config-holidays command must be executed on the machine where the parser is deployed.

For instance, the following command will configure a holiday that takes place over a single day.

pbsa-config-holidays MemorialDay --start-date=2013-05-27 --enddate=2013-05-27

The following command shows how to configure a holiday that takes place over multiple days.

pbsa-config-holidays Thanksgiving --start-date=2013-11-21 --end-date=2013-11-22

The following shows how to configure a holiday that takes place in a previous year.


Execute the pbsa-config-holidays for each holiday in your site’s holiday schedule..

For more information about using the pbsa-config-holidays command see section 13.2, “Configuring holidays”, on page 143.

The holiday information must be maintained on a yearly basis, therefore it must be configured for all years for which you want to track utilization.


Optional configuration Chapter 9

9.2 Configuring prime and non-prime hours

In order to provide utilization information for prime (normal working hours) and non-prime (non-working hours) hours, PBSA must be configured with this information for each day of the week.

PBSA is configured by default for the years 2011 through 2013. For Monday through Friday, prime times hours begin at 09:00 am, and non-prime time hours begin at 5:30 pm. For Satur-day and Sunday, the entire day is scheduled as non-prime time.

The command, pbsa-config-holidays, can be used to add further prime/non-prime time information to PBSA. The pbsa-config-holidays command must be executed on the machine where the parser is deployed.

For instance, the following command configures prime time to start at 9:00 am and non-prime to start at 6:00 pm for Monday.

pbsa-config-holidays monday --prime-time=09:00 --non-prime-time=18:00

Executing the following command configures prime time to start at 8:00 am and non-prime time to start at 5:30 pm for Monday. Prime time start defaults to 8:00 am and non-prime start defaults to 5:30 pm (17:30).

pbsa-config-holidays monday

Executing this command configures prime/non-prime time hours for any weekdays (Monday-Friday) not specified separately. For instance, if prime time and non-prime time have already been specified for the days Monday and Tuesday, then this command will specify prime time and non-prime time for days Wednesday through Friday.

pbsa-config-holidays weekdays --prime-time=09:00 --non-prime-time=18:00

Executing the following command configures prime time to start at 9:00 am and non-prime time to start at 6:00 pm for weekends (Saturday and Sunday).

pbsa-config-holidays weekends --prime-time=09:00 --non-prime-time=18:00

To ensure the PBSA charts and dashboards report accurate statis-tics, both prime time and non-prime time must be defined for every day of the week.



This following command configures prime time to start at 9:00 am and non-prime to start at 6:00 pm for Monday for the year 2012 (a previous year’s configuration).

pbsa-config-holidays monday --prime-time=09:00 --non-prime-time=18:00 --start-date=2012-01-01

Execute the pbsa-config-holidays for each day of the week to load working and non-working hours into PBSA. Please note that the first time the pbsa-config-holidays command is issued, a default entry is automatically generated specifying that prime time hours start at 8:00 am and non-prime time hours start at 5:30 pm for weekdays. If you do not want this default value, then use the pbsa-config-holidays --remove option to remove this information (see section 13.2, “Configuring holidays”, on page 143).

For more information about using the pbsa-config-holidays command see section 13.2, “Configuring holidays”, on page 143.

The prime/non-prime time information must be maintained on a yearly basis, therefore it must be configured for all years for which you want to track utilization.



9.3 Configuring custom groups

Custom groups can be used to track utilization at a project level for sites running versions of PBS Professional prior to 11.2, or are submitting their jobs via application definitions.

The preferred method for tracking utilization at a project level is the use of the -P option when submitting a job via the qub command (see section 3.4.3, “Project metrics - use the qsub -P option”, on page 17).

For example, several engineers may be assigned to a project. To track the total number of jobs executed for that project, PBSA must be configured so that it knows which users are assigned to that project.

The command, pbsa-config-groups, can be used to add this information to PBSA. The pbsa-config-groups command must be executed on the machine where the parser is deployed.

For example, the following command configures a user “tsmith” to be assigned to a custom group (i.e., project) “CFD” from January 22, 2013 to November 23, 2013.

pbsa-config-groups tsmith CFD --start-date=2013-01-22 --end-date=2013-11-23

PBSA is configured with a default group “OTHERS” for the years 2011 through 2013.

Execute the pbsa-config-groups for each user and project for which you would like to track utilization.

Custom groups is an alternative offered by PBSA that has been made available for legacy purposes only, and may be deprecated in future releases of PBSA.

Do NOT delete the default custom group called “OTHERS”.

The custom group information must be maintained on a yearly basis, therefore it must be configured for all years for which you will want to track utilization.



There are some caveats for entering this information, so it is recommended to review section 13.3, “Configuring custom groups”, on page 154 for more information about using the pbsa-config-groups command.

9.4 Configuring exit codes

In order to track job execution failure rates and reasons for failures, PBSA must be configured with those exit codes you would like to track and report. You can track failure rates at the application level, or for all applications.

PBSA is configured by default with the following exit codes:

• Successful - 0

• Unsuccessful - Refer to section 17.2.3, “Default exit code configuration data”, on page 228.

The command, pbsa-config-exits, can be used to add this information to PBSA. The pbsa-config-exits command must be executed on the machine where the parser is deployed.

For instance, the following command configures an exit code of “1” to be defined as “Suc-cessful” for the application PBSJobApp.

pbsa-config-exits 1 --reason=Successful --application=PBSJobApp

Executing the following command configures a list of exit codes to be defined as “Unspeci-fied” (default) for all applications (default).

pbsa-config-exits 2,143,255

For more information about using the pbsa-config-exits command see section 13.4, “Configuring exit codes”, on page 162.

PBS exit codes can be found in the “Job Exit Codes” section of the PBS Professional Admin-istrator’s Guide.

The default exit code “Still-Running” must not be removed from the exit code configuration.



9.5 Configuring custom resources

In order to provide utilization information for custom resources, PBSA requires custom resource configuration information to be maintained in a file called customresources.conf. An entry must be placed in this file for any PBS Professional custom resources for which utilization information needs to be tracked. The location of this file on the machine where the parser is deployed is:

<INSTALL_DIR>/portal/config

For more information about how to update this file see section 17.4, “Custom resource config-uration file”, on page 237.


Chapter 10

Starting PBSAOnce the installation and configuration of PBSA is complete, you can start PBSA. Prior to starting PBSA, you may want to configure the PBSA data collector and parser.

1. Configuring the PBSA data collector

2. Configuring the PBSA parser

3. Starting the web application and parser

4. Starting the data collectors

Once the initial parsing of the accounting logs is complete, it is recommended to reset the data collector and parser default values.

10.1 Configuring the PBSA data collector

The PBSA data collector makes the PBS Professional accounting logs accessible to the PBSA web application. It has two functions:

• copies the accounting logs from your site’s PBS Professional accounting log location to an intermediate holding area every five (5) minutes

• transports the information stored in the holding area to the machine where the PBSA web application and parser are installed every ten (10) minutes


Chapter 10 Starting PBSA

Prior to starting PBSA for the first time, you may want to change the time interval for both of these functions using the pbsa-config-dc command

For instance, the following command shows how to configure the data collector to collect the PBS accounting logs and copy them to an intermediate area every 50 minutes, and then trans-port the log information to the PBSA web application server every 60 minutes.

pbsa-config-dc --collection-interval=50 --transport-interval=60

If the PBSA data collector is currently running, then the PBSA data collector service will need to be restarted for the changes to be reflected.

It is recommended to:

• Set both the collection interval and the transport interval to at least 5 minutes.

• Keep the collection interval less than the transport interval.

For more information about using the pbsa-config-dc command see section 13.5, “Configuring the data collector”, on page 169.

10.2 Configuring the PBSA parser

Starting the web application service will start the web application and the parser. The PBSA parser will read the PBS Professional accounting logs, parse the appropriate information from the accounting logs, and then load this information into a database used by the PBSA web application.

There is a thirty (30) minute delay between the web application startup and the parsing of the accounting log information. This delay gives the data collector time to complete its cycle.

Prior to starting PBSA for the first time, you may want to change the default delay value using the pbsa-config-parser command. The pbsa-config-parser command must be executed on the machine where the parser is deployed.

PBSA is configured by default to copy accounting logs from PBS Professional every 5 minutes and transport the logs to PBSA every 10 minutes.


Starting PBSA Chapter 10

In addition, you can configure when the daily parser cycle will run (currently this cycle should not be run more than once in a 24-hour period, since PBSA currently does not support a finer granularity than a day).

For instance, the following command shows how to configure the parser to begin processing the PBS Professional accounting logs 30 minutes after the web application is started, and to run the daily parsing cycle at 2:00 am.

pbsa-config-parser --parser-cycle-delay=30 --parser-timer="0 0 2 * * ?"

If the PBSA web application is currently running, then the PBSA web application service will need to be restarted for the changes to be reflected.


• Set the parser cycle delay to no less than 10 minutes.

• Keep the data collector transport interval less than the parser cycle delay.

For more information about using the pbsa-config-parser command see section 13.6, “Configuring the parser”, on page 174.

10.3 Starting the web application and parser

Login to the server where the web application has been deployed using the login credentials of the PBSA service user (specified during the installation of PBSA). Once logged in, start the web application service (see section 12.1.1, “Starting the PBSA web application service”, on page 131).

To check the status of the web application service once it has been started use the PBSA status command (see section 12.1.4, “Determining the status of the PBSA web application service”, on page 133).

See section 16.1.4, “Troubleshooting the web application”, on page 212 for any problems experienced while starting the PBSA web application.

The parser cycle is configured to run once a day at 1:00 am. The default delay time for the parser to start is set to 30 minutes after the web application starts.



10.4 Starting the data collectors

Depending on the deployment option selected, you may have a single data collector, or you may have multiple data collectors installed across separate servers.

10.4.1 Deployment Option 1 - single server

If you have deployed the data collector and the web application on a single server (see section 2.1, “Deployment Option One”, on page 8), then only a single data collector has been installed.

Log into the server where PBSA has been deployed using the login credentials of the PBSA service user (specified during the installation of PBSA). Once logged in, start the PBSA data collector (see section 12.2.1, “Starting the PBSA data collector”, on page 133).

10.4.2 Deployment Option 2 - separate servers

If you have deployed the web application on a separate server from the data collector (see sec-tion 2.2, “Deployment Option Two”, on page 9), then multiple data collectors may have been installed.

Log into each server where the data collectors have been deployed using the login credentials of the PBSA service user (specified during the installation of PBSA). Once logged in, start the PBSA data collector (see section 12.2.1, “Starting the PBSA data collector”, on page 133). Continue this process until all data collectors have been started.

10.4.3 Determining status of data collector

To determine when the data collector has been started successfully, view the contents of the file <INSTALL_DIR>/dc/logs/dc.log on the machine where the data collector has been deployed using the following command:

cat dc.log


Starting PBSA Chapter 10

If the data collector started successfully, you will see messages similar to this:

Depending on the level of logging, you may also see messages indicating that the data collec-tor has successfully uploaded PBS Professional log files to the web application server:

To check the status of the data collector once it has been started use the PBSA status com-mand (see section 12.2.4, “Determining the status of the PBSA data collector service”, on page 134).

INFO, 12 Aug 13 13:51:52,548 -{DataCollectorController.java: 56} - Data Collector starting.

INFO, 21 Oct 13 11:32:34,582 -{SimpleThreadPool.java: 253} - Job execution threads will use class loader of thread: main

INFO, 21 Oct 13 11:32:34,641 -{RAMJobStore.java: 143} - RAMJobStore initialized.

INFO, 21 Oct 13 11:32:34,653 -{StdSchedulerFactory.java: 892} - Quartz scheduler 'DefaultQuartzScheduler' initialized from default resource file in Quartz package: 'quartz.properties'

INFO, 21 Oct 13 11:32:34,654 -{StdSchedulerFactory.java: 896} - Quartz scheduler version: 1.4.3

INFO, 21 Oct 13 11:32:34,654 -{QuartzScheduler.java: 370} - Scheduler DefaultQuartzSchedul-er_$_NON_CLUSTERED started.

DEBUG, 21 Oct 13 11:32:45,558 -{DataCollectorController.java: 173} - Successfully regis-tered with server.

INFO, 21 Oct 13 11:32:45,574 -{DataCollectorController.java: 76} - Data Collector started successfully.

DEBUG, 12 Aug 13 13:52:23,530 -{HTTPFileTransport.java: 122} - Successfully uploaded file 20120101


Chapter 11

Parsing the accounting logs The parsing of the accounting logs is necessary to make PBS Professional job data available to the PBSA web application. The parser reads the PBS Professional accounting logs, parses the appropriate information from the accounting logs, and then loads this information into a database used by the web application.

Once the web application and parser services are started, and the delay for processing the accounting log has expired, the parser will begin processing any PBS Professional accounting log information that has been made available by the data collector.

To track the progress of the parsing process, view the contents of the file <INSTALL_DIR>/portal/logs/parser.log on the machine where the parser is deployed using the fol-lowing command:

cat parser.log

Initially, the PBSA configuration information (holiday, prime time, exit codes, custom groups, and node details) will be read and parsed. Messages similar to the following will be displayed indicating that the parser has read the configuration information:

2013-08-12 13:54:57,676 INFO [com.altair.pbsworks.parser.common.config.ConfigReader] Read-ing Config File:/opt/pbsworks/12.2/portal/services/pbsa/parser/modules/pbsdata/config/hol-iday_2011.conf

2013-08-12 13:54:57,697 INFO [com.altair.pbsworks.parser.common.config.ConfigReader] Fin-ished Reading File:/opt/pbsworks/12.2/portal/services/pbsa/parser/modules/pbsdata/config/holiday_2011.conf


Chapter 11 Parsing the accounting logs

If the parser is able to parse the configuration information and load it into the PBSA database, you will see messages similar to these:

If a configuration file is missing you will see messages similar to these:

Discard the data from the previous parsing cycle (see Chapter 19, "Reparsing the accounting logs", on page 305), provide the missing configuration information, and run the parsing cycle again by starting the web application and data collectors.

Once the parser begins parsing the PBS Professional accounting logs you will see messages similar to these:

2013-08-12 13:55:03,333 INFO [com.altair.pbsworks.parser.common.config.populator.TimePopu-lator] Parsing HOLIDAY Configuration

2013-08-12 13:55:44,637 INFO [com.altair.pbsworks.parser.common.config.ConfigurationPro-vider] Parsing EXIT STATUS Configuration

2013-08-12 13:55:44,933 INFO [com.altair.pbsworks.parser.common.config.ConfigurationPro-vider] Parsing NODE DETAILS Configuration

2013-08-12 13:56:12,020 INFO [com.altair.pbsworks.parser.common.config.ConfigurationPro-vider] Parsing CUSTOM GROUP Configuration

2013-08-12 15:33:06,139 ERROR [com.altair.pbsworks.parser.common.config.ConfigReader] cus-tom_group config file not present

2013-08-12 15:33:06,139 ERROR [com.altair.pbsworks.parser.common.config.ConfigReader] exit_status config file not present

2013-08-12 15:33:06,140 ERROR [com.altair.pbsworks.parser.common.config.ConfigReader] holi-day config file not present

2013-08-12 15:33:06,140 ERROR [com.altair.pbsworks.parser.common.config.ConfigurationPro-vider] Please ensure all config files are present to initiate parsing

2013-08-12 13:56:20,949 INFO [com.altair.pbsworks.parser.app.Parser] Parsing 20120101 log file

2013-08-12 13:56:20,995 INFO [com.altair.pbsworks.parser.app.Parser] File is parsed: 20120101

2013-08-12 13:56:21,035 INFO [com.altair.pbsworks.parser.app.Parser] File 20120101 deleted.


Parsing the accounting logs Chapter 11

If the PBSA configuration files and the PBS Professional accounting logs are parsed properly with no errors, you will see the following message:

Followed by these messages indicating that parsing is complete:

11.1 Initial parsing of the accounting logs

The initial parsing cycle takes place after the installation and configuration of PBSA is com-pleted, and the web application and data collectors are started for the first time. This initial parsing process may take from several hours to several days, depending upon the amount of data stored in the PBS Professional accounting log(s), number of processors, and amount of available RAM.

For a site that is installing PBSA for the first time, configuration of PBSA followed by pars-ing, may be an iterative process requiring several parsing cycles before PBSA is configured appropriately by the system administrator. If after running a parsing cycle, you find that addi-tional configuration is required, you may discard the data from the previous parsing cycle (see Chapter 19, "Reparsing the accounting logs", on page 305), modify your configuration, and run the parsing cycle again.

2013-10-24 14:26:24,524 INFO [com.altair.pbsworks.parser.common.config.populator.EventRe-cordPopulator] rc_event_resource_occupancy_temp table created.

2013-10-21 20:19:08,344 INFO [com.altair.pbsworks.parser.app.AnalyticsApplication] Parser has completed parsing the accounting logs.

2013-10-21 20:19:08,344 INFO [com.altair.pbsworks.parser.app.AnalyticsApplication] Analyt-ics engine is now being initialized with the parsed accounting log data. Please do not login to the web application until this process is complete.

2013-10-21 20:19:08,344 INFO [com.altair.pbsworks.parser.app.AnalyticsApplication] To check for completion of the initialization process, view the web application log file pbsworks.log.

To discard all parsed data and reparse the PBS Professional accounting logs see Chapter 19, "Reparsing the accounting logs", on page 305.



11.2 Daily parsing of the accounting logs

After the initial parsing of the PBS Professional accounting logs, newly generated accounting logs will continue to be parsed on a daily basis. PBSA is configured by default to run the parsing cycle at 1:00 am, but can be configured to run at a different time (see section 13.6, “Configuring the parser”, on page 174). Currently, this cycle should not be run more than once in a 24-hour period.

11.3 Configuration changes after initial parsing

Please note that once the initial parsing cycle is complete, any modifications to the PBSA con-figuration will require the PBSA database to be discarded (see Chapter 19, "Reparsing the accounting logs", on page 305). The initial parsing cycle will need to be run again, Excep-tions to this rule are described in the following topics.

11.3.1 User is assigned to a new project

When a user is assigned to a new project, use the pbsa-config-groups command to add a new record to the custom_group_YYYY.conf file having start date equal to today's date or later. The end date can be set to a future date or “now”.

11.3.2 User completes a project assignment

When a user completes a project assignment, use the pbsa-config-groups command to remove the user/group from the custom_group_YYYY.conf file, and then add a new record with the end date updated to the user’s assignment completion date.

11.3.3 PBS Professional node configuration change

PBSA needs to be updated whenever a site’s PBS Professional complex changes. Events that requires PBSA to be updated are:

• addition of new nodes

• deletion of nodes

• nodes that are offline

• nodes that have been brought back online


Parsing the accounting logs Chapter 11

When a site’s PBS complex changes:

• Execute the PBS Professional pbsnodes -av command to create a new pbsno-des.out file.

• Use this file as an argument to the pbsa-config-nodes command to update PBSA with the new PBS Professional node configuration.

• Use the --start-date and --end-date options to define the dates for which the new PBS Pro-fessional configuration is in effect. For example, if a new node was added on March 1, 2013, then issue the following pbsa-config-nodes command:

pbsa-config-nodes hwesuse113-01 pbsnodes.out --start-date=2013-03-01

When the next parsing cycle runs, this information will be picked up and loaded into PBSA.

11.3.4 Node configuration cron job

If your site changes their PBS Professional complex configuration often, you may want to cre-ate a cron job to automatically issue the PBS Professional pbsnodes -av command, fol-lowed by the pbsa-config-nodes command to configure PBSA with the new PBS Professional node configuration.

The pbsa-config-nodes command returns an exit code of zero (0) upon successful com-pletion. Otherwise, the command return a non-zero exit code. This exit code is not returned as standard output, but can be queried when using a cron job to wrap the pbsa-config-nodes.


Chapter 12

PBSA service commands

12.1 Web application service commands

12.1.1 Starting the PBSA web application service

This command will start the PBSA web application service and parser. It will not start the PBSA data collector service.

At the Linux command line prompt enter:

/etc/init.d/pbsworks-pbsa start

Messages similar to the following will be displayed:

Starting MonetDB server

MonetDB server started, pid: 21253 [OK]

Starting PBSWorks Login server

Platform : x86_64

64 Bit machine

Using CATALINA_BASE: /opt/pbsworks/12.2/portal/thirdparty/apache/tomcat

Using CATALINA_HOME: /opt/pbsworks/12.2/portal/thirdparty/apache/tomcat

Using CATALINA_TMPDIR: /opt/pbsworks/12.2/portal/thirdparty/apache/tomcat/temp

Using JRE_HOME: /opt/pbsworks/12.2/portal/thirdparty/java

Using CLASSPATH: /opt/pbsworks/12.2/portal/thirdparty/apache/tomcat/bin/bootstrap.jar

PBSWorks Login server started, pid: 21296 [OK]


Chapter 12 PBSA service commands

12.1.2 Stopping the PBSA web application service

This command will stop the PBSA web application service and parser. It will not stop the PBSA data collector service.


/etc/init.d/pbsworks-pbsa stop

The following messages will be displayed:

12.1.3 Restarting the PBSA web application service

This command will restart the PBSA web application service and parser. It will not restart the PBSA data collector service.


/etc/init.d/pbsworks-pbsa restart

Messages similar to the following will be displayed:

Stopping PBSWorks Login server PID 21296: [OK]

Stopping MonetDB server PID 21253 [OK]

Restarting PBSWorks Login server

Stopping PBSWorks Login server PID 20633: [OK]

Stopping MonetDB server PID 20596 [OK]

Starting MonetDB server

MonetDB server started, pid: 25186 [OK]

Starting PBSWorks Login server

Platform : x86_64

64 Bit machine

Using CATALINA_BASE: /opt/pbsworks/12.2/portal/thirdparty/apache/tomcat

Using CATALINA_HOME: /opt/pbsworks/12.2/portal/thirdparty/apache/tomcat

Using CATALINA_TMPDIR: /opt/pbsworks/12.2/portal/thirdparty/apache/tomcat/temp

Using JRE_HOME: /opt/pbsworks/12.2/portal/thirdparty/java

Using CLASSPATH: /opt/pbsworks/12.2/portal/thirdparty/apache/tomcat/bin/bootstrap.jar

PBSWorks Login server started, pid: 25223 [OK]


PBSA service commands Chapter 12

12.1.4 Determining the status of the PBSA web application service

This command will determine the status of the PBSA web application service. At the Linux command line prompt enter:

/etc/init.d/pbsworks-pbsa status


12.2 Data collector service commands

12.2.1 Starting the PBSA data collector

This command will start the PBSA data collector service. It will not start the PBSA web application service or parser.


/etc/init.d/pbsworks-dc start


12.2.2 Stopping the PBSA data collector service

This command will stop the PBSA data collector service. It will not stop the PBSA web application service or parser.


/etc/init.d/pbsworks-dc stop


PBSWorks Login server (pid 20633) is running

Starting PBSWorks Data Collector

PBSWorks Data Collector started, pid: 22258 [OK]

Stopping PBSWorks Data Collector PID 22258: [OK]


Chapter 12 PBSA service commands

12.2.3 Restarting the PBSA data collector service

This command will restart the PBSA data collector service. It will not restart the PBSA web application service or parser.


/etc/init.d/pbsworks-dc restart


12.2.4 Determining the status of the PBSA data collector service

This command will determine the status of the PBSA data collector service. At the Linux command line prompt enter:

/etc/init.d/pbsworks-dc status


Restarting PBSWorks Data Collector

Stopping PBSWorks Data Collector PID 20723: [OK]

Starting PBSWorks Data Collector

PBSWorks Data Collector started, pid: 25058 [OK]

PBSWorks Data Collector (pid 20723) is running


Chapter 13

PBSA commandsThe installation directory (denoted in this document as <INSTALL_DIR>) for a typical instal-lation of PBSA is:

/opt/pbsworks/12.2

Site specific configuration of PBSA is required so that accurate utilization metrics can be obtained from the information contained in the PBS Professional accounting logs. A number of commands are provided by PBSA to assist with this configuration.

13.1 Configuring nodes

Use the pbsa-config-nodes command to configure PBS Professional node information.

This command must be executed on the machine where the parser is deployed and must be run for each PBS Professional complex.

Mandatory input required for this command is the PBS Professional server hostname and the output from the PBS Professional command: pbsnodes -av.

The node detail information is stored by year in the file nodedetails_YYYY.conf where "YYYY" is the four digit year. For more information about this file see section 17.5, “Node details file”, on page 243. By default, the output of this command is written to:

<INSTALL_DIR>/portal/services/pbsa/parser/modules/pbsdata/config

The pbsa-config-nodes command returns an exit code of zero (0) upon successful com-pletion. Otherwise, the command return a non-zero exit code. This exit code is not returned as standard output, but can be queried when using a cron job to wrap the pbsa-config-nodes.


Chapter 13 PBSA commands

Events that would require this configuration to be done:

• initial installation of PBSA





13.1.1 Usage

pbsa-config-nodes PRIMARY_SERVER SECONDARY_SERVER PATH_TO_PBSNODES.OUT[options]

where

PRIMARY_SERVER is the hostname of the PBS Professional primary server

SECONDARY_SERVER (optional) is the name of the PBS Professional failover server

PATH_TO_PBSNODES.OUT is the output from the command: pbsnodes -av

If any nodes are offline or down, the pbsa-config-nodes command will return a mes-sage similar to the following:

This message will be returned for nodes having a comment equal to “node down:communica-tion closed”, or having the following states:

• down,unresolvable

• state-unknown,offline

• state-unknown,down

The system administrator must perform some analysis at this point to determine the cause of the downed node. For instance, there may be a communication problem between the PBS Professional MOM and headnode that is causing the node to be marked as down, when actu-

The PRIMARY_SERVER must be the fully qualified domain name (as specified in the PBS accounting logs).

Please check the pbsanodes-av output file, some of the nodes are offline. Following nodes are offline: ['tribm3550m3-02']


PBSA commands Chapter 13

ally the node is up and running. In this case correct the communication problem, verify that node resources are correct, re-run the pbsnodes -av command, and issue the pbsa-config-nodes command again.

If the node is down for a valid reason, such as maintenance, then you will have to manually edit the pbsnodes.out file. You may:

• change the state of the node to an online state such as “free”. If you choose to set the state of a downed node to “free”, verify that the following two parameters are present in the pbsnodes -av output for that node:

• resources_available.ncpus

• resources_assigned.mem

If these parameters are not present, then manually enter this information for that node.

• delete the node from the pbsnodes.out file. You can configure PBSA at a later date when the node comes online (see section 11.3, “Configuration changes after initial pars-ing”, on page 128). However, deleting the node from the file creates a situation where PBSA is “unaware” of this node during the initial parsing of the accounting logs, thereby skewing the parsing results.

Once all manual editing is complete, issue the pbsa-config-nodes command again.

Table 13-1: Command options and arguments

Option Argument Description

--version n/a Use this option to display the command's version number. This option can-not be used in conjunction with any other options.

--help n/a Use this option to display help for the command. This option cannot be used in conjunction with any other options.

--start-date=STARTDATE where STARTDATE is in the format of YYYY-MM-DD. Default is the current date.

Use this option to define the start date for which this PBS Professional server configuration is in effect.



13.1.2 Examples

All examples assume that the PBS Professional command pbsnodes -av has been exe-cuted and the output from this command has been written to a file called pbsnodes.out

--end-date=ENDDATE where ENDDATE is in the format of YYYY-MM-DD. Default is “now” which denotes that this configura-tion is currently in effect.

Use this option to define the end date for which this PBS Professional server configuration is in effect.

--config-dir=CONFIGDIR where CONFIGDIR is the directory path to the location where the output of this command will be directed. The default PBSA configu-ration directory is <INSTALL_DIR>/portal/services/pbsa/parser/mod-ules/pbsdata/config.

Use this option to specify an alternate configuration directory.

--show n/a Use this option to display the current configuration on the screen for review. Use this option in conjunc-tion with the --start-date option to view a configura-tion from a previous year. Default is to display the current year’s configura-tion information.

--new n/a Use this option to over-write any existing node details configuration.





13.1.2.1 Configure current node details

Execute the following command if you want to load node information that is effective today and will continue to be in effect going forward (start date defaults to today and end date defaults to “now”).

pbsa-config-nodes hwesuse113-01 pbsnodes.out

13.1.2.2 Configure previous year’s node details

Execute the following command if you want to load node configuration information for a pre-vious year:

pbsa-config-nodes hwesuse113-01 pbsnodes.out --start-date=2012-01-01 --end-date=2012-12-31

13.1.2.3 Redirect the output of the command

This example shows how the output of a command can be directed to an alternate location. This allows the output of the command to be saved without overwriting the contents of the default configuration directory.

pbsa-config-nodes hwesuse113-01 pbsnodes.out --config-dir=/tmp/pbsa-config-dir

13.1.2.4 Refresh the node configuration

Performing this command will overwrite the current node configuration. Use this command when you need to discard the current node configurations and start afresh.

pbsa-config-nodes hwesuse113-01 pbsnodes.out --new

13.1.2.5 Show previous year’s configuration

This command shows the node configuration for a previous year.

pbsa-config-nodes --start-date=2012-01-01 --show



13.1.3 Error Messages

Table 13-2: Command error messages

Error MessageError Description and

Troubleshooting

The PBSWORKS_COMMAND_HOME or PBSWORKS_SERVER_HOME vari-able was not set, and I was unable to find or open a pbsworks-pbsa.conf file.

The environment variables PBSWORKS_COMMAND_HOME and PBSWORKS_SERVER_HOME have not been exported to the environment. Contact your systems administrator to set up the environment properly.

Error occurred while setting PBSWORKS_COMMAND_HOME or PBSWORKS_SERVER_HOME.


Python version XX is not supported. Sup-ported version is 2.4x or higher.

Please update the Python version to 2.4 or higher.

Error occurred while get uid for user xxxxxx.

Unable to get user id for current user. Con-tact your system administrator to report this error.

Operation not permitted, Please run com-mand as XXXX user or ROOT.

The user does not have permissions to run this command. Please run the command as the PBSA service user specified during installation or as root user.

memory unit XXXX is not supported An error occurred while processing the pbsnodes- av output during the conver-sion of memory units to GB. The memory unit did not equal one of the following valid options: b, kb, mb, gb, tb, pb.

The configuration file is empty. This error may occur after executing this command with the --show option. The con-figuration file is empty, therefore nothing has been configured yet.



Please check the pbsnodes -av output file, some of the nodes are offline. Following nodes are offline: [‘xxxxxxxxxx’]

Please investigate the reason for the downed node and either correct the issue within PBS Professional, or if this is a planned outage, then manually edit the pbsnodes -av output file and modify the state of the node to an online status, or delete the node.

Incorrect number of arguments. Try pbsa-config-nodes --help.

Please review the usage information for this command. You can obtain the usage infor-mation by using the --help option.

Config directory does not exists. The PBSA configuration directory <INSTALL_DIR>/portal/services/pbsa/parser/modules/pbsdata/config does not exist. An error may have occurred during installation of PBSA. Please re-install the product.

Unable to instantiate the PBSA ToolKit. Please check your PBSWORKS_-SERVER_HOME variable.

The environment variable PBSWORKS_-SERVER_HOME may not have been exported to the environment. Contact your systems administrator to set up the environ-ment properly.

Unable to open the “nodedetails_<year>.conf” file.

Please check the existence and permissions of the nodedetails_YYYY.conf file located at <INSTALL_DIR>/portal/services/pbsa/parser/modules/pbsdata/config.

The startdate provided is not valid. STARTDATE must be in the format of YYYY-MM-DD.

The enddate provided is not valid. ENDDATE must be in the format of YYYY-MM-DD or must be “now”.

The startdate provided must not be greater than end date.

Invalid date range. STARTDATE must be less than ENDDATE.



Troubleshooting



The startdate year “YYYY” and enddate year “YYYY” must be the same.

Specified date range must not span over sev-eral years.

Start date format is incorrect. Expected is YYYY-MM-DD.

Dates should be in the format of YYYY-MM-DD.

Unable to read the “pbsnodes -av” output file.

Please check the existence and permissions of the pbsnodes -av output file.



Troubleshooting



13.2 Configuring holidays

Use the pbsa-config-holidays command to configure the yearly holiday schedule, and to configure prime (normal working hours) and non-prime (non-working hours) hours per day of week.

This command must be executed on the machine where the parser is deployed.

Mandatory input required for this command is the name of the holiday or the day of the week.

This configuration must be performed on a yearly basis. The holiday configuration informa-tion is stored by year in the file holiday_YYYY.conf, where "YYYY" is the four digit year. By default the output of this command is written to:


For more information about this file see section 17.1, “Holiday configuration file”, on page 219.

PBSA is configured by default for three years (2011 to 2013) with the single holiday for each year of New Year's day. For Monday through Friday, prime times hours begin at 09:00 am, and non-prime time hours begin at 5:30 pm. For Saturday and Sunday, the entire day is scheduled as non-prime time.



13.2.1 Usage

pbsa-config-holidays HOLIDAY|DAY_OF_WEEK[options]

where:

HOLIDAY is the name of the holiday. It can contain alphanumeric characters and/or underscores.

DAY_OF_WEEK is the name of the day of week. Valid values:

• weekdays (i.e., specifies any week day that has not already been defined sepa-rately - cannot use this value if Monday-Friday have already been con-figured separately)

• weekends (Saturday and Sunday - cannot be used if Saturday and Sunday have already been configured separately)

• monday

• tuesday

• wednesday

• thursday

• friday

• saturday

• sunday



--version n/a Use this option to display the com-mand's version number. This option cannot be used in conjunction with any other options.





Use this option to define the start date of the holiday. This option can also be used to configure prime/non-prime time hours for a pre-vious year’s config-uration.

--end-date=ENDDATE where ENDDATE is in the format of YYYY-MM-DD. Default is the current date.

Use this option to define the end date of the holiday.





--prime-time=PRIMETIME where PRIMETIME is in the format of HH:MM in the 24 hour format, or may be “all” which denotes that all hours are prime time hours, or may be “none” which denotes that all hours are non-primetime hours.

If PRIMETIME is set to “all”, then NONPRIME-TIME should be set to “none”. If PRIMETIME is set to “none”, then NONPRIMETIME should be set to “all”. Default is 09:00.

Use this option to define the prime-time start time.

--non-prime-time=NONPRIMETIME where NONPRIME-TIME is in the format of HH:MM in the 24 hour format, or may be “all” which denotes that all hours are non-primetime hours, or “none” which denotes that all hours are prime time hours.

If NONPRIMETIME is set to “all”, then PRIME-TIME should be set to “none”. If NONPRIME-TIME is set to “none”, then PRIMETIME should be set to “all”. Default is 17:30.

Use this option to define the non-primetime start time.





--config-dir=CONFIGDIR where CONFIGDIR is the directory path to the location where the out-put of this command will be directed. The default PBSA configuration directory is <INSTALL_DIR>/por-tal/services/pbsa/parser/modules/pbsdata/config.

Use this option to specify an alternate configuration direc-tory.

--show n/a. Use this option to display the current configuration on the screen for review. Use this option in conjunction with the --start-date option to view a configuration from a previous year. Default is to dis-play the current year’s configura-tion information..

--new n/a Use this option to overwrite any exist-ing holiday configu-ration.





13.2.2 Examples

13.2.2.1 Configure a one-day holiday

This example shows how to configure a holiday for a single day.

pbsa-config-holidays MemorialDay --start-date=2013-05-27 --end-date=2013-05-27

13.2.2.2 Configure a multiple-day holiday

This example shows how to configure a holiday for multiple days.


13.2.2.3 Configure prime/non-prime hours for a day of the week

Executing this command configures prime time to start at 9:00 am and non-prime to start at 6:00 pm for Monday.

pbsa-config-holidays monday --prime-time=09:00 --non-prime-time=18:00

--remove n/a Use this option to remove a holiday or day of the week from the current holiday configura-tion. AHOLIDAY or DAY_OF_WEEK must be designated to uniquely identify the holiday or day of the week to be removed.





13.2.2.4 Configure prime/non-prime hours using defaults

Executing this command configures prime time to start at 8:00 am and non-prime time to start at 5:30 pm for Monday. Prime time start defaults to 8:00 am and non-prime start defaults to 5:30 pm (17:30).

pbsa-config-holidays monday

13.2.2.5 Configure prime/non-prime hours for weekends

Executing this command configures prime time to start at 9:00 am and non-prime time to start at 6:00 pm for weekends (Saturday and Sunday).

pbsa-config-holidays weekends --prime-time=09:00 --non-prime-time=18:00

13.2.2.6 Configure prime/non-prime hours using weekdays

Executing this command configures prime/non-prime time hours for any weekdays (Monday-Friday) not specified separately. For instance, if prime time and non-prime time have already been specified for Monday and Tuesday, then this command will specify prime time and non-prime time for days Wednesday through Friday.

pbsa-config-holidays weekdays --prime-time=09:00 --non-prime-time=18:00

13.2.2.7 Configure prime/non-prime hours for previous year

Executing this command configures prime time to start at 9:00 am and non-prime time to start at 6:00 pm on every Monday for the year 2012.

pbsa-config-holidays monday --start-date=2012-01-01 --prime-time=09:00 --non-prime-time=18:00



pbsa-config-holidays MemorialDay --start-date=2013-05-27 --end-date=2013-05-27 --config-dir=/tmp/pbsa-config-dir



13.2.2.9 Refresh the holiday configuration

Executing this command will overwrite the current holiday configuration. Use this command when you need to discard the current holiday configuration and start afresh.

pbsa-config-holidays MemorialDay --start-date=2013-05-27 --end-date=2013-05-27 --new

13.2.2.10 Remove a holiday from the holiday configuration

Executing this command will remove a holiday from the current holiday configuration.

pbsa-config-holidays MemorialDay --remove

13.2.2.11 Remove a day from the holiday configuration

Executing this command will remove a day of the week from the current holiday configura-tion.

pbsa-config-holidays monday --remove

13.2.2.12 Show previous year’s configuration

This command shows the holiday configuration for a previous year.

pbsa-config-holidays --start-date=2012-01-01 --show




Troubleshooting


The environment variables PBSWORKS_COMMAND_HOME and PBSWORKS_SERVER_HOME have not been exported to the environment. Contact your systems administrator to set up the envi-ronment properly.








Unable to get user id for current user. Con-tact your system administrator to report this error..



Either Holiday or prime and non-prime config can be specified at a time.

Configuring a holiday or prime/non-prime cannot be done with a single command. First issue the command to configure the holidays, and then issue a second command to config-ure the prime/non-prime time hours.

The configuration file is empty. This error may occur after executing this command with the --show option. The con-figuration file is empty, therefore nothing has been configured yet.

Invalid holiday name. Holiday name must contain only any alphanumeric character and the underscore.

Please enter a valid holiday name which con-tains only alphanumeric characters and/or the underscore character.

Invalid option --remove in the command. Cannot specify the --remove option when using the --new option.



Troubleshooting



Please define all weekdays (Mon-Fri) sep-arately as "weekdays" value is removed.

The default entry for “weekdays” has been removed therefore, you must specify prime/non-prime time hours for Monday through Friday separately. For instance, you may reconfigure the prime and non-prime time hours by issuing the following command for each day of the week (Monday-Friday): pbsa-config-holidays dayofWeek --prime-time=HH:MM --non-prime-time=HH:MM where dayofWeek is: monday, tuesday, wednesday, thursday, fri-day

Please define both weekends (Sat-Sun) separately as "weekends" value is removed..

The default entry for “weekends” has been removed therefore, you must specify prime/non-prime time hours for Saturday and Sun-day separately. For instance, you may recon-figure the prime and non-prime time hours by issuing the following com-mands: pbsa-config-holidays Saturday --prime-time=HH:MM --non-prime-time=HH:MM pbsa-config-holi-days Sunday --prime-time=HH:MM --non-prime-time=HH:MM

Please make sure both weekend days (Sat & Sun) are defined.

Warning message that requests that prime/non-prime time hours be configured for both Saturday and Sunday.

Incorrect number of arguments. Try pbsa-config-holidays --help.




Troubleshooting






Unable to open the “holiday_<year>.conf” file.

Please check the existence and permissions of the holiday_YYYY.conf file located at <INSTALL_DIR>/portal/ser-vices/pbsa/parser/modules/pbsdata/config


The enddate provided is not valid. ENDDATE must be in the format of YYYY-MM-DD.







The primetime provided is not valid. PRIMETIME must be in the format of HH:MM in the 24 hour clock.

The nonprimetime provided is not valid. NONPRIMETIME must be in the format of HH:MM in the 24 hour clock.



Troubleshooting



13.3 Configuring custom groups

Custom groups can be used to track utilization at a project level for sites running versions of PBS Professional prior to 11.2, or are submitting their jobs via application definitions.

The preferred method for tracking utilization at a project level is the use of the -P option when submitting a job via the qub command (see section 3.4.3, “Project metrics - use the qsub -P option”, on page 17).

However, for older versions of PBS, use the pbsa-config-groups command.


Mandatory input required for this command is a userid, and the custom group (i.e., project) assigned to the user. Users may be assigned to multiple groups.

This configuration must be performed on a yearly basis. The custom group information is stored by year in the file custom_group_YYYY.conf, where "YYYY" is the four digit year. By default the output of this command is written to:


For more information about this file see section 17.3, “Custom group configuration file”, on page 229.

PBSA is configured with a default group “OTHERS” for the years 2011 through 2013.

There are two situations that are not supported by the pbsa-config-groups command, and will require that the custom group configuration file to be manually edited (see section 17.3.5, “Situations that require editing the Custom Group Configuration file”, on page 234 for examples).

1. First, the pbsa-config-groups command does not support a user being assigned to the same project more than once in a year. For instance, a user cannot be assigned to projectA from January through March in 2013, and then again from September

Custom groups is an alternative offered by PBSA that has been made available for legacy purposes only, and may be deprecated in future releases of PBSA.

Do NOT delete the default custom group called “OTHERS”.



through December. If this situation occurs, then the configuration file must be manu-ally edited to make this assignment.

2. Secondly, since a user can be assigned to multiple projects during the same time period, PBSA allows a default custom group (project) to be selected. For instance, user1 is assigned to projectA and projectB, and projectA is designated as the “default” project. If user1 submits a job without designating the project (using the qsub -P option), then PBSA will track the job’s utilization against projectA since it was desig-nated the “default” project. The pbsa-config-groups command does not cur-rently support setting the default project. Again, the configuration file must be manually edited to make this assignment.

The date a user begins working in a group will determine which yearly configuration file is updated. If a user works in a group over consecutive years, entries must be made in multiple configuration files - one for each year.

For example, if a user is assigned to a group for the year 2012, and then continues working for that same group into 2013, then an entry for 2012 must be made in the 2012 configuration file with an ending date of December 31, 2012. A second entry must be made in the 2013 config-uration file with a start date of January 1, 2013.

Once the initial parsing cycle has finished, modifications to the current year's file should only be done in two situations and do not require any reparsing of accounting logs.

1. A user is assigned to a new project.

In this instance, use the pbsa-config-groups command to add a new record to the custom_group_YYYY.conf file having a start date equal to today's date or later. The end date can be set to a future date or "now".

2. A user completes an assignment.

In this instance, use the pbsa-config-groups command to update the current record by setting the start date to the initial assignment start date, and updating the end date to the user’s assignment completion date.

If this file (or a previous year's file) needs to be modified for any other reasons, the accounting logs have to be reparsed.

If a user works in a group over consecutive years, entries must be made in multiple configuration files - one for each year



13.3.1 Usage

pbsa-config-groups USER GROUP[options]

where:

USER is the userid

GROUP is the custom group or project to which the user is assigned.



--version n/a Use this option to display the command's version number. This option cannot be used in conjunction with any other options.



Use this option to define the date on which the user began working on the project.

--end-date=ENDDATE where ENDDATE is in the format of YYYY-MM-DD. Default is “now” which denotes that the user is still currently working in the group.

Use this option to define the date on which the user stopped working on the project.



--config-dir=CONFIGDIR where CONFIGDIR is the directory path to the location where the out-put of this command will be directed. The default PBSA configuration directory is <INSTALL_DIR>/portal/services/pbsa/parser/modules/pbsdata/config.


--show n/a Use this option to display the current configuration on the screen for review. Use this option in conjunction with the --start-date option to view a con-figuration from a previous year. Default is to display the current year’s configuration informa-tion.

--new n/a Use this option to overwrite any existing user/group config-uration.

--remove n/a Use this option to remove the specified user/custom group from the current configura-tion. Both the USER and GROUP must be specified to uniquely identify the custom group to be removed.





13.3.2 Examples

13.3.2.1 Assigning a user to a custom group

Executing this command assigns a user (tsmith) to a custom group (CFD) from January 22, 2013 to November 23, 2013.


Executing this command configures a user to be assigned to a custom group with a start date of today’s date and an end date of “now” denoting that the user is currently assigned to that custom group.

pbsa-config-groups tsmith CFD

Executing this command assigns a user (tsmith) to a custom group (CFD) from January 1, 2013 with an end date of “now” denoting that the user is currently assigned to that custom group.

pbsa-config-groups tsmith CFD --start-date=2013-01-01

13.3.2.2 Assigning a user to several custom groups

Executing these commands assigns a user (tsmith) to a custom group (CFD) from January 1, 2013 to June 1, 2013, and to another custom group (CAD) from January 1, 2013 to September 1, 2013.


pbsa-config-groups tsmith CAD --start-date=2013-01-01 --end-date=2013-09-01



pbsa-config-groups tsmith CFD --start-date=2013-01-01 --end-date=2013-06-01 --config-dir=/tmp/pbsa-config-dir



13.3.2.4 Refresh the custom group configuration

Performing this command will overwrite the current custom group configuration. Use this command when you need to discard the current custom group configuration and start afresh.

pbsa-config-groups tsmith CFD --start-date=2013-01-22 --end-date=2013-11-23 --new

13.3.2.5 Remove a custom group from the configuration

This example shows how to remove a custom group from the current custom group configura-tion.

pbsa-config-groups tsmith CFD ---remove

13.3.2.6 Show previous year’s custom group configuration

This command shows the custom group configuration for a previous year.

pbsa-config-groups --start-date=2012-01-01 --show




Troubleshooting













The configuration file is empty. This error may occur after executing this command with the --show option. The con-figuration file is empty, therefore nothing has been configured yet

Incorrect number of arguments. Try pbsa-config-groups --help.



WARN: User "system" can't be removed. The default entry “system” cannot be deleted. PBSA requires this entry.






Troubleshooting



Unable to open the “custom_group_<year>.conf” file.

Please check the existence and permissions of thecustom_group_YYYY.conf file located at <INSTALL_DIR>/portal/services/pbsa/parser/modules/pbsdata/config.


The enddate provided is not valid. ENDDATE must be in the format of YYYY-MM-DD or must be “now”.









Troubleshooting



13.4 Configuring exit codes

Use the pbsa-config-exits command to configure exit codes. It is based on the pre-defined exit codes from PBS Professional.


Mandatory input required is a comma separated list or range of codes.

The exit code information is stored in the file exit_status.conf. By default the output of this command is written to:


For more information about this file see section 17.2, “Exit code configuration file”, on page 226.


• Successful - 0


13.4.1 Usage

pbsa-config-exits EXIT_CODES [options]

where:

EXIT_CODES is a comma separated list of exit codes and/or a range of exit codes.

The default exit code “Still-Running” must not be removed from the exit configuration.



A range of negative exit codes has to be configured using a comma separated list.



--version n/a Use this option to display the command's version number. This option can-not be used in conjunction with any other options.


--reason=REASON where REASON is a expla-nation or description of the exit code. Default is “Unspecified”.

Use this option to provide a description of the exit code.

--application=APPLICATION where APPLICATION is a name of an application such as “PBSJobApp”. Default is “All”.

The value assigned to --application directly corre-sponds to the application name specified via the PBS Professional "software" attribute.

Use this option to catego-rize the exit codes by application or solver. If this option is not defined, then the default is “All” applications.



--config-dir=CONFIGDIR where CONFIGDIR is the directory path to the loca-tion where the output of this command will be directed. The default PBSA configuration direc-tory is <INSTALL_DIR>/portal/services/pbsa/parser/modules/pbsdata/config.

Use this option to specify an alternate configuration directory.

--show n/a Use this option to display the current configuration on the screen for review. This option cannot be used in conjunction with any other options.

--new n/a Use this option to over-write any existing exit code configuration.

--remove n/a Use this option to remove a reason/application from the current exit code con-figuration. The --reason and --application options are used to uniquely iden-tify the exit code to be removed. If these options are not specified then the reason defaults to “Unspecified” and the application defaults to “All”.





13.4.2 Examples

13.4.2.1 Configuring an exit code

Executing this command configures an exit code of “1” to be defined as “Successful” for the application PBSJobApp.

pbsa-config-exits 1 --reason=Successful --application=PBSJobApp

13.4.2.2 Configuring a comma separated list of exit codes

Executing this command configures a list of exit codes to be defined as “Unsuccessful” for the application PBSJobApp.

pbsa-config-exits 2,143,255 --reason=Unsuccessful --application=PBSJobApp

Executing this command configures a list of exit codes to be defined as “Unspecified” for all applications (defaults).

pbsa-config-exits 2,143,255

13.4.2.3 Configuring a range of exit codes

Executing this command configures a range of exit codes from 10 to 20 to be defined as “Unsuccessful” for the application PBSJobApp.

pbsa-config-exits 10-20 --reason=Unsuccessful --application=PBSJobApp

A range of negative exit codes has to be configured using a comma separated list - see section 13.4.2.5, “Configuring negative exit codes”, on page 166.

13.4.2.4 Configuring both a list and a range of exit codes

Executing this command configures both a comma separated list and a range of exit codes to be defined as “Unsuccessful” for the application PBSJobApp.

pbsa-config-exits 1,2,3,10-20 --reason=Unsuccesful --application=PBSJobApp

A range of negative exit codes has to be configured using a comma separated list - see section 13.4.2.5, “Configuring negative exit codes”, on page 166.



13.4.2.5 Configuring negative exit codes

Executing this command configures negative exit codes.

pbsa-config-exits 1-10,11,12-15,-13,-14,-15

A range of negative exit codes can be configured using a comma separated list.



pbsa-config-exits 2,143,255 --config-dir=/tmp/pbsa-config-dir

13.4.2.7 Refresh the exit code configuration

Performing this command will overwrite the current exit code configuration. Use this com-mand when you need to discard the current exit code configuration and start afresh.

pbsa-config-exits 1 --reason=Successful --application=PBSJobApp --new

13.4.2.8 Refresh the exit code configuration with default entry

Performing this command will overwrite the current exit code configuration. This command will create a new exit code configuration file with a single default entry representing a job is “Still Running”.

pbsa-config-exits --new

13.4.2.9 Remove an exit code from the exit code configuration

Performing this command will remove exit codes defined for the application “All” and reason “Unspecified” (defaults) from the current exit code configuration .

pbsa-config-exits --remove

Performing this command will remove exit code defined for the application “PBSJobApp” and reason “Unspecified” (default) from the current exit code configuration

pbsa-config-exits --application=PBSJobApp --remove

Performing this command will remove exit codes defined for the application “All” (default) and reason “Unsuccessful” from the current exit code configuration.

pbsa-config-exits --reason=Unsuccessful --remove



Performing this command will remove exit code defined for the application “PBSJobApp” and reason “Unsuccessful” from the current exit code configuration

pbsa-config-exits --application=PBSJobApp --reason=Unsuccessful --remove




Troubleshooting











The configuration file is empty. This error may occur after executing this command with the --show option. The con-figuration file is empty, therefore no exit codes have been configured yet.



WARN: User can't update private settings for exitreason: "Still Running"

The default entry “Still Running” cannot be deleted. PBSA requires this entry.


Incorrect number of arguments. Try pbsa-config-exits --help.





Unable to open the “exit_status.conf” file. Please check the existence and permissions of the exit_status.conf file located at <INSTALL_DIR>/portal/services/pbsa/parser/modules/pbsdata/config



Troubleshooting



13.5 Configuring the data collector

The PBSA data collector makes the PBS Professional accounting logs accessible to the PBSA web application. It has two functions:

• copies the accounting logs from your site’s PBS Professional accounting log location to an intermediate holding area every five (5) minutes

• transports the information stored in the holding area to the machine where the PBSA web application and parser are installed every ten (10) minutes

You can change the time interval for both these functions using the pbsa-config-dc com-mand.

This command must be executed on the machine where the data collector is deployed.

By default the interval for copying the accounting logs is written to:

<INSTALL_DIR>/dc/config/modules.xml

By default the interval for transporting the accounting logs is written to:

<INSTALL_DIR>/dc/config/config.xml.


• Set both the collection interval and the transport interval to at least 5 minutes.

• Keep the collection interval less than the transport interval.

If the PBSA data collector is currently running, then it will need to be restarted after issuing the pbsa-config-dc command.

13.5.1 Usage

pbsa-config-dc [options]



--version n/a Use this option to dis-play the command's version number. This option cannot be used in conjunction with any other options.



--help n/a Use this option to dis-play help for the com-mand. This option cannot be used in con-junction with any other options.

--transport-interval=TRANSPORT where TRANSPORT is in minutes.

Use this option to define the transport interval in minutes for transporting the PBS Professional account-ing logs to the PBSA web application server.

--collection-interval=COLLECTION where COLLECTION is in minutes.

Use this option to define the collection interval in minutes for collecting the PBS Professional account-ing logs (copying them to an intermediate area prior to transporting to the web application server).

--config-dir=CONFIGDIR where CONFIGDIR is the directory path to the location where the out-put of this command will be directed. The default PBSA configu-ration directory is for the data collector is <INSTALL_DIR>/dc/config.






13.5.2 Examples

13.5.2.1 Configuring the data collector

This example shows how to configure the data collector to collect the PBS accounting logs and copy them to an intermediate area every 50 minutes, and then transport the log informa-tion to the PBSA web application server every 60 minutes.

pbsa-config-dc --transport-interval=60 --collection-interval=50



pbsa-config-dc --transport-interval=60 --collection-interval=50 --config-dir=/tmp/pbsa-config-dir

--show n/a. Use this option to dis-play the current data collector configura-tion on the screen for review.








Troubleshooting

The PBSWORKS_COMMAND_HOME or PBSWORKS_SERVER_HOME variable was not set, and I was unable to find or open a pbsworks-pbsa.conf file.

The environment variables PBSWORKS_COMMAND_HOME and PBSWORKS_SERVER_HOME have not been exported to the envi-ronment. Contact your systems administrator to set up the environ-ment properly.

Error occurred while setting PBSWORKS_COM-MAND_HOME or PBSWORKS_-SERVER_HOME.

The environment variables PBSWORKS_COMMAND_HOME and PBSWORKS_SERVER_HOME have not been exported to the envi-ronment. Contact your systems administrator to set up the environ-ment properly.

Python version XX is not supported. Supported version is 2.4x or higher.


Operation not permitted, Please run command as XXXX user.

The user does not have permissions to run this command. Please run the command as the PBSA service user specified during installation.

Option XX argument XXX must be in minutes. Then specified option must be expressed in minutes.

Please specify --transport-interval=TRANSPORT_INTERVAL or --collection-interval=COLLECTION_INTERVAL

You must specify either a transport interval and/or a collection interval.

The configuration file is empty. This error may occur after executing this command with the --show option. The configuration file is empty, there-fore nothing has been configured yet.



Config directory does not exists. The PBSA configuration directory <INSTALL_DIR>/portal/ser-vices/pbsa/parser/mod-ules/pbsdata/config does not exist. An error may have occurred during installation of PBSA. Please re-install the product.

Unable to instantiate the PBSA ToolKit. Please check your PBSWORKS_SERVER_HOME vari-able.

The environment variable PBSWORKS_SERVER_HOME may not have been exported to the envi-ronment. Contact your systems administrator to set up the environ-ment properly.

Unable to read the dc config file. Please check the existence and per-missions of the config.xml and/or modules.xml files located at <INSTALL_DIR>/dc/config



Troubleshooting



13.6 Configuring the parser

The PBSA parser will read the PBS Professional accounting logs, parse the appropriate infor-mation from the accounting logs, and then load this information into a database used by the PBSA web application.

There is a delay between the web application startup and the parsing of the accounting log information. This delay gives the data collector time to complete its cycle.

Use the pbsa-config-parser to configure this delay.


In addition, you can configure when the daily parser cycle will run (currently this cycle should not be run more than once in a 24-hour period).


• Set the parser cycle delay to no less than 10 minutes.

• Keep the data collector transport interval less than the parser cycle delay.

This information is written to

<INSTALL_DIR>/portal/services/pbsa/parser/modules/pbsdata/config/con-fig.xml

If the PBSA web application service is currently running, then it will need to be restarted after issuing the pbsa-config-dc command.

The parser delay is configured for 30 minutes by default.

By default, the parser cycle is configured to run once a day at 1:00 A.M.



13.6.1 Usage

pbsa-config-parser [options]



--version n/a Use this option to display the command's version number. This option cannot be used in conjunction with any other options.

--help n/a Use this option to display help for the command. This option cannot be used in con-junction with any other options.

--parser-cycle-delay=DELAY where DELAY is in min-utes.

Use this option to define the parser cycle delay in min-utes. This is the delay between when the web appli-cation begins running and when the parser begins to process the accounting log information.

--parser-timer=TIMER where TIMER is a Cron expression specified between double quotes. For example, "0 1 * 0 0 ?"

Use this option to define when the daily parsing cycle should run.

--job-duration=DURATION where DURATION is the maximum number of days that the parser will span for a job that runs over consecutive days.

Use this option to define the maximum number of days a job that the parser will span for a job that runs over con-secutive days.



13.6.2 Examples

13.6.2.1 Configuring the parser

This example shows how to configure the parser to begin processing the PBS Professional accounting logs 30 minutes after the web application is started, and to run the daily parsing cycle at 2:00 am.

pbsa-config-parser --parser-cycle-delay=30 --parser-timer="0 0 2 * * ?" --job-duration=60

13.6.2.2 Specify the location of the parser configuration file

This example shows how to specify the location of the parser configuration file con-fig.xml.

pbsa-config-parser --parser-cycle-delay=30 --parser-timer="0 0 2 * * ?" --config-dir=/tmp/pbsa-config-dir

--config-dir=CONFIGDIR where CONFIGDIR is the directory path to the location of the parser configuration file. The default PBSA configura-tion directory is <INSTALL_DIR>/por-tal/services/pbsa/parser/modules/pbsdata/config

Use this option to specify the location of the parser config-uration file config.xml.

--show n/a. Use this option to display the current parser configuration on the screen for review.





13.6.3 Error Message



Troubleshooting

The PBSWORKS_COMMAND_HOME or PBSWORKS_SERVER_HOME variable was not set, and I was unable to find or open a pbsworks-pbsa.conf file.

The environment variables PBSWORKS_COM-MAND_HOME and PBSWORKS_SERVER_HOME have not been exported to the envi-ronment. Contact your systems administrator to set up the environ-ment properly.


The environment variables PBSWORKS_COM-MAND_HOME and PBSWORKS_SERVER_HOME have not been exported to the envi-ronment. Contact your systems administrator to set up the environ-ment properly.



Error occurred while get uid for user xxxxxx. Unable to get user id for current user. Contact your system admin-istrator to report this error.

Operation not permitted, Please run command as XXXX user or ROOT.


Option XX argument XXX must be number. Then specified option must be expressed as a numeric.

Option time-zone argument XXX is not valid time-zone format.

The time zone must be expressed as GMT+HH:MM



Please specify at least one option either of --parser-cycle-delay=PARSER_CYCLE_DELAY, --parser-timer=PARSER_TIMER, --job-duration=JOB_DURATION or --time-zone=TIME_ZONE.

You must specify at least one of the following options:

--parser-cycle

--parser-timer

--job-duration

--time-zone.

The configuration file is empty. This error may occur after execut-ing this command with the --show option. The configuration file is empty, therefore nothing has been configured yet.

Config directory does not exists. The PBSA configuration directory <INSTALL_DIR>/portal/services/pbsa/parser/modules/pbsdata/config does not exist. An error may have occurred during installation of PBSA. Please re-install the prod-uct.

Unable to instantiate the PBSA ToolKit. Please check your PBSWORKS_SERVER_HOME vari-able.

The environment variable PBSWORKS_SERVER_HOME may not have been exported to the environment. Contact your sys-tems administrator to set up the environment properly.

Unable to read the parser config file. Please check the existence and per-missions of the config.xml located at <INSTALL_DIR>/portal/services/pbsa/parser/modules/pbsdata/config



Troubleshooting



13.7 Resetting the PBSA dataset

Use the pbsa-data-reset command to discard the data from the PBSA database.

This command must be executed on the machine where the web application and parser are deployed.

Additional steps must be performed to discard the accounting log data - see Chapter 19, "Reparsing the accounting logs", on page 305.

Please stop the PBSA web application and parser before issuing this command.

13.7.1 Usage

pbsa-data-reset[options]

This command resets the PBSA database password back to “pbsworks@123”. You can use the pbsa-data-password command to change the default.



--version n/a Use this option to display the com-mand's version number. This option cannot be used in conjunc-tion with any other options.




13.7.2 Examples

13.7.2.1 Resetting a dataset

Executing this command discards the parsed data from the PBSA database.

pbsa-data-reset




Troubleshooting













Error in reading the inputs. An error occurred while retrieving system arguments. Contact your system adminis-trator to report this error.

Property with key xxxxxx doesn't exists. An error occurred while reading the data-base configuration file monetdb-pbsa.conf. Contact your system admin-istrator to report this error.

File xxxxxxx must end with (.backup) An error occurred while resetting the data-set. Contact your system administrator to report this error.

File xxxxxxxx doesn't exists. An error occurred while reading the DBConnection.properties file. Contact your system administrator to report this error.

Error in reading monetdb-pbsa.conf file An error occurred while reading the data-base configuration file monetdb-pbsa.conf. Contact your system admin-istrator to report this error.

Updation of config file .monetdb failed. An error occurred while updating the con-figuration file monetdb-pbsa.conf. Contact your system administrator to report this error.

Updation of config file monetdb-user.sql failed.

An error occurred while updating the file monetdb-user.sql. Contact your sys-tem administrator to report this error.

Error in splitting command: xxxxxx An error occurred while resetting the data-set. Contact your system administrator to report this error.

Error in executing command: xxxxxx An error occurred while resetting the data-set. Contact your system administrator to report this error.



Troubleshooting



Command splitting failed: xxxxxx An error occurred while resetting the data-set. Contact your system administrator to report this error.

Server startup failed. An error occurred upon database server start up. Contact your system administrator to report this error.

Server status setting failed. An error occurred while setting the database server status. Contact your system adminis-trator to report this error.

Server status check failed. An error occurred while checking the data-base server status. Contact your system administrator to report this error.

Datacollectors load history deletion failed. An error occurred while deleting the data collector load history file history.xml. Contact your system administrator to report this error.

Parser availability directory deleted suc-cessfully.

An error occurred while deleting the parser availability directory. Contact your system administrator to report this error.

PBSA Parser cleaning failed. An error occurred while resetting the data-set. Contact your system administrator to report this error.

Data reset failed. An error occurred while resetting the data-set. Contact your system administrator to report this error.




Troubleshooting



Unable to instantiate the PBSA ToolKit. Please check your PBSWORKS_SERVER_HOME variable.




Troubleshooting



13.8 Resetting the data collector dataset

Use the pbsa-dc-data-reset command to delete the history files that indicate which PBS Professional accounting log files were previously transported to the web application. When the data collectors are restarted, all PBS Professional accounting log data will again be transported to the web application for parsing.

This command must be executed as the root user on each machine where a data collector has been deployed.

Additional steps must be performed to discard the data from the PBSA database - see Chapter 19, "Reparsing the accounting logs", on page 305.

Please stop the PBSA data collectors before issuing this command.

13.8.1 Usage

pbsa-dc-data-reset[options]

13.8.2 Examples

13.8.2.1 Resetting a data collector dataset

Executing this command deletes the history files that indicate which PBS Professional accounting log files were previously transported to the web application.

pbsa-dc-data-reset










Troubleshooting





Operation not permitted, Please run command as user ROOT.

The user does not have permissions to run this command. Please run the command as root user.

Data reset failed. An error occurred while resetting the dataset. Contact your system administrator to report this error.

Unable to instantiate the PBSA Tool-Kit. Please check your PBSWORKS_-SERVER_HOME variable.




13.9 Change the PBSA database password

Use the pbsa-data-password command to change or reset the PBSA database pass-word.

This command must be executed on the machine where the web application is deployed.

13.9.1 Usage

pbsa-data-password OLD_PASSWORD NEW_PASSWORD [options]

where:

OLD_PASSWORD is the current password

NEW_PASSWORD is the new password

The PBSA installer creates a database superuser with the following credentials:

user id: pbsworks

password: pbsworks@123







13.9.2 Examples

13.9.2.1 Resetting the PBSA database password

Executing this command changes the current password “pwd2013” to a new password “pwd-Feb2013”.

pbsa-data-password pwdJan2013 pwdFeb2013




Troubleshooting





Incorrect number of arguments. Try pbsa-data-password --help.










Error in reading the inputs. An error occurred while retrieving system arguments. Contact your system adminis-trator to report this error.

Property with key xxxxxx doesn't exists. An error occurred while reading the data-base configuration file monetdb-pbsa.conf. Contact your system admin-istrator to report this error.

File xxxxxxx must end with (.backup) An error occurred while changing the pass-word. Contact your system administrator to report this error.

File xxxxxxxx doesn't exists. An error occurred while reading the DBConnection.properties file. Contact your system administrator to report this error.

Error in reading monetdb-pbsa.conf file An error occurred while reading the data-base configuration file monetdb-pbsa.conf. Contact your system admin-istrator to report this error.

Error in splitting command: xxxxxx An error occurred while changing the pass-word. Contact your system administrator to report this error.

Error in executing command: xxxxxx An error occurred while changing the pass-word. Contact your system administrator to report this error.



Troubleshooting



Line must be (key=value). xxxxxxx There is a problem with the DBConnection.properties file. Contact your system administrator to report this error.

Updation of config file DBConnection.properties failed.

An error occurred while updating the DBConnection.properties file. Contact your system administrator to report this error.

Updation of config file datasources.xml failed.

An error occurred while updating the con-figuration file datasources.xml. Con-tact your system administrator to report this error.

Updation of config file .monetdb failed. An error occurred while updating the con-figuration file monetdb-pbsa.conf. Contact your system administrator to report this error.

Updation of config file monetdb-user.sql failed.

An error occurred while updating the file monetdb-user.sql. Contact your sys-tem administrator to report this error.

Command splitting failed: xxxxxx An error occurred while changing the pass-word. Contact your system administrator to report this error.

Server startup failed. An error occurred upon database server start up. Contact your system administrator to report this error.

Server status setting failed. An error occurred while setting the database server status. Contact your system adminis-trator to report this error.

Server status check failed. An error occurred while checking the data-base server status. Contact your system administrator to report this error.



Troubleshooting



Password change failed. An error occurred while changing the pass-word. Contact your system administrator to report this error.



Troubleshooting


Chapter 14

Log filesFor documentation purposes, the PBSA installation directory will be denoted by <INSTALL_DIR>. The installation directory for a typical installation of PBSA is:

/opt/pbsworks/12.2

The log file for the PBSA data collector is:

<INSTALL_DIR>/dc/logs/dc.log

The log file for the PBSA parser is:

<INSTALL_DIR>/portal/logs/parser.log

The error log file for the PBSA parser is:

<INSTALL_DIR>/portal/logs/parsererror.log

The log file for the PBSA database is:

<INSTALL_DIR>/portal/logs/mondrian.log

The log file for the PBSA web application is:

<INSTALL_DIR>/portal/logs/pbsworks.log

The log file for the Apache Tomcat web server is:

<INSTALL_DIR>/portal/thirdparty/apache/tomcat/logs/catalina.out


Chapter 14 Log files


Chapter 15

PBSA Measures & DimensionsPBSA supports a wide variety of fields or variables that can be analyzed and displayed via charts. These fields are divided into two categories:

• Dimensions are the independent variable (often denoted by the x-axis) whose variation does not depend on another variable. Examples are users, software, servers, and nodes. PBSA requires Dimensions be displayed on the x-axis or z-axis (in the case of a three dimensional chart).

• Measures are the dependent variable (often denoted by the y-axis) whose value changes dependent on the other variables. Examples are total numbers of jobs, average memory used, and total CPU walltime. Measures are displayed on the y-axis. The PBSA web application refers to Measures as Values.

Following is a list of Dimensions and Measures that are available with PBSA.

15.1 Dimensions

15.1.1 Account

Account represents the account to which jobs submitted by a user can be billed against. Account can also represent usage of a group of users based on their respective accounts to present a bigger picture for charging for the use of resources.

This is extracted from the account attribute of the PBS Professional accounting log.


Chapter 15 PBSA Measures & Dimensions

15.1.2 Architecture

This dimension represents the machine (hardware) architecture requested for running the job. This is used to report architecture wide usage across nodes within a cluster and to clarify what kind of architecture is most frequently requested. This information can be used to determine the cause of long job wait times due to hardware unavailability.

This is extracted from the Resource_List.arch attribute of the PBS Professional accounting log.

15.1.3 Custom Group

This is the project to which a user has been assigned. Custom groups are configured using the pbsa-config-groups command (see section 13.3, “Configuring custom groups”, on page 154). Custom groups are used when the user has been assigned to a group other than their default group that is mentioned in the PBS accounting logs. Custom group charts can be generated so that managers can bill the project to which the user is currently assigned, rather than their default group.

This is a configurable value that is extracted from the Custom Group configuration file (see section 17.3, “Custom group configuration file”, on page 229).

15.1.4 CPU Bucket Time

This dimension represents the ratio bucket in which the “Used by Requested CPU Time” ratio falls.

15.1.5 Exit Reason

This dimension represents the way the job exited from the cluster, indicating whether it was successful or unsuccessful. It can be used to track job execution failure rates and reasons for failures with respect to various dimensions like node, user, server, application, etc. Exit rea-sons are configured using the pbsa-config-exits command (see section 13.4, “Config-uring exit codes”, on page 162).

This is a configurable value that is extracted from the Exit code configuration file (see section 17.2, “Exit code configuration file”, on page 226).


PBSA Measures & Dimensions Chapter 15

15.1.6 Exit Status

This dimension represents the exit status of the job, meaning indicating the job was successful or unsuccessful. It is based on the predefined exit codes from PBS Professional. It can be used to track job execution failure rates. This could be used to create native charts based on the PBS Professional exit codes.

Exit Status is extracted from the Exit_status attribute of the PBS Professional accounting log.

15.1.7 Group

This dimension represents the Linux group (user group of the cluster) to which the user belongs. Using this dimension a chart could be created that would show how a group is utiliz-ing the cluster.

This is extracted from the group attribute of the PBS Professional accounting log.

15.1.8 Node

This dimension represents the various execution nodes that belong to the cluster. Various charts can be generated to determine node utilization.

It is extracted from the exec_host attribute of the PBS Professional accounting log.

15.1.9 Node Class

This dimension represents a configurable classification or grouping of the execution MOM. This classification could be by hardware configuration or discipline. It is based on the needs of the site (see section 3.4.1, “Nodeclass metrics - classify PBS Professional nodes”, on page 15). This dimension can be used to create a chart that would group similar type of nodes from the cluster to analyze them for different parameters like usage, downtime, etc.

This is extracted from the Node Details configuration file created during the configuration of PBSA (see section 17.5, “Node details file”, on page 243):

<INSTALL_DIR>/portal/services/pbsa/parser/modules/pbsdata/config/nodedetails_YYYY where "YYYY" is the four digit year.



15.1.10 Node Event Type

This dimension represents an event that has occurred on the node. Valid values are:

• Job Busy - state of the node when jobs were running on it

• Down – node has been taken offline

• Unused – node has not been used

This dimension is usually used as a filter for reporting purposes.

15.1.11 Place

This dimension represents the placement of the job, indicating how it used the node resources - whether it was:

• exclusive

• free

• free:shared

• none

• pack

• scatter

It is extracted from the Resource_List.place attribute of the PBS Professional accounting log.

15.1.12 Prime - Non Prime

This dimension represents whether a job is being run during prime (normal working hours) or non-prime (non-working hours) hours. Prime and non-prime time hours are configured using the pbsa-config-holidays command (see section 13.2, “Configuring holidays”, on page 143).

This is a configurable value that is extracted from the Holiday configuration file (see section 17.1, “Holiday configuration file”, on page 219).



15.1.13 Project

This dimension represents the project that the user is working on, it can be used to create proj-ect based charts for analysis of project resources such as users, nodes applications, etc.

This is extracted from the project attribute of the PBS Professional accounting log (see section 3.4.3, “Project metrics - use the qsub -P option”, on page 17).

15.1.14 Queue

This dimension defines the queue to which the job was submitted. This dimension could be used to create charts to determine the amount of jobs being submitted to a queue and for ana-lyzing queue wait times.

This is extracted from the queue attribute of the PBS Professional accounting log.

15.1.15 Server

This dimension defines the server on which the job was submitted. This dimension can be used to create server wide charts in terms of resource usage.

This is extracted from the job identifier attribute of the PBS Professional accounting log.

15.1.16 Software

This dimension defines the software or solver for which the job has been submitted. This dimension can be used to create charts in terms of resource usage categorized by software.

This is extracted from the Resource_List.software attribute of the PBS Professional accounting log.

15.1.17 Time Holiday

This dimension represents a holiday that has been configured for the site during the installa-tion and configuration of PBSA. The pbsa-config-holidays command is used to con-figure holidays (see section 13.2, “Configuring holidays”, on page 143). This dimension can be used as a filter for determining which jobs ran during a holiday period.

This is a configurable value that is extracted from the Holiday configuration file (see section 17.1, “Holiday configuration file”, on page 219).



15.1.18 User

This dimension represents the user who has submitted the job. This dimension can be used to create a resource utilization chart for a specific user.

This is the extracted from the user attribute of the PBS Professional accounting log.

15.1.19 Virtual Node

This dimension represents the various execution vnodes that belong to the cluster. This dimension could be used to create charts based on the vnodes in conjunction with other dimensions like Node Event Type that would give a picture of how the vnode was being uti-lized.

It is extracted from the exec_vnode attribute of the PBS Professional accounting log.

Ratio buckets defined for the following Dimensions are:


This dimension specifies the ratio bucket in which the “used by requested cpu time” ratio falls.

15.1.21 Memory Bucket

This dimension specifies the ratio bucket in which the “used by requested ncpus” ratio falls.

15.1.22 NCPUS Bucket

This dimension specifies the ratio bucket in which the “used by requested vmem” ratio falls.

Table 15-1: Ratio buckets

-1.0 - 0.0 0.75 - 1.0 1.75 - 2.0 3.50 - 4.0

0.0 - 0.25 1.0 - 1.25 2.0 - 2.50 4.0 - 4.50

0.25 - 0.50 1.25 - 1.50 2.50 - 3.0 4.50 - 5.0

0.50 - 0.75 1.50 - 1.75 3.0 - 3.50 >= 5.0


P 199

Chapter 15

1

T

1

T

1

T

ime sts)

Walltime Used(secs)

Walltime (secs)

Overall time

(secs)

Wait time

(secs)

6 208363 103716 145583 1024

7 92015 7662 413220 234

7 197513 117733 335343 543

307531 118031 281774 67

3 107270 75531 286388 10


PBSA Measures & Dimensions

5.1.23 Vmem Bucket Time

his dimension specifies the ratio bucket in which the “used by requested walltime” ratio falls.


his dimension specifies the ratio bucket in which the “used by requested cpu time” ratio falls.

5.2 Measures

he following sample data will be used to describe some of the values.

• Walltime = job end time (end) – job start time (start)

• Overall time = job end time (end) – job creation time (ctime)

• Wait time = job start time (start) – queue time (qtime)

Table 15-2: Sample Data

Job ID

UserCPURqst

(core)

CPU Used(core)

Mem Rqst(MB)

Mem Used(MB)

ctime qtime start endWallt

Rq(sec

1 User1 8 8 981 898 1380081644 1380122487 1380123511 1380227227 29554

2 User1 14 10 390 429 1380254444 1380659768 1380660002 1380667664 14692

3 User3 4 4 610 491 1380272430 1380489497 1380490040 1380607773 12855

4 User3 12 10 850 686 1380387630 1380551306 1380551373 1380669404 92866

5 User5 6 6 636 381 1380510030 1380720877 1380720887 1380796418 11170


15.2.1 Average CPU Requested

This measure represents the average number of CPUs requested by a job to run. It can be used to create charts showing trends for the CPU being requested by users, nodes, applications, etc.

Referring to Table 15-2, “Sample Data,” on page 199:

For jobs submitted by User1, the average CPU requested is 11.

It is calculated as the average of the Resource_List.ncpus attribute of the PBS Professional accounting log.

15.2.2 Average CPU Used

This measure represents the average CPU that is used by running jobs. It can be used to create charts showing trends for the CPU being used by users, nodes, applications, etc.


For jobs submitted by User1, the average CPU used is 9.

It is calculated as the average of the resource_used.ncpus attribute of the PBS Professional accounting log.

15.2.3 Average Memory Requested

This measure represents the average memory that is requested by a job to run. It can be used to create charts showing trends for the memory being requested by users, nodes, applications, etc.


For jobs submitted by User3, the average memory requested is 730 KB

It is calculated as the average of Resource_List.mem attribute of the PBS Professional accounting log.



15.2.4 Average Memory Used

This measure represents the average memory that is used by running jobs. It can be used to create charts showing trends for the memory being used by users, nodes, applications, etc.


For jobs submitted by User3, the average memory used is 588.5 KB

It is calculated as the average of the resource_used.mem attribute of the PBS Professional accounting log.

15.2.5 Average Memory Walltime Requested

This measure represents the average memory walltime requested. It indicates the amount of memory being requested during the time the job is running.

(Average Memory Walltime Requested = Total Memory Walltime Requested/ Total Number of jobs)

It can be used to create reports representing the trend for the memory walltime being requested by users, applications, etc.


For jobs submitted by User1, the average memory walltime requested is calculated as:

[Total of (Memory Requested*Walltime Requested)]/Total Number of Jobs = [981*295546+390*146927]/2 = 173616078 seconds.

15.2.6 Average Memory Walltime Used

This measure represents the average memory walltime used. It indicates the amount of mem-ory being used during the time the job is running.

(Average Memory Walltime Used = Total Memory Walltime Used/Total Number of jobs). It can be used to create reports representing the trend for memory walltime being used by users, nodes, applications, etc.


For jobs submitted by User1, the average memory walltime used is calculated as :

[Total of (Memory Used * Walltime)]/Total Number of Jobs =

[898* 103716 + 429 *7662]/2 = (93136968+3286998)/2 = 48211983 seconds.



15.2.7 Average Overall Time

This measure is the average time that is used by the jobs on the cluster. This can be used to create charts for analyzing the overall time being used on average by a user, group, nodes, etc.


For jobs submitted by User1, the average overall time is 279401.5 seconds. This indicates that the jobs submitted by User1 existed on the cluster for 279401.5 seconds.

15.2.8 Average Wait Time

This measure is the average time the job had to wait before running. It can be used to create charts for analyzing the average wait time for the user, group, queue, etc.


For jobs submitted by User3, the average wait time is 305 seconds. This indicates that the jobs submitted by User5 had to wait for 305 seconds before they could obtain all resources for running.

15.2.9 Average Walltime Requested

This measure represents the average walltime that is requested by a job to run. It can be used to create charts showing trends for the walltime being requested by users, nodes, applications, etc.


For jobs submitted by User3, the average walltime requested is calculated as an average of Resource_List.walltime = 110711.5 seconds.

This indicates that the user has requested 110711.5 seconds for the jobs that were submitted.

15.2.10 Average Walltime Used

This measure represents the average walltime that is used by a running job. It can be used to create charts showing trends for the walltime being used by users, nodes, applications,etc.


For jobs submitted by User3, the average walltime used is calculated as the average of the resource_used.walltime = 252522 seconds.

This indicates that the user has used 252522 seconds for the jobs that were submitted.



15.2.11 Total CPU Requested

This measure represents the total number of CPUs that are requested by a running job. It can be used to create charts representing the trend for CPUs being requested by users, nodes, applications, etc.


For jobs submitted by User1, the total CPU requested is 22.

15.2.12 Total CPU Used

This measure represents the total CPU that is used by a running job. It can be used to create charts representing the trend for CPUs being used by users, nodes, applications, etc.


For jobs submitted by User1, the total CPU used is 18.

15.2.13 Total CPU Walltime

This measure represents the amount of CPU time that a job has used. It is different from the actual CPU time consumption (cput). For example, if a job has used 2 CPUs for 5 minutes and post processing took another 2 minutes than Total CPU Walltime would be 14 (2*7).


For jobs submitted by User5, the total CPU walltime is calculated as:

Total of [(CPU Used) * (Walltime)] = 6 X 75531 = 453186 seconds.

This indicates that the user has used 6 CPUs for 75531 seconds.

15.2.14 Total Green CPU Walltime

This measure represents the amount of time for which the CPU was not being used at all. It can be used to create charts representing the least used CPU from the cluster. This measure can also be used to determine energy savings that can be realized by switching off unused CPUs (refer to the PBS Professional Green Provisioning Toolkit).

If a node is not being used during prime time hours for a particular day than “Green walltime” will be 8 hours (assuming prime time is set to 8 hours).



15.2.15 Total Memory Requested

This measure represents the total memory that is requested by a job prior to running. It can be used to create charts representing the trend for the memory being requested by users, nodes, applications, etc.


For jobs submitted by User3, the total memory requested is 1460 KB.

15.2.16 Total Memory Used

This measure represents the total memory that is used by a running job. It can be used to cre-ate charts representing the trend for the memory being used by users, nodes, applications, etc.


For jobs submitted by User3, the total memory used is 1177 KB.

15.2.17 Total Memory Walltime Requested

This measure represents the total memory walltime, the amount of memory being used for the time unit, that is requested by a job prior to running. It can be used to create reports showing trends for the memory walltime being requested by users, nodes, applications, etc.


For jobs submitted by User1, the total memory walltime requested is calculated as:

Total of [(Memory Requested) * (Walltime Requested)] = [981*295546+390*146927]= 347232156 seconds.

15.2.18 Total Memory Walltime Used

This measure represents the total memory walltime, the amount of memory being used for the time unit, that is used by a running job. It can be used to create reports showing trends for the memory walltime being used by users, nodes, applications, etc.


For jobs submitted by User1., the total memory walltime used is calculated as:

Total of [(Memory Used) * (Walltime)] = [898*103716 + 429*7662]= 96423966 seconds.



15.2.19 Total Node Walltime

This measure represents the amount of time that a job has used the node in a day. The calcu-lation of this dimension is based on the value of “place”:

• If place is exclusive, then the node is not sharable.

• If place is anything other than exclusive, then CPU WallTime and Node Walltime are the same.

Example 1

A node has 5 CPUs. A single job is submitted, the job is not exclusive, and the job runs for 3 hrs on 2 CPUs. Total Node Walltime will be calculated as follows:

Total Node Walltime = 3 * 2 = 6 hrs

Unused Node Walltime = (Total available CPUs * 24 hrs) – Total Node Walltime

Unused Node Walltime= (5 * 24) - 3 * 2 = 120 - 6 = 114 hrs

Example 2

A node has 5 CPUs. A single job is submitted on a node that is exclusive, and the job runs for 3 hrs on 2 CPUs. Total Node Walltime will be calculated as follows:

Total Node WallTime = 3 * 5 = 15 hrs

Unused Node Walltime = (Total available CPUs * 24 hrs) – Total Node Walltime

Unused Node Walltime = (5 * 24) - 3 * 5 = 120 - 15 = 105 hrs

This measure can be used to create charts representing the node usage by users and groups. It can also be used to analyze the amount of time a node was unused.

15.2.20 Total Number of Jobs

This measure represents the total number of jobs that existed on the cluster at a given point of time. It can be used to analyze jobs based on various parameters like exit reason, application, queue, etc.

15.2.21 Total Number of Queued Cores

This measure represents the number of cores which are requested by jobs that are in a queued state on the cluster at a given point of time. It can be used to create charts for analysis of job wait times due to core availability.


For jobs submitted by User5, the total cores that were queued was 6.



15.2.22 Total Overall Time

This measure represents the total time a job existed on the cluster from its creation until the job exits. It can be used to create charts for analyzing time factor with respect to users, nodes, queues, etc.


For jobs submitted by User1, the total overall time is 558803 seconds. This indicates that the jobs submitted by User1 existed on the cluster for 558803 seconds.

15.2.23 Total Wait Time

This measure represent the total time the job waited before it started running. It can be used to create charts for analyzing wait time with respect to users, server, queues, etc.


For jobs submitted by User3. the total wait time is 610 seconds. This indicates that the jobs submitted by User5 had to wait for 610 seconds before they could obtain all the necessary resources for running.

15.2.24 Total Walltime Requested

This measure represents the total walltime that is requested by a job prior to running. It can be used to create charts representing the trend for walltime being requested by users, nodes, applications, etc.


For jobs submitted by User3, the total walltime requested is calculated as a total of Resource_List.walltime = 221423 seconds.

This indicates that the user has requested 221423 seconds for the jobs that were submitted.



15.2.25 Total Walltime Used

This measure represents the amount of time that a job was in a running state, including the time it took to exit. It can be used to create charts showing the most time consuming jobs, node, users, etc. It can also be used for analyzing resources that were locked (reserved) while running the job.


For jobs submitted by User3, the total walltime used is calculated as a total of resource_used.walltime = 505044 seconds.

This indicates that the user has requested 505044 seconds for the jobs that were submitted.

15.2.26 Unique Users

This measure represents the unique users that have submitted jobs on a cluster. It can be used to create charts analyzing user utilization of the cluster.


Chapter 16

Troubleshooting

16.1 Troubleshooting PBSA

16.1.1 Troubleshooting the installation of PBSA

16.1.1.1 Installer did not complete as expected

If the installer does not complete the installation as expected, please perform the steps below:

1. Remove the following file that is created by InstallAnywhere at the time of installa-tion:

/var/.com.zerog.registry.xml

2. Rerun the installer.

3. If the installer is still unable to complete normally, please contact the PBSA support team.


Chapter 16 Troubleshooting

16.1.1.2 PBSA is not accessible from a different machine

I have installed PBS Analytics and it is up and running. However, it is not accessible from a different machine. What could be wrong?

Check for following :

• Are all the ports used by PBSA open and accessible?

Or

• Stop the iptable by using below command:

/etc/init.d/iptables stop

16.1.1.3 PBSA services user does not exist

I was installing PBSA and the following error message was displayed:

During installation, PBSA requests a userid under which all PBSA services will run. The use-rid that was specified does not exist on the server where PBSA is being installed. Re-enter a userid that is a pre-existing and preferably non-privileged user on the server where PBSA is being installed.

16.1.1.4 Determining the installation location of PBSA

Web application and parser

The installation location of the web application and parser is stored in the following file on the machine where the web application and parser are installed:

/etc/pbsworks-pbsa.conf

Data collector

The installation location of the data collector is stored in the following file on the machine where the data collector is installed:

/etc/pbsworks-dc.conf

Specified username does not exist.

The specified user to register the PBSA services does not exist. Kindly enter a

different user name that exists on the machine.

Please choose "OK" to go back and enter a different user name or choose

"Cancel" to cancel and exit installation.


Troubleshooting Chapter 16

16.1.2 Troubleshooting the PBSA service user

16.1.2.1 PBSA service user does not exist


During installation, PBSA requests a userid under which all PBSA services will run. The use-rid that was specified does not exist on the server where PBSA is being installed. Re-enter a userid that is a pre-existing and preferably non-privileged user on the server where PBSA is being installed.

16.1.2.2 PBSA service user is blank


During installation, PBSA requests a userid under which all PBSA services will run. The use-rid that was specified is blank. Re-enter a valid userid that is a pre-existing and preferably non-privileged user on the server where PBSA is being installed.

Specified username does not exist.

The specified user to register the PBSA services does not exist. Kindly enter a

different user name that exists on the machine.

Please choose "OK" to go back and enter a different user name or choose


PBSA Service username cannot be blank.

The PBSA service user name cannot be blank. Kindly enter a valid user name that

exists on the machine for registering the PBSA services.

Please choose "OK" to go back and enter a valid user name or choose




16.1.3 Troubleshooting the PBSA license server

16.1.3.1 License server not provided at installation

I was installing PBSA and a message similar to the following warning was displayed:

It is not mandatory to provide the license server at installation time. Once PBSA is installed, you will need to configure the license server prior to starting the PBSA web application (see section 18.3.1, “Initial license server configuration”, on page 277). If the PBSA web applica-tion is started prior to configuring the license server, the web application will not be accessi-ble due to a failure to check out the appropriate licenses (see section 16.1.5.1, “Failed to check-out license”, on page 214). Once the web application server is started, configuration of the license server requires a slightly different process - see section 18.3.2, “Configuring the license server after starting PBSA”, on page 279.

16.1.4 Troubleshooting the web application

16.1.4.1 Tomcat failed to start during installation of PBSA

I was installing PBSA and the following error occurred when I tried to start the PBSA ser-vices:

LIcense server information not provided

The license server information has not been supplied. You can continue by

clicking "OK" and provide the license server information later in the

/opt/pbsworks/12.2/portal/binaries/framework/data/factorySettings.xml file.

Please click "OK" to continue without providing the information OR click "Back"

to go back and provide the information OR click "Cancel" to exit installation

Tomcat Failed to start

----------------------

Tomcat installation might have failed.



Check the Apache Tomcat log file (<INSTALL_DIR>/portal/thirdparty/apache/tom-cat/logs/catalina.out). If the following error message exists in the log file, then there is not enough memory for the Java Virtual Machine.

Please review the minimum hardware requirements necessary for PBSA, and make adjust-ments as necessary (see section 1.1, “System Requirements”, on page 2).

Otherwise, check all log files for error messages (see Chapter 14, "Log files", on page 191) and contact system support.

16.1.4.2 Tomcat failed to start

I was trying to start/restart PBSA and the following error occurred :

Check the Apache Tomcat log file (see “The log file for the Apache Tomcat web server is:” on page 191). If the following error message exists in the log file, then there is not enough mem-ory for the Java Virtual Machine.

Please review the minimum hardware requirements necessary for PBSA, and make adjust-ments as necessary (see section 1.1, “System Requirements”, on page 2).


Error occurred during initialization of VM

Could not reserve enough space for object heap

Could not create the Java virtual machine.

PBSWorks Login server startup failed. Please check your installation.

Error occurred during initialization of VM

Could not reserve enough space for object heap

Could not create the Java virtual machine.



16.1.5 Troubleshooting logging into PBSA

16.1.5.1 Failed to check-out license

I was logging into PBSA and the following error occurred :

This message may be caused by two issues. First, the maximum number of licenses for PBSA is currently in use. The system administrator can query the license server for license usage to determine who has licenses checked out. Secondly, an invalid license server may have been provided during installation, or when the license server was configured post-installation. Please see section 18.3.2, “Configuring the license server after starting PBSA”, on page 279 to validate the license server and modify it if necessary.


16.1.5.2 Invalid userid or password

I was logging into PBSA and the following error occurred :

This message may be caused due to an invalid SSH server being provided during installation. Please see section 18.5, “Configuring SSH Authentication”, on page 283 to validate the SSH server and modify it if necessary.


16.1.5.3 PBSA is running but not accessible from a different machine

I have installed PBS Analytics and it is up and running. However, it is not accessible from a different machine. What could be wrong?

Check the following :

• Are all the ports used by PBSA open and accessible?

Failed to check-out license

Incorrect Username or Password



Or

• Stop the iptable by using below command:

/etc/init.d/iptables stop

16.1.6 Troubleshooting the data collector

16.1.6.1 Data collector is not collecting the accounting logs

I installed PBSA and started the data collectors. The data collector is not collecting the PBS Professional accounting logs. What is wrong?

Check the PBSA data collector log (see Chapter 14, "Log files", on page 191) for any error messages.

The following message indicates that the location of the PBS Professional accounting logs does not exist.

An invalid location may have been provided during installation of PBSA. Please see section 18.6, “Changing the accounting log location”, on page 284 to validate the location of the PBS Professional accounting logs and make modifications if necessary.

These messages indicate that the PBSA data collector was unable to establish communication with the PBSA web application.

The web application must be started prior to starting the data collector. If the web application has not been started, then:

• start the web application

• restart the data collector

DEBUG, 19 Mar 13 10:55:00,019 -{AccountingLogCollector.java: 51} - Specified Log Directory doesn't exist. path_to_acct_logs

ERROR, 25 Mar 13 09:34:29,471 -{DefaultCommService.java: 38} - register request encountered a problem.

Caused by: java.net.ConnectException: Connection refused

DEBUG, 25 Mar 13 09:34:29,473 -{DataCollectorController.java: 169} - Not able to register with server.



If after starting the web application this error persists, then an invalid port number may have been provided for the PBSA web application during installation of the data collector. Please see section 18.7, “Changing web application hostname:port”, on page 284 to verify the PBSA web application port and make modifications if necessary.

These messages indicate that the PBSA data collector tried to establish communication with the PBSA web application, but was unable due to an invalid hostname.

An invalid hostname may have been provided for the PBSA web application during installa-tion of the data collector. Please see section 18.7, “Changing web application hostname:port”, on page 284 to verify the PBSA web application hostname and modify it if necessary.


ERROR, 25 Mar 13 09:34:29,471 -{DefaultCommService.java: 38} - register request encountered a problem.

Caused by: java.net.UnknownHostException: invalidhostname

DEBUG, 25 Mar 13 09:34:29,473 -{DataCollectorController.java: 169} - Not able to register with server.



These messages indicate that the web application port (typically 9000) has not been opened for incoming TCP traffic so that the web application and the data collectors can communicate. This error will be seen in the data collector log file when the data collector attempts to trans-port the accounting log information to the web application:

To correct this problem, open the web application port for TCP traffic.

16.1.7 Troubleshooting licensing

16.1.7.1 Licensing record count has been exceeded

I get the following message when accessing chart information through the PBSA web applica-tion.

ERROR, 11 Sep 13 01:48:25,332 -{DataTransportManager.java: 91} - Not able to send file 20110503

com.altair.pbsworks.dc.framework.DCException: File Transport proxy encountered a problem while processign request.


at com.altair.pbsworks.dc.transport.DataTransportManager.transportFile(DataTrans-portManager.java:83)

at com.altair.pbsworks.dc.transport.DataTransportManager.doWork(DataTransportMan-ager.java:73)

at com.altair.pbsworks.dc.framework.AbstractWorker.run(AbstractWorker.java:79)

at java.lang.Thread.run(Thread.java:662)

Caused by: java.io.IOException: Server returned HTTP response code: 500 for URL: http://192.168.33.244:9000/parser/upload

at sun.net.www.protocol.http.HttpURLConnection.getInputStream(HttpURLConnec-tion.java:1436)


... 4 more

Accounting log license record count has exceeded the installed licensing schema. Contact your PBSA system administrator to upgrade the licensing schema. Only data permitted by the active licensing schema will be displayed. The permitted time range is from YYYY-MM_DD

to YYYY-MM-DD.



The PBS Professional accounting log license record count has exceeded the current licensing schema. The PBSA web application will only display the most recent data based on the licensing schema. To ensure access to all parsed data, upgrade the licensing schema - see sec-tion 18.9, “Changing the license schema”, on page 289.


Chapter 17

PBSA configuration filesConfiguration information for PBSA is stored in a set of files. These files are located on the machine where the PBSA web application and parser are deployed, in the directory:


All configuration files, with the exception of the custom resource configuration file, are nec-essary for parsing of the PBS accounting logs and should NOT be deleted.

Comments (lines denoted by a “#” at the beginning of the line) in configuration files are man-datory and should not be removed.

17.1 Holiday configuration file

The holiday schedule and prime (normal working hours) and non-prime (non-working hours) hours, are maintained by year in the file:

holiday_YYYY.conf

where "YYYY" is the four digit year.

The pbsa-config-holidays command (see section 13.2, “Configuring holidays”, on page 143) can be used to add information to this file.

PBSA is configured by default for three years (2011 to 2013) with the single holiday of New Year's day.

Modifications to any of the holiday configuration files, including the current year's holiday file, requires reparsing of the accounting logs.


Chapter 17 PBSA configuration files

17.1.1 Defining a holiday

The following information is necessary to define a holiday and must be separated by a tab character. The holiday information must be stored below the prime and non-prime time infor-mation:

• The date of the holiday in YYYY-MM-DD format

• Holiday identifier or the name of the holiday

• Number of days the holiday will be celebrated

17.1.1.1 Holiday layout

Table 17-1: Holiday record layout

Column Name Description Data TypeValid

ValuesMandatory/Optional

date(yyyy-mm-dd) The beginning date of the holiday

Date

YYYY-MM-DD

Date must be within range of January 1st and December 31st of the year for which you are defining holidays

Mandatory

holiday_type Holiday identifier or the name of the holiday

String Only restriction is the use of the backslash (\) character.

Mandatory

number_of_days Number of days the holiday will be celebrated

Integer Must be greater than or equal to 1

Mandatory


PBSA configuration files Chapter 17

17.1.1.2 Default holiday configuration data

Default holiday configuration file for 2011:



17.1.1.3 Sample holiday data

Here is a sample of holiday data for the year 2012 stored in the file holiday_2012.conf.

### CONFIGURE HOLIDAYS ###

#DATE(yyyy-mm-dd) HOLIDAY_TYPE NUMBER_OF_DAYS2011-01-01 New Years Day 1






#DATE(yyyy-mm-dd) HOLIDAY_TYPE NUMBER_OF_DAYS2012-01-01 New Years Day 12012-01-16 Martin Luther King Day 12012-04-06 Good Friday 12012-05-28 Memorial Day 12012-07-04 Independence Day 12012-09-03 Labor Day 12012-11-22 Thanksgiving 22012-12-25 Christmas Day 42012-12-31 New Years Eve 1



17.1.2 Defining prime and non-prime hours

The following information is necessary to define prime time (normal working hours) and non-primetime (non-working) hours to PBSA. The data must be separated by a tab character and must be stored above the holiday information:

• The day of the week

• Start time of the primetime hours

• Start time of the non-primetime hours

PBSA is configured by default for the years 2011 through 2013. For Monday through Friday, prime times hours begin at 09:00 am, and non-prime time hours begin at 5:30 pm. For Satur-day and Sunday, the entire day is scheduled as non-prime time.

To ensure the PBSA charts and dashboards report accurate statis-tics, both prime time and non-prime time must be defined for every day of the week.


P 223

Chapter 17

1

t

sMandatory/

Optional

ours for weekdays e not been specified

onday - Friday has ied.

Mandatory

ours for Monday

ours for Tuesday

ours for Wednesday

ours for Thursday

ours for Friday

ours for Saturday

ours for Sunday

ours for Saturday &


PBSA configuration files

7.1.2.1 Prime and non-prime time hours record layout

Table 17-2: Prime/non-prime time record layou

Column NameColumn

DescriptionData Type Valid Value

day day of week String weekdays prime/non-prime h(Mon-Fri) that havseparately.

Cannot be used if Malready been specif

monday prime/non-prime h

tuesday prime/non-prime h

wednesday prime/non-prime h

thursday prime/non-prime h

friday prime/non-prime h

saturday prime/non-prime h

sunday prime/non-prime h

weekends prime/non-prime hSunday

C


urs start Mandatory

dered non-primetime

rs should be set to

dered primetime for

rs should be set to

e hours start Mandatory

dered primetime for

ould be set to"all".

dered non-primetime

ould be set to

t

sMandatory/

Optional

hapter 17 PBSA configuration files

24 PB

primetime start Start time of prime hours

Time

format=MM:SS

MM:SS Time prime time ho

none All hours are consifor the day.

Non-primetime hou"all”.

all All hours are consithe day.

Non-primetime hou"none".

non-primetime start Start time of non-prime hours

Time

format=MM:SS

MM:SS Time non-prime tim

none All hours are consithe day.

Primetime hours sh

all All hours are consifor the day.

Primetime hours sh"none".

Table 17-2: Prime/non-prime time record layou

Column NameColumn

DescriptionData Type Valid Value


17.1.2.2 Default prime and non-prime configuration data

Default prime/non-prime time configuration file for 2011: .



17.1.2.3 Sample prime and non-prime hours data

Here is a sample of prime and non-prime time hours for the year 2012 stored in the file hol-iday_2012.conf.

### CONFIGURE PRIME TIME AND NON PRIME TIME ###

#DAY PRIMETIME_START NON-PRIMETIME_STARTweekdays 09:00 17:30saturday none allsunday none all






#DAY PRIMETIME_START NON-PRIMETIME_STARTmonday 08:30 17:00weekdays 09:00 17:30saturday all nonesunday none all



17.2 Exit code configuration file

In order to track job execution failure rates and reasons for failures, exit code information must be configured for PBSA. The file

exit_status.conf

maps the reason descriptions to exit codes.

The pbsa-config-exits command (see section 13.4, “Configuring exit codes”, on page 162) can be used to add information to this file.


• Successful - 0


17.2.1 Defining exit codes

The following information is necessary to map reasons to exit codes and must be separated by a tab character:

• A description that is mapped to exit codes

• Application or solver name which allows exit codes to be categorized by solver

• Exit codes or range of exit codes

Modifications to the exit_status.conf file requires reparsing of the accounting logs.

The default exit code,“Still-Running” must not be removed from the exit code configuration file


P 227

Chapter 17

1

Mandatory/Optional

: "User delete" Mandatory

to map any exit ountered in the g logs that are not apped in this file n.

all applications Mandatory

: PBSJobApp

: 271 Mandatory

: 1-4

: 1,5,500



7.2.2 Exit code layout

Table 17-3: Exit code record layout

Column Name

Column Description

Data Type Valid Values

REASON A description that will be mapped to exit codes

String A string of characters specified within double quotes. Single quotes (') are not allowed.

Example

Unspecified Use this codes encaccountindirectly mto a reaso

APPLICATION Categorizes the exit codes by application or solver

String All Denotes

Application Name Example

EXIT_STATUS Exit codes to be mapped to the reason/application

String A single exit code Example

Range of exit codes Example

List of comma separated exit codes

Example

C


1

D

1

H

30,31,32,33,34,35,36,37,38,39,40,68,69,70,71,72,73,74,75,76,77,7104,105,106,107,108,109,110,111,32,133,134,135,136,137,138,139,10,161,162,163,164,165,166,167,16,189,190,191,192,193,194,195,196217,218,219,220,221,222,223,224,45,246,247,248,249,250,251,252,2


28 PB

7.2.3 Default exit code configuration data

efault exit code configuration file: .

7.2.4 Sample exit code data

ere is a sample of a possible exit code mapping stored in the exit_status.conf file:

#REASON APPLICATION EXIT_STATUS# Private Setting"Still Running" All Still-Running# End Private Setting"Successful" All 0-1,-2,-3,-4,-5,-6,-7,-8,-9,-10,-11,-12,-13,-14,-15,-16,-17,-18,-19,-20,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,,41,42,43,44,45,46,47,48,49,50,51,52,53,54,55,56,57,58,59,60,61,62,63,64,65,66,678,79,80,81,82,83,84,85,86,87,88,89,90,91,92,93,94,95,96,97,98,99,100,101,102,103,112,113,114,115,116,117,118,119,120,121,122,123,124,125,126,127,128,129,130,131,140,141,142,143,144,145,146,147,148,149,150,151,152,153,154,155,156,157,158,159,168,169,170,171,172,173,174,175,176,177,178,179,180,181,182,183,184,185,186,187,188,197,198,199,200,201,202,203,204,205,206,207,208,209,210,211,212,213,214,215,216,225,226,227,228,229,230,231,232,233,234,235,236,237,238,239,240,241,242,243,244,253,254,255,256,257,258,259,260,261,262,263,264,265,266,267,268,269,270,271

#REASON APPLICATION EXIT_STATUS# Private Setting"Still Running" All Still-Running# End Private Setting"User delete" All 271"Successful" All 0"PBSJobApp unsuccessful" PBSJobApp 1,5,10027"Unsuccessful" All 1-4,303,500"Unspecified" All 16024


17.3 Custom group configuration file

Users can be assigned to specific custom groups (i.e., projects) by year using the file

custom_group_YYYY.conf


The pbsa-config-groups command (see section 13.3, “Configuring custom groups”, on page 154) can be used to add information to this file.

17.3.1 Defining custom group assignments

The following information is necessary to assign a user to a custom group. The data must be separated by a tab character:

• User login id

• Custom group (project) the user is assigned to

• Date on which the user began working on the project

• Date on which the user stopped working on the project

• User’s default custom group - this is used when the user is assigned to multiple projects

The custom group “OTHERS” should NOT be removed from the custom group configuration file.


C


1

aluesMandatory/Optional

ple: asmith Mandatory

ple: WINDTUNNEL Mandatory

of January 1st and for which you are

Mandatory

must be within range uary 1st and

mber 31st of the year hich you are assigning to groups

must be greater than or to the FROM_DATE

Mandatory

ifies that user is ntly working in this


30 PB

7.3.2 Custom group record layout

Table 17-4: Custom group record layout

Column NameColumn

DescriptionData Type Valid V

USER User login id. String Alphanumeric Exam

CUSTOM_GROUP Project that user is assigned to.

String Alphanumeric Exam

FROM_DATE Date user began working on project

Date

format=YYYY-MM-DD

Date must be within rangeDecember 31st of the yearassigning users to groups.

TO_DATE Assignment complete date.

Date

format=YYYY-MM-DD

YYYY-MM-DD Date of JanDecefor wusers

Date equal

now Speccurregroup

P 231

Chapter 17

’s default project - used a user is assigned to ple projects. ation will be tracked st the default project if roject is not designated the job is submitted -P option).

Optional




DEFAULT User’s default project - used when a user is assigned to multiple work projects.

Boolean true UserwhenmultiUtilizagainthe pwhen(qsub

Table 17-4: Custom group record layout

Column NameColumn

DescriptionData Type Valid V


17.3.3 Default custom group configuration data

Default custom group configuration file for 2011: .



# PBSA Custom Group configuration file###History:#USER CUSTOM_GROUP FROM_DATE TO_DATE DEFAULTsystem OTHERS 2011-01-01 2011-12-31





17.3.4 Sample custom group data

Here is a sample of possible custom group definitions stored in the custom_group_2013.conf file:

## PBSA Custom Group configuration file###History:#USER CUSTOM_GROUP FROM_DATE TO_DATE DEFAULT# Private Settingsystem OTHERS 2013-01-01 2013-12-31#End of Private Settingsystem OTHERS 2013-01-01 nowasmith PDD1 2013-01-01 2013-06-01 trueasmith SYS1 2013-01-01 2013-09-01 bnelson SYS1 2013-01-01 nowfrichards QA 2013-01-01 nowgcorning PDD1 2013-01-01 nowbnelson QA 2013-01-01 nowdbarrett PDD1 2013-01-01 2013-05-31dbarrett SYS1 2013-06-01 2013-12-31escott PDD1 2013-01-01 2013-03-31escott PDD1 2013-09-01 2013-12-31



17.3.5 Situations that require editing the Custom Group Configuration file

There are several situations that require editing the Custom Group configuration file:

• When a user is assigned to the same project more than once in a year.

For example, the user “escott” is assigned to the project “PDD1” from January - March 2013, and then again from September - December 2013.

• Defining a default group for a user.

A default group is designated for a user so that PBSA can track utilization when a user is assigned to multiple projects during the same time period, and a job is submitted without designating the project (using the qsub -P option). To set a default group for a user the custom group configuration file must be manually edited.

For example, “asmith” is assigned to the projects “PDD1” and “SYS1” during the same time period as designated below. “PDD1” is designated as the “default” project with the addition of “true” in the DEFAULT column. If “asmith” submits a job without designat-ing the project, then PBSA will track the job’s utilization against “PDD1”, since it is des-ignated as the “default” project.

#USER CUSTOM_GROUP FROM_DATE TO_DATE DEFAULTescott PDD1 2013-01-01 2013-03-31escott PDD1 2013-09-01 2013-12-31

#USER CUSTOM_GROUP FROM_DATE TO_DATE DEFAULTasmith PDD1 2013-01-01 2013-06-01 trueasmith SYS1 2013-01-01 2013-06-01



17.3.6 Tracking utilization using custom groups

When a user submits a job, PBSA will use the custom group mapping file to determine the group under which the utilization will be tracked.

• User "gcorning" submits a job.

PBSA will track the usage against the group "PDD1" because "gcorning" has only been assigned to that group.

• User "dbarrett" submits a job in March 2013.

PBSA will track the usage against the group "PDD1", because "dbarrett" worked for that group from January through May of 2013.

• User "asmith" submits a job in April 2013.

PBSA will track the usage against the group "PDD1", even though "asmith" worked for both the "PDD1" and "SYS1" groups at that time. PBSA will attribute the usage to that group because it has been denoted as the default.

• User "asmith" submits a job in September 2012.

PBSA will track the usage under the group "SYS1", because "asmith" was only assigned to that group at that time.:

# PBSA Custom Group configuration file##USER CUSTOM_GROUP FROM_DATE TO_DATE DEFAULT# Private Settingsystem OTHERS 2013-01-01 2013-12-31#End of Private Settingsystem OTHERS 2013-01-01 nowasmith PDD1 2013-01-01 2013-06-01 trueasmith SYS1 2013-01-01 2013-09-01 bnelson SYS1 2013-01-01 nowfrichards QA 2013-01-01 nowgcorning PDD1 2013-01-01 nowbnelson QA 2013-01-01 nowdbarrett PDD1 2013-01-01 2013-05-31dbarrett SYS1 2013-06-01 2013-12-31escott PDD1 2013-01-01 2013-03-31escott PDD1 2013-09-01 2013-12-31



17.3.7 Updating the custom group configuration file

Modifications to the current year's file should only be done in two situations and do not require any reparsing of accounting logs.

1. A user is assigned to a new project and begins working for a a new group.

In this instance a new record is added to the custom_group_YYYY.conf file having FROM_DATE equal to today's date or later. The TO_DATE can be set to a future date or "now".

2. A user completes an assignment and is no longer reporting to a particular group.

In this instance, the TO_DATE of the existing record for that custom group assign-ment should be updated to their assignment completion date.

Otherwise, if this file needs to be modified for any other reasons, or if a previous year's file needs to be modified, then accounting logs will need to be reparsed.



17.4 Custom resource configuration file

Support for custom resources requires configuration of a custom resource file called:

customresources.conf

An entry must be placed in this file to track utilization for any PBS Professional custom resources. All custom resources specified in this configuration file are exposed as dimensions or values in the database with SUM as the aggregate. The location of this file is:

<INSTALL_DIR>/portal/config

17.4.1 Defining custom resources

This information is required to configure custom resources and is separated by a tab character:

• Type of custom resource: either a dimension or a measure.

• Name of the attribute under which the custom resource will be logged in the PBS accounting log file.

• Name of the custom resource as seen on charts generated by PBSA

• The default value of the custom resource when it is not present in the accounting log file.

• Database column name

Valid values: custom_resource_[1-25]

• Data type of the custom resource -

Only “Integer” is currently supported

• Fully qualified class name which will be used for conversion -

- “com.altair.pbsworks.parser.exporter.event.base.derived.CustomLongResourceWall-timeConverter" - This class multiplies the custom resource value with the walltime of the job. Unused resource walltime will also be calculated for the custom resource.

- “com.altair.pbsworks.parser.exporter.event.base.derived.ScratchSpaceDerivation" - provides a value three (3) time the memory used (3 * resources_used.mem)

- “com.altair.pbsworks.parser.exporter.event.base.derived.CustomResourceSameVal-

Modifications to the custom resource configuration file require reparsing of the accounting



ueDerivation" - returns that value as is, without performing any calculations on it.

• Format of measure.

• Foreign key value as specified in the dim_type column of the dimension table

- Only valid for a custom resource that is a dimension.


P 239

Chapter 17

1

Mandatory/Optional

esource is a measure Mandatory

esource is a n

the site's accounting Mandatory

n spaces. Mandatory



7.4.2 Custom resources record layout

Table 17-5: Custom resource record layout

Column NameColumn

DescriptionData Type

Valid Values

type Type of custom resource

String MeasureType Custom r

DimensionType Custom rdimensio

accounting_attribute_name Name of the attribute under which the custom resource will be logged in the PBS accounting logs.

String Valid accounting_attribute_name from logs.

display_name Name of the custom resource as seen on charts generated by PBSA.

String Alphanumeric string which may contai

C


75808 to Mandatory

source_25 Mandatory

atype currently d

Mandatory

Mandatory/Optional


40 PB

default_value The default value of the custom resource when it is not present in the accounting log file.

Integer Integer ranging from -92233720368547

9223372036854775807

dbcolumn_name Database column name

String custom_resource_1 through custom_re

datatype Data type of the custom resource

String Integer Only datsupporte


Column NameColumn


Valid Values

P 241

Chapter 17

er or Long values. on of this custom is done by ing the value of the esource by walltime

Optional

le values. Provides a ee (3) times the used urces_used.mem)

er or Long values. that value as is, erforming any

ons on it.

n indicates that no on is necessary. The the custom resource serted into the

as is

list of valid rclass values from ir Account Executive h Altair's Professional .

Mandatory/Optional



calculator_class Fully qualified class name which will be used for conversion

String com.altair.pbsworks.parser.exporter.event.base.derived.CustomLongResourceWalltimeConverter

For IntegConversiresourcemultiplycustom r

com.altair.pbsworks.parser.exporter.event.base.derived.ScratchSpaceDerivation

For Doubvalue thrmemory (3 * reso

com.altair.pbsworks.parser.exporter.event.base.derived.CustomResourceSameValueDerivation

For IntegReturns without pcalculati

(-) A hypheconversivalue of will be indatabase

Other conversion classes Obtain aconverteyour Altaor througServices


Column NameColumn


Valid Values

C


1

H

Optional

lumn in dimension Optional

##########

values into corresponding

DATATYPE CALCULATOR_CLASS

om_resource_1 Integer Converter - -g

mratiobucket -

Mandatory/Optional


42 PB

7.4.3 Sample custom resource data

ere is a sample of a custom resource configuration file customresources.conf:

format Formatter in case of values.

String Default value:

##########

fk_type Foreign key in case of custom dimensions

String Valid value as specified in dim_type cotable.

# Configuration for Licensing events# Assume that Cube function is Sum for all Measures. Default Format for measures:# # Refer Export Template or PBSWorksCubeSchema for the interpretation of the aboveAttributes

#TYPE ACCOUNTING_ATTRIBUTE_NAME DISPLAY_NAME DEFAULT_VALUE DB_COLUMN_NAME FK_TYPE FORMATMeasureType Resource_List.abaqus Custom Total Abaqus License Usage 0 custcom.altair.pbsworks.parser.exporter.event.base.derived.CustomLongResourceWalltimeDimensionType memratiobucket Memory Bucket none memratiobucket_id Strin

com.altair.pbsworks.parser.exporter.event.base.derived.RatioBucketDerivation me


Column NameColumn


Valid Values


17.5 Node details file

Providing node detail information for a PBS Professional complex is necessary prior to start-ing the PBSA web application service. This information will be used to build a view of the PBS Professional node configuration over time. Events that would trigger the need for con-figuration are:

• initial install





The node detail information is stored by year in the file

nodedetails_YYYY


The previous year node details configuration files are read when PBSA is started up for the first time after installation. If the node configuration details are updated, the database has to be dropped and the accounting logs have to be parsed again.

The current year node details configuration is read in every parsing cycle and can be appended. Therefore in order to add a node configuration to the existing file, one needs to append the details to the file.

To update/delete/modify the configuration, drop the existing database and re-parse.

The pbsa-config-nodes command (see section 13.1, “Configuring nodes”, on page 135) can be used to add information to this file.



17.5.1 Organization of node detail file

To describe your site’s PBS Professional cluster to PBSA requires information about each PBS complex, that is each PBS Professional server and its associated execution hosts. Describing each PBS complex to PBSA requires several rows of data, with each row having its own record format. The following record types are used to describe your site’s PBS Pro-fessional complex:

1. Event - tells PBSA if a server/node is being taken offline, deleted or added

2. Server - describes a PBS Professional server

3. Node - describes a PBS Professional execution host

4. Vnode - describes a PBS Professional virtual node

5. Resource - describes the resources available on an execution host or a virtual node

Here is an example of how the data is organized in this file:

EVENT 1 SERVER A NODE A1 RESOURCE 1 RESOURCE 2 NODE A2 RESOURCE 1 SERVER B NODE B1 RESOURCE 3 NODE B3 RESOURCE 4EVENT 2 SERVER C NODE C1 VNODE 1 RESOURCE 1 VNODE 2 RESOURCE 1



The following sections describe each record type of the PBSA node details configuration file.

1. Defining an event

2. Defining a PBS Professional server

3. Defining an execution host

4. Defining a virtual node

5. Defining resources

17.5.2 Defining an event

The first record type that is necessary to describe a PBS Professional complex to PBSA is the EVENT record. The EVENT record describes the action that is taking place, for instance tak-ing an execution host offline. The following information is necessary to define an EVENT record and must be separated by a tab character:

• Event type - describes the action

Must be placed in the 1st column

Can be one of the following:

• ADD - add a PBS Professional server or execution host

• DELETE - delete a PBS Professional server or execution host

• DOWN - take a PBS Professional server or execution host offline

• INSTALL_SNAPSHOT - describe to PBSA your site’s current PBS Professional complex configuration

• Server name - server name as defined in PBS Professional

Must be placed in the 3rd column

The INSTALL_SNAPSHOT event is used to configure PBSA after installation of the product and prior to parsing the PBS Professional accounting log. The pbsa-config-nodes command automatically creates the INSTALL_SNAPSHOT event records using information obtained by running the PBS Professional command pbsnodes -av (see Chapter 8, "Con-figuring node details", on page 105).



17.5.2.1 EVENT record layout

Table 17-6: EVENT record layout

Column NameColumn


Valid ValuesMandatory/Optional

EVENT_TYPE Defines the type of event such as adding a node or taking a node offline

String ADD Mandatory

DELETE

DOWN

INSTALL_SNAPSHOT

SERVER_NAME Server name as defined in PBS Professional

String Must be a valid PBS Professional server.

Mandatory


P 247

Chapter 17

1

T nt PBS Professional complex configura-t Server. The INSTALL_SNAPSHOT e ssional accounting log.

TATYPE RESOURCE_TYPE BUILT-IN - - - - 2013-01-01 now - - 2013-01-01 now - -inux - - - customx-gnn - - - custom6384kb - - - custom - - - customx-gnn - - - customCORE1GB - - - custom



7.5.2.2 Sample EVENT record

he highlighted record below is an example of an EVENT record. The example describes the curreion (an INSTALL_SNAPSHOT event for the year 2013) for a PBS Professional server called PBSvent is used to configure PBSA after installation of the product and prior to parsing the PBS Profe

#EVENT_TYPE ARG SERVER_NAME NODE_NAME VNODE VNODE_RANGE RESOURCE_DARESOURCE_NAME RESOURCE_VALUE FROM_DATE TO_DATE COMMENT CUSTOM_OR_INSTALL_SNAPSHOT - PBSServer - - - - - - -- - PBSServer - - - - - - -- - PBSServer ux-gnn - - - - - -- - - - - - string STATIC resources_available.arch l- - - - - - string STATIC resources_available.host u- - - - - - integer STATIC resources_available.mem 1- - - - - - integer STATIC resources_available.ncpus 2- - - - - - string STATIC resources_available.vnode u- - - - - - string STATIC resources_available.nodeclass 2


17.5.3 Defining a PBS Professional server

The second record type that is necessary to describe a PBS Professional complex to PBSA is the SERVER record. The SERVER record describes the PBS Professional server. The fol-lowing information is necessary to define a SERVER record and must be separated by a tab character:

• Server name - PBS Professional server name


• From date - date the event started

Must be placed in 11th column

• To date - date the event ended


• Comment - descriptive reason for the event:

Must be placed in the 13th column

Here are some examples:

• SCHEDULE__SHUTDOWN

• EXTERNAL_SOURCE

• HARDWARE_ISSUE

• NETWORK_FAILURE


P 249

Chapter 17

1

luesMandatory/

Optional

ssional server. Mandatory

e must be less than TO_DATE

Mandatory

e must be greater the FROM_DATE

Mandatory

ignates that the event rrently in effect

Optional



7.5.3.1 SERVER record layout

Table 17-7: SERVER record layout

Column Name Column DescriptionData Type

Valid Va


String Must be a valid PBS Profe

FROM_DATE Date the event started Date YYYY-MM-DD Datthe

TO_DATE Date the event ended Date YYYY-MM-DD Datthan

String now Desis cu

COMMENT Descriptive reason for the event String N/A

C


1

T nt PBS Professional complex configura-t Server. The date range indicates that t



50 PB

7.5.3.2 Sample SERVER record

he highlighted record below is an example of a SERVER record. The example describes the curreion (an INSTALL_SNAPSHOT event for the year 2013) for a PBS Professional server called PBShis configuration was in effect from January 1, 2013 and is currently in effect (“now”).

#EVENT_TYPE ARG SERVER_NAME NODE_NAME VNODE VNODE_RANGE RESOURCE_DARESOURCE_NAME RESOURCE_VALUE FROM_DATE TO_DATE COMMENT CUSTOM_OR_INSTALL_SNAPSHOT RANGE PBSServer - - - - - - -- - PBSServer - - - - - - -- - PBSServer ux-gnn - - - - - -- - - - - - string STATIC resources_available.arch l- - - - - - string STATIC resources_available.host u- - - - - - integer STATIC resources_available.mem 1- - - - - - integer STATIC resources_available.ncpus 2- - - - - - string STATIC resources_available.vnode u- - - - - - string STATIC resources_available.nodeclass 2


17.5.4 Defining an execution host

The third record type that is necessary to describe a PBS Professional complex to PBSA is the NODE record. The NODE record describes the PBS Professional execution host. The fol-lowing information is necessary to define a NODE record and must be separated by a tab character:

• Range - can be used to define a range of execution hosts (NODES) with like names and resources (homogenous).

Must be placed in the 2nd column



• Node name - execution host name as defined in PBS Professional


• Virtual node name - represents the natural vnode. A hyphen (-) may be placed in this field. PBSA automatically creates a virtual node having the same name and resources as the execution host.

Place a hyphen (-) in the 5th column








• SCHEDULE__SHUTDOWN

• EXTERNAL_SOURCE

• HARDWARE_ISSUE

• NETWORK_FAILURE


C


1

Mandatory/Optional

Optional

onal Mandatory

onal node Mandatory

Optional - PBSA automatically will create a virtual node having the same name and resources as the execution host (natural vnode)

t be less O_DATE

Mandatory


52 PB

7.5.4.1 NODE record layout

Table 17-8: NODE record layout


Valid Values

RANGE Defines a range of execution hosts (NODES) with like names and resources (homogenous).

String Integer range 1-3, 5-8


String Must be a valid PBS Professiserver.

NODE_NAME Execution host name as defined in PBS Professional

String Must be a valid PBS Professifor SERVER_NAME

VNODE Natural vnode name String Hyphen (-)

FROM_DATE Date the event started Date YYYY-MM-DD Date musthan the T

P 253

Chapter 17

t be an the ATE

Mandatory

s the y

Optional

Mandatory/Optional



TO_DATE Date the event ended Date YYYY-MM-DD Date musgreater thFROM_D

String now Designatecurrent da


Table 17-8: NODE record layout


Valid Values

C


1

T BS Professional complex configuration ( er, having a single node called ux-gnn. T in effect (“now”).



54 PB

7.5.4.2 Sample NODE record

he highlighted record below is an example of a NODE record. The example describes the current Pan INSTALL_SNAPSHOT event for the year 2013) for a PBS Professional server called PBSServhe date range indicates that this configuration was in effect from January 1, 2013 and is currently

#EVENT_TYPE ARG SERVER_NAME NODE_NAME VNODE VNODE_RANGE RESOURCE_DARESOURCE_NAME RESOURCE_VALUE FROM_DATE TO_DATE COMMENT CUSTOM_OR_INSTALL_SNAPSHOT RANGE PBSServer - - - - - - -- - PBSServer - - - - - - -- - PBSServer ux-gnn - - - - - -- - - - - - string STATIC resources_available.arch l- - - - - - string STATIC resources_available.host u- - - - - - integer STATIC resources_available.mem 1- - - - - - integer STATIC resources_available.ncpus 2- - - - - - string STATIC resources_available.vnode u- - - - - - string STATIC resources_available.nodeclass 2

P 255

Chapter 17

T E field to denote the node naming s sk(*).

I

•

•

•

w

TATYPE RESOURCE_TYPE BUILT-IN - - - - 2013-01-01 now - - 2013-01-01 now - -inux - - - customx-gnn* - - - custom6384kb - - - custom - - - customx-gnn* - - - customCORE1GB - - - custom



o describe a homogeneous range of nodes having similar names and like resources, use the RANGcheme. When a range of nodes are being specified, the node name must be suffixed with an asteri

n this example, RANGE is set to “1-3”. Using the pattern “ux-gnn*”, this describes three nodes:

node=ux-gnn1 virtual node=ux-gnn1



ith the same set of resources.

#EVENT_TYPE ARG SERVER_NAME NODE_NAME VNODE VNODE_RANGE RESOURCE_DARESOURCE_NAME RESOURCE_VALUE FROM_DATE TO_DATE COMMENT CUSTOM_OR_INSTALL_SNAPSHOT RANGE PBSServer - - - - - - -- - PBSServer - - - - - - -- 1-3 PBSServer ux-gnn* - - - - - -- - - - - - string STATIC resources_available.arch l- - - - - - string STATIC resources_available.host u- - - - - - integer STATIC resources_available.mem 1- - - - - - integer STATIC resources_available.ncpus 2- - - - - - string STATIC resources_available.vnode u- - - - - - string STATIC resources_available.nodeclass 2


17.5.5 Defining a virtual node

The fourth record type that is necessary to describe a PBS Professional complex to PBSA is the VNODE record. The VNODE record describes the PBS Professional virtual node.

If virtual nodes are not explicitly defined for a node, PBS Professional creates a virtual node having the same name as the node (natural vnode). This is denoted on the server node record in the VNODE field.

Multiple virtual nodes may be defined for an execution host, therefore a VNODE record will be required for each virtual node. The following information is necessary to define a VNODE record and must be separated by a tab character.



• Node name - execution host name as defined in PBS Professional


• Virtual node name - virtual node name as defined in PBS Professional


• Virtual node range - can be used to define a range of virtual nodes with like names and resources (homogeneous).








- SCHEDULE__SHUTDOWN

- EXTERNAL_SOURCE

- HARDWARE_ISSUE

- NETWORK_FAILURE


P 257

Chapter 17

1


ofessional server. Mandatory

ofessional execution E

Mandatory

ofessional virtual ME/NODE_NAME

Mandatory

, 5-8 Optional

te must be less than TO_DATE

Mandatory

te must be greater n the FROM_DATE

Mandatory

signates the current y

Optional



7.5.5.1 VNODE record layout

Table 17-9: VNODE record layout


Valid V


String Must be a valid PBS Pr

NODE_NAME Execution host name as defined in PBS Professional

String Must be a valid PBS Prhost for SERVER_NAM

VNODE Virtual node name. String Must be a valid PBS Prnode for SERVER_NA

VNODE_RANGE Defines a range of virtual nodes with like names and resources (homogeneous).

String Integer range 1-3

FROM_DATE Date the event started Date YYYY-MM-DD Dathe

TO_DATE Date the event ended Date YYYY-MM-DD Datha

String now Deda


C


1

T nt PBS Professional complex configura-t Server, having a virtual node called ux-g nd is currently in effect (“now”)..

TATYPE RESOURCE_TYPE BUILT-IN - - - - 2013-01-01 now - - 2013-01-01 now - -inux - - - customx-gnn - - - customb - - - custom - - - customb - - - customx-gnn - - - customCORE0GB - - - custom 2013-01-01 now - -inux - - - custom - - - customx-gnn - - - custom6384kb - - - custom - - - custom00mb - - - customx-gnn[0] - - - customCORE1GB - - - custom


58 PB

7.5.5.2 Sample VNODE record

he highlighted record below is an example of a VNODE record. The example describes the curreion (an INSTALL_SNAPSHOT event for the year 2013) for a PBS Professional server called PBSnn[0]. The date range indicates that this node configuration was in effect from January 1, 2013 a

#EVENT_TYPE ARG SERVER_NAME NODE_NAME VNODE VNODE_RANGE RESOURCE_DARESOURCE_NAME RESOURCE_VALUE FROM_DATE TO_DATE COMMENT CUSTOM_OR_INSTALL_SNAPSHOT RANGE PBSServer - - - - - - -- - PBSServer - - - - - - -- - PBSServer ux-gnn - - - - - -- - - - - - string STATIC resources_available.arch l- - - - - - string STATIC resources_available.host u- - - - - - integer STATIC resources_available.mem 0- - - - - - integer STATIC resources_available.ncpus 0- - - - - - integer STATIC resources_available.vmem 0- - - - - - string STATIC resources_available.vnode u- - - - - - string STATIC resources_available.nodeclass 0- - PBSServer ux-gnn ux-gnn[0] - - - - -- - - - - - string STATIC resources_available.arch l- - - - - - integer STATIC resources_available.custom_res 3- - - - - - string STATIC resources_available.host u- - - - - - integer STATIC resources_available.mem 1- - - - - - integer STATIC resources_available.ncpus 2- - - - - - integer STATIC resources_available.vmem 1- - - - - - string STATIC resources_available.vnode u- - - - - - string STATIC resources_available.nodeclass 2

P 259

Chapter 17

T VNODE_RANGE field to denote the v

W sterisk enclosed in square brackets ([*]).

I ree virtual nodes:

•

•

•

w

TATYPE RESOURCE_TYPE BUILT-IN - - - - 2013-01-01 now - - 2013-01-01 now - -inux - - - customx-gnn - - - customb - - - custom - - - customb - - - customx-gnn - - - customCORE0GB - - - custom 2013-01-01 now - -inux - - - custom - - - customx-gnn - - - custom6384kb - - - custom - - - custom00mb - - - customx-gnn[*] - - - customCORE1GB - - - custom



o describe a homogeneous range of virtual nodes having similar names and like resources, use theirtual node naming scheme.

hen a range of virtual nodes are being specified, the virtual node name must be suffixed with an a

n this example, VNODE_RANGE is set to “0-2”. Using the pattern “ux-gnn[*]”, this describes th

ux-gnn[0]

ux-gnn[1]

ux-gnn[2]

ith the same set of resources.

#EVENT_TYPE ARG SERVER_NAME NODE_NAME VNODE VNODE_RANGE RESOURCE_DARESOURCE_NAME RESOURCE_VALUE FROM_DATE TO_DATE COMMENT CUSTOM_OR_INSTALL_SNAPSHOT RANGE PBSServer - - - - - - -- - PBSServer - - - - - - -- - PBSServer ux-gnn - - - - - -- - - - - - string STATIC resources_available.arch l- - - - - - string STATIC resources_available.host u- - - - - - integer STATIC resources_available.mem 0- - - - - - integer STATIC resources_available.ncpus 0- - - - - - integer STATIC resources_available.vmem 0- - - - - - string STATIC resources_available.vnode u- - - - - - string STATIC resources_available.nodeclass 0- - PBSServer ux-gnn ux-gnn[*] 0-2 - - - -- - - - - - string STATIC resources_available.arch l- - - - - - integer STATIC resources_available.custom_res 3- - - - - - string STATIC resources_available.host u- - - - - - integer STATIC resources_available.mem 1- - - - - - integer STATIC resources_available.ncpus 2- - - - - - integer STATIC resources_available.vmem 1- - - - - - string STATIC resources_available.vnode u- - - - - - string STATIC resources_available.nodeclass 2


17.5.6 Defining resources

The fifth record type that is necessary to describe a PBS Professional complex to PBSA is the RESOURCE record. The RESOURCE record describes the resources available on a PBS Professional execution host or virtual node. The following information is necessary to define a RESOURCE record and must be separated by a tab character:

• Resource datatype - describes the datatype of the resource


• Resource type - describes the type of resource

Can be one of the following:

- STATIC

- DYNAMIC


• Resource name - resource name as defined in PBS Professional


• Resource value - value of resource as defined in PBS Professional


• Type of resource - currently only a custom resource is supported



P 261

Chapter 17

1

ValuesMandatory/

Optional

Mandatory

Mandatory

BS Professional Mandatory

separated list of

able.host” the s be the node name.

able.vnode” the s be the virtual

Mandatory

e value “custom” Mandatory



7.5.6.1 RESOURCE record layout

Table 17-10: RESOURCE record layout


Valid

RESOURECE_DATATYPE Datatype of resource String integer

string

RESOURCE_TYPE Describes the type of resourcel String DYNAMIC

STATIC

RESOURCE_NAME Name of resource as defined in PBS Professional

String Must be a valid Presource.

RESOURCE_VALUE Value of resource as defined in PBS Professional

String Can be a commaresource values.

For the resource “resources_availvalue will alway

For the resource “resources_availvalue will alwaynode name.

CUSTOM_OR_BUILT_IN Defines whether this resource is a custom resource or a built-in resource. Currently, only custom resources are supported.

String Currently only this supported.

C


1

T current PBS Professional complex con-f PBSServer, having a virtual node called u 3 and is currently in effect (“now”).

M

TATYPE RESOURCE_TYPE BUILT-IN - - - - 2013-01-01 now - - 2013-01-01 now - -inux - - - customx-gnn - - - customb - - - custom - - - customb - - - customx-gnn - - - customCORE0GB - - - custom 2013-01-01 now - -inux - - - custom - - - customx-gnn - - - custom6384kb - - - custom - - - custom00mb - - - customx-gnn[0] - - - customCORE1GB - - - custom

abled Abaqus,Radioss - - - custom


62 PB

7.5.6.2 Sample RESOURCE record

he highlighted records below are examples of a RESOURCE record. The example describes the iguration (an INSTALL_SNAPSHOT event for the year 2013) for a PBS Professional server calledx-gnn[0]. The date range indicates that this node configuration was in effect from January 1, 201

ultiple resource values can be specified as comma separated list:

#EVENT_TYPE ARG SERVER_NAME NODE_NAME VNODE VNODE_RANGE RESOURCE_DARESOURCE_NAME RESOURCE_VALUE FROM_DATE TO_DATE COMMENT CUSTOM_OR_INSTALL_SNAPSHOT RANGE PBSServer - - - - - - -- - PBSServer - - - - - - -- - PBSServer ux-gnn - - - - - -- - - - - - string STATIC resources_available.arch l- - - - - - string STATIC resources_available.host u- - - - - - integer STATIC resources_available.mem 0- - - - - - integer STATIC resources_available.ncpus 0- - - - - - integer STATIC resources_available.vmem 0- - - - - - string STATIC resources_available.vnode u- - - - - - string STATIC resources_available.nodeclass 0- - PBSServer ux-gnn ux-gnn[0] - - - - -- - - - - - string STATIC resources_available.arch l- - - - - - integer STATIC resources_available.custom_res 3- - - - - - string STATIC resources_available.host u- - - - - - integer STATIC resources_available.mem 1- - - - - - integer STATIC resources_available.ncpus 2- - - - - - integer STATIC resources_available.vmem 1- - - - - - string STATIC resources_available.vnode u- - - - - - string STATIC resources_available.nodeclass 2

- - - - - - integer STATIC resources_available.pas_applications_en

P 263

Chapter 17

1

T another node coming online April 1.

- - - 12-01-01 2012-03-31 - -12-01-01 2012-03-31 - - - - - customled Abaqus - - - custom

- - - custom - - - custom - - - 12-04-01 now - -12-04-01 now - - - - - customled Abaqus - - - custom

- - - custom - - - custom12-04-01 now - - - - - customled Abaqus - - - custom

- - - custom - - - custom



7.5.7 Install snapshot examples

his example shows a complex with a server having 8 nodes that came online January 1, 2012 with

INSTALL_SNAPSHOT - blrhpc3 - - - - - - - - - - blrhpc3 - - - - - - - 20- 1-8 blrhpc3 blrhpc3n* - - - - - - 20- - - - - - string STATIC resources_available.abaqus 8 - - - - - - string STATIC resources_available.aif_applications_enab- - - - - - string STATIC resources_available.ncpus 12 - - - - - - string STATIC resources_available.mem 32900260 INSTALL_SNAPSHOT - blrhpc3 - - - - - - - - - - blrhpc3 - - - - - - - 20- 1-8 blrhpc3 blrhpc3n* - - - - - - 20- - - - - - string STATIC resources_available.abaqus 8 - - - - - - string STATIC resources_available.aif_applications_enab- - - - - - string STATIC resources_available.ncpus 12 - - - - - - string STATIC resources_available.mem 32900260 - - blrhpc3 blrhpc3n30 - - - - - - 20- - - - - - string STATIC resources_available.abaqus 8 - - - - - - string STATIC resources_available.aif_applications_enab- - - - - - string STATIC resources_available.ncpus 12 - - - - - - string STATIC resources_available.mem 32900260

C


T to 4 virtual nodes that came online Jan-u 1v9. .

- - -

12-01-01 now - -

12-01-01 now - -

- - custom

baqus - - - custom

- - custom

- - custom

- - custom

- - custom

- - custom

12-01-01 now - -

- - custom

baqus - - - custom

- - custom

- - custom

- - custom

- - custom

- - custom


64 PB

his node detail file shows that a complex has a single server with a single node that was divided inary 1st, 2012. The virtual nodes are called blrhpc3n1v0, blrhpc3n1v1, blrhpc3n1v2, and blrhpc3n

INSTALL_SNAPSHOT - blrhpc3 - - - - - - - -

- - blrhpc3 - - - - - - - 20

- - blrhpc3 blrhpc3n1 blrhpc3n1v[*] 0-2 - - - - 20

- - - - - - string STATIC resources_available.abaqus 0 -

- - - - - - string STATIC resources_available.aif_applications_enabled A

- - - - - - string STATIC resources_available.host blrhpc3n1 -

- - - - - - string STATIC resources_available.ncpus 12 -

- - - - - - string STATIC resources_available.mem 32900260 -

- - - - - - string STATIC resources_available.arch linux -

- - - - - - string STATIC resources_available.vnode blrhpc3n1v[*] -

- - blrhpc3 blrhpc3n1 blrhpc3n1v[9] - - - - - 20



- - - - - - string STATIC resources_available.host blrhpc3n1 -



- - - - - - string STATIC resources_available.arch linux -

- - - - - - string STATIC resources_available.vnode blrhpc3n1v[9] -

P 265

Chapter 17

T

- - - -

2012-01-01 now - -

2012-01-01 now - -

- - custom

baqus - - - custom

- - custom

- - custom

2012-01-01 now - -

- - custom

baqus - - - custom

- - custom

- - custom

2012-01-01 now - -

- - custom

baqus - - - custom

- - custom

- - custom



his example shows a range of virtual nodes within a range of nodes:

INSTALL_SNAPSHOT - blrhpc3 - - - - - - -

- - blrhpc3 - - - - - - -

- 1-3 blrhpc3 blrhpc3n* - - - - - -





- - blrhpc3 blrhpc3n1 abc[*] 0-10 - - - -





- - blrhpc3 blrhpc3n2 abc[*] 0-10 - - - -





C


T erver) called “blrhpcbkup”. .

1

T ber 1st and will continue to remain on-l

- - -

01 2012-12-31 - -

01 2012-12-31 - -

- - custom

baqus - - - custom

- - custom

- - custom

- - -

2013-11-01 now - -

- - custom

baqus - - - custom

- - custom

- - custom


66 PB

his node detail file shows that this complex has a single server with a secondary server (failover s

7.5.8 Add node example

his example shows how to add new nodes to the complex. The nodes will come on-line on Novemine, unless a DOWN or DELETE record is added to the node details file.

INSTALL_SNAPSHOT - blrhpc3-alias-blrhpcbkup - - - - - - - -

- - blrhpc3-alias-blrhpcbkup - - - - - - - 2012-01-

- - blrhpc3 blrhpc3n30 - - - - - - 2012-01-





ADD RANGE - - - - - - - -

- 1-10 blrhpc3 blrhpc3n* - - - - - -





P 267

Chapter 17

1

T

A

A

U

- - -

13-01-01 now - -

- - custom

baqus - - - custom

- - custom

- - custom

- - -

013-11-01 2013-11-15 - -

- - custom

baqus - - - custom

- - custom

- - custom



7.5.9 Down node example

his example shows how to bring a node down.

node was added on January 1st, 2013.

t a later date it is brought down for maintenance from November 1st through November 15th.

se the ADD event to make a node active after a DOWN event.

ADD RANGE - - - - - - - -

- - blrhpc3 blrhpc3n30 - - - - - - 20





DOWN RANGE - - - - - - - -

- - blrhpc3 blrhpc3n30 - - - - - - 2





C


1

T

T

I

- - -

13-01-01 now - -

- - custom

baqus - - - custom

- - custom

- - custom

- - -

13-11-01 now - -

- - custom

baqus - - - custom

- - custom

- - custom


68 PB

7.5.10 Delete a node example

his example shows how to delete a node.

he node is added on January 1st, 2013.

t is then deleted on November 1st, 2013.

ADD RANGE - - - - - - - -

- - blrhpc3 blrhpc3n30 - - - - - - 20





DELETE - blrhpc3 - - - - - - - -

- - blrhpc3 blrhpc3n30 - - - - - - 20





Chapter 18

Advanced ConfigurationFor documentation purposes, the PBSA installation directory will be denoted by <INSTALL_DIR>. The installation directory for a typical installation of PBSA is:

/opt/pbsworks/12.2

18.1 Configuring SSL

Enabling SSL for PBSA requires root privileges.

Typically, PBSA is installed and configured to use port 9000. If this port is not available during installation, then PBSA will increment the port number by one and try again. This will continue until a free port is found, or until 50 consecutive ports are refused at which point the installer will ask for a port. The following instructions for configuring SSL assume that PBSA is configured for port 9000.

18.1.1 Setting JAVA_HOME

Determine if the environment variable JAVA_HOME is set properly by entering the follow-ing at the Linux command line prompt

echo $JAVA_HOME:

JAVA_HOME should be set to

<INSTALL_DIR>/portal/thirdparty/java.

If JAVA_HOMEis not set, enter the following command

export JAVA_HOME=<INSTALL_DIR>/portal/thirdparty/java:


Chapter 18 Advanced Configuration

18.1.2 Create keystore file

Create a Tomcat certificate keystore file by running the following command

$JAVA_HOME/bin/keytool -keystore <INSTALL_DIR>/portal/thirdparty/apache/tomcat/conf/keystore -genkey -alias pbsworks -keyalg RSA:

After executing this command, you will first be prompted for the keystore password. The default password used by Tomcat is "changeit" (all lower case), although you can specify a custom password if you like. Make a note of this password since it will be required in later steps of the SSL configuration.

Next, you will be prompted for general information about this Certificate, such as company, contact name, and so on. This information will be displayed to users who attempt to access a secure page in your application, so make sure that the information provided here matches what they will expect.

Finally, you will be prompted for the key password, which is the password specifically for this certificate (as opposed to any other certificates stored in the same keystore file). You MUST use the same password here as was used for the keystore password itself. This is a restriction of the Tomcat implementation. (Currently, the keytool prompt will tell you that pressing the ENTER key does this for you automatically.)

If everything was successful, you now have a keystore file in the

<INSTALL_DIR>/portal/thirdparty/apache/tomcat/conf

directory with a certificate that can be used by your server.

There are two options for configuring SSL:

Option 1 - enable secure access to PBSA over port 9002 (see section 18.1.3, “Configuring a secure open port”, on page 271)

Option 2 -enable secure access to PBSA over port 9002 with redirection through http port 9000 (see section 18.1.4, “Configuring a secure open port with redirection”, on page 273)


Advanced Configuration Chapter 18

18.1.3 Configuring a secure open port

This option enables secure access to PBSA over port 9002. With this option, access to PBSA is only available through port 9002, with no redirection from the http port of 9000.

If you have enabled SSL using the Configuring a Secure Open Port with Redirection option, then please back out those changes prior to completing the following steps:

18.1.3.1 Configuring ports

Configure the secure public port (9002) and the 9000 port (used by Access Management Ser-vice (AMS) to communicate with PBSA) by editing the Tomcat server configuration file

<INSTALL_DIR>/portal/thirdparty/apache/tomcat/conf/server.xml.

Replace the following line of code:

with this block of code:

The keystorePass= should be the password used during the creation of the keystore file. Replace <INSTALL_DIR> with the pathname to the PBSA installation directory. Replace <hostname> with the name of the IP address or hostname of the server where PBSA was installed.

<Connector connectionTimeout="20000" port="9000" protocol="HTTP/1.1" redirectPort="9002"/>

<Connector connectionTimeout="20000" address="localhost" port="9000" protocol="HTTP/1.1" redirectPort="9002" />

<Connector port="9002" protocol="HTTP/1.1" SSLEnabled="true" maxThreads="150" scheme="https" secure="true" address="<hostname>" clientAuth="false" sslProtocol="TLS" keystoreFile="<INSTALL_DIR>/portal/thirdparty/apache/tomcat/conf/keystore" keyAlias="pbsworks" keystorePass="changeit" />



18.1.3.2 Configuring AMS for SSL

To configure AMS to communicate with PBSA over http (currently the default configuration is that AMS and PBSA are installed on the same server), edit the Access Management Service client properties file

<INSTALL_DIR>/portal/config/AA/AA_Client.properties.

Replace the following block of code:

with this block of code:

18.1.3.3 Restarting PBSA

The PBSA web application service will need to be restarted (see section 12.1.3, “Restarting the PBSA web application service”, on page 132) for the changes to be reflected.

18.1.3.4 Accepting the certification

From a web browser, navigate to https://<hostname>:9002 and accept the certificate when you are prompted by the browser.

18.1.3.5 Login to PBSA

Once the certificate is accepted, login to PBSA by using a supported web browser through the URL https://<hostname>:9002/pbsworks.

java.authWsdl=http://<hostname>:8080/AAService/AuthzUserPort?wsdljava.authEndpoint=http://<hostname>:8080/AAService/AuthzUserPortjava.adminWsdl=http://<hostname>:8080/AAService/AuthzAdminModulePort?wsdljava.adminEndpoint=http://<hostname>:8080/AAService/AuthzAdminModulePortjava.authnWsdl=http://<hostname>:8080/AAService/AuthNPort?wsdljava.authnEndpoint=http://<hostname>:8080/AAService/AuthNPort

java.authWsdl=http://localhost:8080/AAService/AuthzUserPort?wsdljava.authEndpoint=http://localhost:8080/AAService/AuthzUserPortjava.adminWsdl=http://localhost:8080/AAService/AuthzAdminModulePort?wsdljava.adminEndpoint=http://localhost:8080/AAService/AuthzAdminModulePortjava.authnWsdl=http://localhost:8080/AAService/AuthNPort?wsdljava.authnEndpoint=http://localhost:8080/AAService/AuthNPort



18.1.4 Configuring a secure open port with redirection

This option enables secure access to PBSA over port 9002, while keeping the http port 9000 open. With this option, users are redirected to the secure connection from the http port.

If you have enabled SSL using the Configuring a Secure Open Port option, then please back out those changes prior to completing the following steps:

18.1.4.1 Configuring ports

Configure the secure public port (9002) by editing the Tomcat server configuration file

<INSTALL_DIR>/thirdparty/apache/tomcat/conf/server.xml.

Paste the following block of code:

After the following line of code which configures the http port:

The keystorePass= should be the password used during step 2. Replace <INSTALL_DIR> with the pathname to the PBSA installation directory.

18.1.4.2 Editing the web application configuration file

Edit the PBSA framework web application configuration file

<INSTALL_DIR>/portal/binaries/framework/webapps/pbsworks/WEB-INF/web.xml

to set up redirection from http://hostname:9000/pbsworks to https://host-name:9000/pbsworks.

<Connector port="9002" protocol="HTTP/1.1" SSLEnabled="true" maxThreads="150" scheme="https" secure="true" clientAuth="false" sslProtocol="TLS" keystoreFile="<INSTALL_DIR>/thirdparty/apache/tomcat/conf/keystore"

keyAlias="pbsworks" keystorePass="changeit" />

<Connector connectionTimeout="20000" port="9000" protocol="HTTP/1.1" redirectPort="9002"/>



Paste the following block of code::

After the following block of code:

18.1.4.3 Restarting PBSA


18.1.4.4 Accepting the certification

From a web browser, navigate to https://<hostname>:9002 and accept the certificate when you are prompted by the browser.

18.1.4.5 Logging into PBSA

Once the certificate is accepted, login to PBSA by using a supported web browser through the URL https://<hostname>:9002/pbsworks or through the URL http://<hostname>:9000/pbsworks which will redirect the user to the secure connection.

<security-constraint> <web-resource-collection> <web-resource-name>Entire Application</web-resource-name> <url-pattern>/*</url-pattern> </web-resource-collection> <user-data-constraint> <transport-guarantee>CONFIDENTIAL</transport-guarantee> </user-data-constraint> </security-constraint>

<session-config> <session-timeout>120</session-timeout></session-config>



18.2 Configuring logging

Logging behavior can be defined in the file log4j.properties. The location of the file is::

<<INSTALL_DIR>/portal/config

By default, PBSA logs at an "INFO" level and keeps a maximum of two (2) files as backup.

18.2.1 log4j.properties file

18.2.2 Configuring logging behavior

To configure the level of logging:

Edit the log4j.properties file and set the parameter log4j.rootLogger to one of the fol-lowing values:

• OFF - designated the highest possible ranking and is intended to turn off logging

• FATAL - designates very severe error events that will presumably lead the application to abort

• ERROR - designates error events that might still allow the application to continue run-ning

• WARN - designates potentially harmful situations

• INFO - designates informational messages that highlight the progress of the application at coarse-grained level

• DEBUG - designates fine-grained informational events that are most useful to debug an

log4j.appender.frameworkRollingFile=org.apache.log4j.RollingFileAppenderlog4j.appender.frameworkRollingFile.File=pbsworks.loglog4j.appender.frameworkRollingFile.MaxFileSize=2MBlog4j.appender.frameworkRollingFile.MaxBackupIndex=2log4j.appender.frameworkRollingFile.layout=org.apache.log4j.PatternLayoutlog4j.appender.frameworkRollingFile.layout.ConversionPattern= %n%p, %d{dd MMM yyy HH:mm:ss,SSS} -{%F: %L} - %m %nlog4j.rootLogger=INFO, frameworkRollingFile



application

• TRACE - designates finer-grained informational events than the DEBUG

• ALL - designates the lowest possible rank and is intended to turn on all logging


18.2.3 Configuring log file size and number of backups

To define the maximum log file size and the number of backup files:

Edit the log4j.properties file and set the MaxFileSize and MaxBackupIndex param-eters:


log4j.rootLogger=INFO, frameworkRollingFile

log4j.appender.frameworkRollingFile.MaxFileSize=2MBlog4j.appender.frameworkRollingFile.MaxBackupIndex=2



18.3 Configuring the license server

18.3.1 Initial license server configuration

If you installed PBSA without providing a license server, then prior to starting the web appli-cation service for the first time, you must configure PBSA with a valid license server to gain access to the PBSA web application. To configure the license server, modify the factory-Settings.xml file. The location of this file is:

<INSTALL_DIR>/portal/binaries/framework/data:

<?xml version="1.0" encoding="UTF-8"?><Settings> <Category name="Root"> <Category name="General"> <Setting name="savesession" preference="true"> <value>true</value> <class>com.altair.awpf.services.preferences.model.BooleanPreference</class> <displayName>Save Session</displayName> <isEnforced>false</isEnforced> <private>false</private> </Setting> <Setting name="notificationpanelstate"> <value>hide</value> <class>com.altair.awpf.services.preferences.model.Setting</class> <isEnforced>false</isEnforced> <private>true</private> </Setting> </Category> <Category name="License Server"> <Setting name="Location" preference="true"> <value></value> <class>com.altair.awpf.services.preferences.model.StringPreference</class> <displayName>Server Location</displayName> <isEnforced>true</isEnforced> <private>false</private> </Setting> </Category> </Category></Settings>



18.3.1.1 Configuring the license server

Edit the factorySettings.xml file and change the <port@hostname> of the license server.

Now you may start the PBSA web application service (see section 12.1.1, “Starting the PBSA web application service”, on page 131).

<Category name="License Server"> <Setting name="Location" preference="true"> <value>port@hostname</value> <class>com.altair.awpf.services.preferences.model.StringPreference</class> <displayName>Server Location</displayName> <isEnforced>true</isEnforced> <private>false</private> </Setting></Category>



18.3.2 Configuring the license server after starting PBSA

If the PBSA web application has been started, and either a valid license server has not been configured for PBSA, or if the license server just needs to be changed, then modify the adminSettings.xml file. The location of this file is:

<INSTALL_DIR>/portal/binaries/framework/data

18.3.2.1 adminSettings.xml file:

<?xml version="1.0" encoding="UTF-8"?><Settings> <Category name="Root"> <Category name="General"> <Setting name="savesession" preference="true"> <value>true</value> <class>com.altair.awpf.services.preferences.model.BooleanPreference</class> <displayName>Save Session</displayName> <isEnforced>false</isEnforced> <private>false</private> </Setting> <Setting name="notificationpanelstate"> <value>hide</value> <class>com.altair.awpf.services.preferences.model.Setting</class> <isEnforced>false</isEnforced> <private>true</private> </Setting> </Category> <Category name="License Server"> <Setting name="Location" preference="true"> <value>6200@trlicsrv03</value> <class>com.altair.awpf.services.preferences.model.StringPreference</class> <displayName>Server Location</displayName> <isEnforced>true</isEnforced> <private>false</private> </Setting> </Category> </Category></Settings>



18.3.2.2 Configuring the license server

Edit the adminSettings.xml file and change the <port@hostname> of the license server.


<Category name="License Server"> <Setting name="Location" preference="true"> <value>port@hostname</value> <class>com.altair.awpf.services.preferences.model.StringPreference</class> <displayName>Server Location</displayName> <isEnforced>true</isEnforced> <private>false</private> </Setting></Category>



18.4 Configuring JVM Performance

18.4.1 Configuring JVM of PBSA web application

The Java Virtual Machine (JVM) heap size of the PBSA web application may need to be adjusted.

The default JVM heap size is based on the licensing schema:

• Base - 4 GB

• Standard - 8 GB

• Advanced - 16 GB

If OutOfMemory errors or warnings are reported in the log files, this value should be increased. It can be increased in multiples of 256 MB.

The Java heap size default is stored in a script file called memoryRecommendation.sh. The location of this is:

<INSTALL_DIR>/portal/scripts

This is the area of the file that will need to be modified:

For example, to change the Java heap size for a Base licensing schema from “4096” to “8192”, change the following line:

to:

if [ "$numberOfUnits" -eq "10000" ]; then echo "4086 Base"elif [ "$numberOfUnits" -eq "30000" ];then echo "8192 Standard"elif [ "$numberOfUnits" -eq "60000" ]then echo "16384 Advance"fi

if [ "$numberOfUnits" -eq "10000" ]; then echo "4086 Base"

if [ "$numberOfUnits" -eq "10000" ]; then echo "8192 Base"



The PBSA web application service will need to be restarted (see section 12.1.3, “Restarting the PBSA web application service”, on page 132) for the changes to be reflected after config-uring the JVM.

18.4.2 Configuring JVM of PBSA data collector

The Java Virtual Machine (JVM) heap size of the PBSA data collector may need to be adjusted. Currently, the default JVM heap size is 256 MB. If OutOfMemory errors or warn-ings are reported in the log files, this value should be increased. It can be increased in multi-ples of 256 MB.

The Java heap size default is stored in a script file called pbsworks-dc-start.sh. The location of this file is:

<INSTALL_DIR>/dc/scripts

The JVM argument that needs to be modified is the -Xmx256m argument. Increase the "256" value. To configure the minimum memory limit, modify the -Xms64m argument.

This is the area of the file that will need to be modified (this file is too large to show in its entirety):

For instance, JAVA_OPTS="-Xms64m -Xmx256m", allocates a minimum of 64 MB and a maximum of 256 MB of JVM.

The PBSA data collector service will need to be restarted (see section 12.2.3, “Restarting the PBSA data collector service”, on page 134) for the changes to be reflected after configuring the JVM.

JAVA_OPTS="-Xms64m -Xmx256m"



18.5 Configuring SSH Authentication

During installation, PBSA can be configured to use SSH based authentication. This authenti-cation information is stored in the file AA_jaas.config. The location of the file is:

<INSTALL_DIR>/portal/config/AA

18.5.1 AA_jaas.config

18.5.2 Changing the SSH server

Edit the AA_jaas.config file and change host=<NEW_SSH_SERVER> to the new SSH server IP address or hostname.


LoginModule { com.altair.jaas.module.SSHUnixLoginModule required host="localhost" port="22" cache_ttl="60" debug=false;};

host="<NEW_SSH_SERVER>"



18.6 Changing the accounting log location

These instructions pertain to installations of PBSA where the PBSA data collector has been installed on a separate server than the web application. During installation of the PBSA data collector, the location of the PBS Professional accounting logs is provided. This information can be changed without reinstalling the data collector by editing the file config.xml. The location of the file is:

<INSTALL_DIR>/dc/modules/pbsa/config/

18.6.1 config.xml

Edit the config.xml file and change the value of the accounting-log-dir to the correct PBS Professional accounting log directory.

The PBSA data collector will need to be restarted (see section 12.2.3, “Restarting the PBSA data collector service”, on page 134) for the changes to be reflected.

18.7 Changing web application hostname:port

These instructions pertain to installations of PBSA where the PBSA data collector has been installed on a separate server than the web application. During installation of the PBSA data collector, the hostname and port number of the PBSA web application is provided. This infor-mation can be changed without reinstalling the data collector by editing the file con-fig.xml. The location of the file is:

<INSTALL_DIR>/dc/config/

<?xml version="1.0" encoding="UTF-8"?><!DOCTYPE properties SYSTEM "http://java.sun.com/dtd/properties.dtd">

<properties> <comment>PBSA Configuration File</comment> <entry key="accounting-log-dir">/invalid/directory/name</entry></properties>

<entry key="accounting-log-dir">/var/spool/PBS/server_priv/accounting</entry>


18.7.1 config.xml

18.7.2 Changing the web application hostname:port

Edit the config.xml file and change the value of the server-url to the correct host-name:port of the PBSA web application.

The PBSA data collector will need to be restarted (see section 12.2.3, “Restarting the PBSA data collector service”, on page 134) for the changes to be reflected.

<?xml version="1.0" encoding="UTF-8"?><!DOCTYPE properties SYSTEM "http://java.sun.com/dtd/properties.dtd">

<properties> <comment>DC Configuration file</comment>

<entry key="server-url">http://localhost:9001</entry> <entry key="service-context">/parser/dc</entry> <entry key="upload-context">/parser/upload</entry> <entry key="server-name">DEFAULT</entry>

 <entry key="transport-interval">10</entry> <entry key="data-transport">com.altair.pbsworks.dc.transport.http.HTTPFileTransport</entry></properties>

<entry key="server-url">http://localhost:9001</entry>


18.8 Configuring plot point decimation

Many times, charts have an unnecessary number of data points relative to the number of pix-els that can be displayed by a browser or a desktop application. To technically improve the rendering of charts within the web browser, and to provide usable charts that show trends and patterns, PBSA uses a decimation or downsampling strategy to reduce the number of plot points displayed in a chart.

Note 1: When a chart is plotted using the decimated data subset, it will differ from the exported dataset which will contain the complete data.

Note 2: All statistical calculations performed on the plotted chart is based on the decimated data and not on the full available data.

Configurable limitations are set for both the x and y coordinates that essentially filter the data that is plotted on the graph. This information is stored in a file called pbsaconfig.prop-erties.

The location of this file is:

<INSTALL_DIR>/portal/services/pbsa/config



PBSA is configured by default to display at most 150 points on the x-axis, and 50 points on the y-axis in the case of stacked and xyz charts.

#Cache PropertiesconnectionCache=http://localhost:9000/altairanalytics/servlet/FlushCache

#OLAP4j Connection PropertiesServer=http://localhost:9000/altairanalytics/xmlaCache=org.olap4j.driver.xmla.cache.TerracottaEhXmlaOlap4jCachecache_query=SELECT NON EMPTY CrossJoin({[Measures].[Total Number of Jobs]}, [Node Dimension.Node Hierarchy].[All].Children) ON COLUMNS, NON EMPTY {[Software Dimension.Software Hierarchy].[All].Children} ON ROWS FROM [PBSWorksWorkLoadAnalyticsCube] WHERE {{ TIME_DIMENSION_VALUE }}

#Decimation Propertiesdecimation=truedecimate-x=150decimate-y=50

#Raw Data Propertiesrawdata_default_sql=SELECT pnp_type as "Prime", roe_source_id as "Job Id", node_event_id as "Event", groupname_id as "Group", customgroup_id as "Custom Group", queuename_id as "Queue", node_id as "Node", vnode_id as "VNode", exitstatusmodified_id as "Exit Status", servername_id as "Server", usr_id as "User", project_id as "Project", softwarename_id as "Software", accountname_id as "Account", architecture_id as "Architecture", nodeclass_id as "Nodeclass", placename_id as "Place" FROM rc_event_resource_occupancy# limit must be greater than zero.rawdata_limit=100

TimeValueFormatterStrategy=com.altair.pbsa.cube.formatter.AdvancedTimeValueFormatterStrategyImpl

#Cube Cache PropertiesupdateCheckIntervalInMinutes=5cubeCacheStrategy=com.altair.pbsa.cache.mondrian.DefaultCubeCacheStrategydiscard-2d-measures=Total Number of Jobs,Unique Usersdiscard-2d-dimensions=Node Event Type Dimension



18.8.1 Changing the decimation defaults

To change the default decimation values, edit the pbsaconfig.properties file and change the value of the decimation defaults for the x and y coordinates.

If the PBSA web application is currently running, then the PBSA web application service will need to be restarted (see section 12.1.3, “Restarting the PBSA web application service”, on page 132) for the changes to be reflected.

Changing these defaults can lead to a slowdown in chart rendering, however if you have a need to analyze the chart data, you may use the PBSA web application to export the data to an excel spreadsheet for further inspection and analysis of the data.

#Decimation Propertiesdecimation=truedecimate-x=150decimate-y=50



18.9 Changing the license schema

During installation of PBSA, there are three licensing options available based on the number of PBS Professional accounting log job records that will be parsed and analyzed (HWU is Hyper Works Units):




For licensing, a job record is not equivalent to a PBS Professional job accounting log "E" record. There is one “licensing record” for every “job node”. For example, a single job that runs on 100 nodes equates to 100 records for licensing. Ten jobs that each use four (4) nodes equates to 40 licensing records. In addition, if a site adds additional data to the PBS Analytics database (not related to jobs), that data is also counted as far as licensing is concerned. For example, if a site adds "node temperature" once per day on 256 nodes, that would add 256 * 365 = 93,440 license records per year.

Over time the licensing schema may need to be changed to accommodate an increase in the number of accounting log job records. If the licensing schema is not upgraded to accommo-date the increased accounting log activity, then the PBSA web application will display the most recent accounting log data up to the amount of data that it is licensed for, effectively fil-tering out any data that exceeds the licensing limit (older data).

Upon upgrading the license schema, all data will become visible, unless the accounting log activity exceeds the newest licensing schema.

Upgrading the license schema can be done by modifying the license.xml file. The loca-tion of this file is:

<INSTALL_DIR>/portal/binaries/framework/services/config

In addition to the license.xml file, there are three other licensing files within this direc-tory. A file for each type of licensing schema:

• license_advanced.xml

• license_base.xml

• license_standard.xml

To change the licensing schema, simply copy the appropriate licensing file to the license.xml file.




18.10 Configuring raw data fields

The PBSA web application can display the raw job data that is used to build a chart. This is done by opening a chart and then clicking the Job Data button on the Chart Title Bar. The raw data displayed is obtained via an SQL query of the PBSA database. The query is stored in the following file:

<INSTALL_DIR>/portal/services/pbsa/config/pbsaconfig.properties

The raw data display can become crowded with information. Elimination of data for a better viewing experience can be done by changing the SQL query. Additional data can included in the query for a more site-specific display of data.

18.10.1 pbsaconfig.properties

Raw Data Propertiesrawdata_default_sql=SELECT pnp_type as "Prime", roe_source_id as "Job Id", node_event_id as "Event", groupname_id as "Group", customgroup_id as "Custom Group", queuename_id as "Queue", node_id as "Node", vnode_id as "VNode", exitstatus_id as "Exit Status", servername_id as "Server", usr_id as "User", project_id as "Project", softwarename_id as "Software", accountname_id as "Account", architecture_id as "Architecture", nodeclass_id as "Nodeclass", placename_id as "Place" FROM rc_event_resource_occupancy# limit must be greater than zero.


P 291

Chapter 18

T web application display name. The fol-l

me

Description

ucket

me taken by the job

ion time

up to which the user belonged

the job

time

time

ord is a Job Busy, Unused or Down

f the job

eaning of the exit code

CPU walltime

hich the user belongs


Advanced Configuration

he SQL Select query defines the data that will be extracted from the database and then maps it to aowing table defines the mapping. Highlighted rows indicate data that is the displayed by default:

Table 18-1: Display name mapped to database na

Display Name Database Column Name

Account accountname_id Specifies the account

Architecture architecture_id Specifies the architecture

CPU Ratio Bucket cputratiobucket_id Specifies the CPU ratio b

CPU Walltime ncpu_walltime Specifies the CPU wallti

Creation Time ctime Specifies the epoch creat

Custom Group customgroup_id Specifies the custom gro

End Date roe_end_datetime Specifies the end time of

Epoch End Time end_time Specifies the epoch end

Epoch Start Time start_time Specifies the epoch start

Event node_event_id Specifies whether the rec

Exis Status exitstatus_id Specifies the exit status o

Exit Reason exit_id Specifies the reason or m

Green CPU Walltime green_ncpu_walltime Specifies the total green

Group Name groupname_id Specifies the group to w

C


er

ket

lltime used

lltime requested

bucket

ltime requested

s used

ich the job ran

for the record

b identifier

e for the job

lusive or not

lls in Prime, Non Prime or Holiday

ter prime non-prime splitting

me

Description

hapter 18 Advanced Configuration

92 PB

Job Id roe_source_id Specifies the job identifi

Memory Bucket memratiobucket_id Specifes the memory buc

Memory Walltime memory_walltime Specifies the memory wa

Memory Walltime Requested job_memory_walltime_requested Specifies the memory wa

NCPU Ratio Bucket ncpusratiobucket_id Specifies the NCPU ratio

Ncpu Walltime Requested job_ncpu_walltime_requested Specifies the NCPU wal

Ncpus Used ncpus_used Specifies the total NCPU

Node node_id Specifies the node on wh

Node Class nodeclass_id Specifies the node class

Original Job Id roe_original_source_id Specifies the unaltered jo

Overall Time job_overall_time Specifies the overall tim

Place placename_id Specifies if the job is exc

Prime pnp_type Specifies if the record fatime window

Prime Non-Prime Walltime pnp_used Specifies the walltime af

Project project_id Specifies the project



P 293

Chapter 18

hich the job was placed

e time

emory

PUs

irtual memory

alltime

ry

l memory

me

hich the job ran

f the job

quested

ed

sted

me

Description



Queue queuename_id Specifies the queue in w

Queue Time qtime Specifies the epoch queu

Resource_List.mem resource_list_memory Specifies the requested m

Resource_List.ncpus resource_list_ncpus Specifies the requested C

Resource_List.vmem resource_list_vmem Specifies the requested v

Resource_List.walltime resource_list_walltime Specifies the requested w

resources_used.mem resources_used_memory Specifies the used memo

resources_used.ncpus resources_used_ncpus Specifies the used cpus

resources_used.vmem resources_used_vmem Specifies the used virtua

resources_used.walltime resources_used_walltime Specifies the used wallti

Server servername_id Specifies the server on w

Software softwarename_id Specifies the software

Start Date roe_start_datetime Specifies the start time o

Total Memory Requested job_memory_requested Specifies the memory re

Total Memory Used job_memory_used Specifies the memory us

Total Ncpu Requested job_ncpu_requested Specifies the ncpu reque



C


walltime

bmitted the job

ory Ratio Bucket

hich the job ran

or the job

tio Bucket

e requested

e used

me

Description


94 PB

Total Ncpu Used job_ncpu_used Specifies the cpus used

Total nodes walltime nodes_walltime Specifies the total nodes

User usr_id Specifies the user who su

Virtual Memory Ratio Bucket vmemratiobucket_id Specifes the Virtual Mem

Vnode vnode_id Specifies the vnode on w

Wait Time job_wait_time Specifies the wait time f

Walltime Ratio Bucket walltimeratiobucket_id Specifes the Walltime Ra

Walltime Requested job_walltime_requested Specifies the total walltim

Walltime Used job_walltime_used Specifies the total walltim




18.10.2 Eliminating data from the display

To eliminate data from the PBSA web application display requires database column names to be removed from the SQL query. For instance, if you are not interested in the job’s exit status, then remove the following database column name from the query (remember to remove the comma following “Exit Status”):

The SQL query will now look like this:


18.10.3 Adding data to the display

To add data to the PBSA web application display, add the database column name to the SQL query, as well as providing a display name for the new column. For instance, if you want to add the number of CPUs used by the job, then add the database column name “ncpus_used” to the SQL query and map it to a display name:

exitstatus_id as "Exit Status",

#Raw Data Propertiesrawdata_default_sql=SELECT pnp_type as "Prime", roe_source_id as "Job Id", node_event_id as "Event", groupname_id as "Group", customgroup_id as "Custom Group", queuename_id as "Queue", node_id as "Node", vnode_id as "VNode", servername_id as "Server", usr_id as "User", project_id as "Project", softwarename_id as "Software", accountname_id as "Account", architecture_id as "Architecture", nodeclass_id as "Nodeclass", placename_id as "Place" FROM rc_event_resource_occupancy

ncpus_used as “Ncpus Used”



The SQL query will now look like this:


18.11 Creating custom queries

Each PBSA chart displays information that is a database query. The PBS Professional accounting log data is parsed, analyzed, and then loaded into a database designed specifically to provide high performance on complex queries against large databases. The queries behind the charts are optimized during parsing to ensure fast chart rendering times. PBSA provides the capability to create custom queries that will also be primed during parsing. These queries can then be used for creating charts using the PBSA web application. These queries are stored in the file:

<INSTALL_DIR>/portal/services/pbsa/config/querycache.xml

Raw Data Propertiesrawdata_default_sql=SELECT pnp_type as "Prime", roe_source_id as "Job Id", node_event_id as "Event", groupname_id as "Group", customgroup_id as "Custom Group", queuename_id as "Queue", node_id as "Node", vnode_id as "VNode", exitstatus_id as "Exit Status", servername_id as "Server", usr_id as "User", project_id as "Project", softwarename_id as "Software", accountname_id as "Account", architecture_id as "Architecture", nodeclass_id as "Nodeclass", placename_id as "Place", ncpus_used as “Ncpus Used” FROM rc_event_resource_occupancy# limit must be greater than zero.



The format of the XML file is:

Each query will map measure against dimensions, and then a filter can be applied, similar to chart building using the web application. For instance, the query: Total Number of Jobs per Node for This Week, would look like this:

Any number of measures can be configured. A maximum of two (2) dimensions, and four (4) filters can be configured for each query. If these limitations are exceeded, or other errors occur with the query (typographical error, invalid measure/dimension combination, etc.), then the entire query will be ignored by PBSA, and a message will be written to the PBSA web application log file - see Chapter 14, "Log files", on page 191.

<configuration> <query> <measures> <measure>MEASURE_KEYWORD</measure> </measures> <dimensions> <dimension>DIMENSION_KEYWORD</dimension> <dimension>DIMENSION_KEYWORD</dimension> </dimensions> <filters> <filter>DIMENSION_KEYWORD</filter> </filters> </query>

</configuration>

<configuration> <query> <measures> <measure>Total Number of Jobs</measure> </measures> <dimensions> <dimension>[Node Dimension.Node Hierarchy].[All].Children </dimension> </dimensions> <filters> <filter>[Advanced Time.This Week].[All].Children</filter> </filters> </query>

</configuration>



Valid values for the MEASURE_KEYWORD are:

• Average CPU Requested • Total Green CPU Walltime

• Average CPU Used • Total Memory Requested

• Average Memory Requested • Total Memory Used

• Average Memory Used • Total Memory Walltime Requested

• Average Memory Walltime Requested • Total Memory Walltime Used

• Average Memory Walltime Used • Total Node Walltime

• Average Overall Time • Total Number of Jobs

• Average Wait Time • Total Number of Queued Cores

• Average Walltime Requested • Total Overall Time

• Average Walltime Used • Total Wait Time

• Total CPU Requested • Total Walltime Requested

• Total CPU Used • Total Walltime Used

• Total CPU Walltime • Unique Users


P 299

Chapter 18

V

d

WORD

ildren

Children

hildren

ildren

ldren



alid values for the DIMENSION_KEYWORD are:

Table 18-2: Dimension name mapped to keywor

Dimension Name DIMENSION_KEY

Time [Time Dimension.Time Hierarchy].[All].Children

Year [Time Dimension.Time Hierarchy].[Year].[All].Ch

Quarter [Time Dimension.Time Hierarchy].[Quarter].[All].

Month [Time Dimension.Time Hierarchy].[Month].[All].C

Week [Time Dimension.Time Hierarchy].[Week].[All].Ch

Day [Time Dimension.Time Hierarchy].[Day].[All].Chi

Time-Advanced Last Year [Advanced Time.Last Year].[All].Children

Time-Advanced This Year [Advanced Time.This Year].[All].Children

Time-Advanced Last Quarter [Advanced Time.Last Quarter].[All].Children

Time-Advanced This Quarter [Advanced Time.This Quarter].[All].Children

Time-Advanced Last Month [Advanced Time.Last Month].[All].Children

Time-Advanced This Month [Advanced Time.This Month].[All].Children

Time-Advanced Last Week [Advanced Time.Last Week].[All].Children

Time-Advanced This Week [Advanced Time.This Week].[All].Children

Time-Advanced Yesterday [Advanced Time.Yesterday].[All].Children

C


y].[All].Children

ll].Children

erarchy].[All].Children

erarchy].[5]

erarchy].[6]

n

ldren

All].Children

].Children

n

].Children

ildren

d

WORD


00 PB

Time-Advanced Today [Advanced Time.Today].[All].Children

Custom Group [CustomGroup Dimension.CustomGroup Hierarch

Exit Reason [Exit Reason Dimension.Exit Reason Hierarchy].[A

Node Event Type (All Event Types) [Node Event Type Dimension.Node Event Type Hi

Node Event Type (Event Type=JOB BUSY)

[Node Event Type Dimension.Node Event Type Hi

Node Event Type (Event Type=UNUSED) [Node Event Type Dimension.Node Event Type Hi

Queue [Queue Dimension.Queue Hierarchy].[All].Childre

Account [Account Dimension.Account Hierarchy].[All].Chi

Architecture [Architecture Dimension.Architecture Hierarchy].[

Exit Status [Exit Status Dimension.Exit Status Hierarchy].[All

Group [Group Dimension.Group Hierarchy].[All].Childre

Node Class [NodeClass Dimension.NodeClass Hierarchy].[All

Place [Place Dimension.Place Hierarchy].[All].Children

Software [Software Dimension.Software Hierarchy].[All].Ch

User [User Dimension.User Hierarchy].[All].Children



P 301

Chapter 18

en

n

All].Children

ierarchy].[All].Children

archy].[All].Children

rchy].[All].Children

hy].[All].Children

rarchy].[All].Children

d

WORD



Time-Holiday [Day Dimension.Holiday Hierarchy].[All].Children

Project [Project Dimension.Project Hierarchy].[All].Childr

Server [Server Dimension.Server Hierarchy].[All].Childre

Node [Node Dimension.Node Hierarchy].[All].Children

Virtual Node [Virtual Node Dimension.VirtualNode Hierarchy].[

Prime (Prime=ALL) [Prime Dimension.Prime Hierarchy].[All].Children

Prime (Prime=Prime time hours) [Prime Dimension.Prime Hierarchy].[7]

Prime (Prime=Non prime time evening) [Prime Dimension.Prime Hierarchy].[8]

Prime (Prime=Non prime time mornings) [Prime Dimension.Prime Hierarchy].[9]

Prime (Prime=Holiday and weekends) [Prime Dimension.Prime Hierarchy].[10]

CPU Time Bucket [CPU Time Bucket Dimension.CPU Time Bucket H

Memory Bucket [Memory Bucket Dimension.Memory Bucket Hier

NCPUS Bucket [NCPUS Bucket Dimension.NCPUS Bucket Hiera

VMem Bucket [VMem Bucket Dimension.VMem Bucket Hierarc

Walltime Bucket [Walltime Bucket Dimension.Walltime Bucket Hie




PBSA supports two types of measures: additive and non-additive. Specific dimensions are supported within each measures category. You must pair a measure with a supported dimen-sion within a query. For instance based on the table below, a query can be created that requests the Total Number of Jobs per Node. However, you cannot create a query that requests the Total Memory Used per Node, because Node is not a supported dimension for a non-additive measure.

Table 18-3: Measures and supported Dimensions

Measures Supported Dimensions

Additive Measures:

Total Number of Jobs

Total CPU Walltime

Total Green CPU Walltime

Total Memory Walltime Used

Average Memory Walltime Used

Total Node Walltime

Time

Advanced Time

CustomGroup

Exit Reason

Node Event Type

Queue

Account

Architecture

Exit Status

Group

NodeClass

Place

Software

User

Day

Project

Server

Node

Virtual Node

Prime

CPU Time Bucket

Memory Bucket

NCPUS Bucket

VMem Bucket

Walltime Bucket



Non-additive Measures:

Total Walltime Requested

Total Memory Walltime Requested

Total Overall Time

Total Wait Time

Total Walltime Used

Total Memory Requested

Total Memory Used

Total CPU Requested

Total CPU Used

Total Number of Queued Cores

Unique Users

Average Walltime Used

Average Walltime Requested

Average Memory Walltime Requested

Average Overall Time

Average Wait Time

Average Memory Used

Average Memory Requested

Average CPU Used

Average CPU Requested

Time

Advanced Time

CustomGroup

Exit Reason

Node Event Type

Queue

Account

Architecture

Exit Status

Group

NodeClass

Place

Software

User

Day

Project

Server

Table 18-3: Measures and supported Dimensions

Measures Supported Dimensions



18.11.1 Examples queries

In this example the query will retrieve the Total Wait Time by User by Queue for the current year.

In this example the query will retrieve the Total Node Walltime by Node where the node event type is “JobBusy” for the current year.

<configuration> <query> <measures> <measure>Total Wait Time</measure> </measures> <dimensions> <dimension>[User Dimension.User Hierarchy].[All].Children </dimension> <dimension>[Queue Dimension.Queue Hierarchy].[All].Children </dimension> </dimensions> <filters> <filter>[Advanced Time.This Year].[All].Children</filter> </filters> </query>

</configuration>

<configuration> <query> <measures> <measure>Total Node Walltime</measure> </measures> <dimensions> <dimension>>[Node Dimension.Node Hierarchy].[All].Children </dimension> <dimension>>[Node Event Type Dimension.Node Event Type Hierarchy].[5]</dimension> </dimensions> <filters> <filter>[Advanced Time.This Year].[All].Children</filter> </filters> </query></configuration>


Chapter 19

Reparsing the accounting logsFor documentation purposes, the PBSA installation directory will be denoted by <INSTALL_DIR>. The installation directory for a typical installation of PBSA is:

/opt/pbsworks/12.2

If there is a need to discard the data created from the initial parsing cycle and reparse the PBS Professional accounting logs, stop the PBSA web application and data collectors.

19.1 Deployment on a single machine

If the web application and the data collector have been deployed on the same machine, then use the PBSA dataset reset command to discard the data from the previous parsing cycle.

pbsa-data-reset

For more information see section 13.7, “Resetting the PBSA dataset”, on page 179.

Execute the following command, as the root user, to delete PBSA data transportation history files. These files indicate which PBS Professional accounting log files were previously trans-ported to the web application.

pbsa-dc-data-reset

For more information see section 13.8, “Resetting the data collector dataset”, on page 184.

The pbsa-data-reset command resets the PBSA database password back to “pbsworks@123”. You can use the pbsa-data-password command to change the default.


Chapter 19 Reparsing the accounting logs

Now, modify the PBSA configuration if necessary, and run the parsing cycle again by first starting the web application followed by the data collector.

19.2 Deployment on separate machines

If the web application and the data collectors have been deployed on separate machines, then discard the data from the previous parsing cycle by using the PBSA dataset reset command. This command must be issued on the machine where the PBSA web application has been deployed.

pbsa-data-reset

For more information see section 13.7, “Resetting the PBSA dataset”, on page 179.

Execute the following command, as the root user, on each machine where a data collector has been deployed. This command will delete PBSA data transportation history files. These files indicate which PBS Professional accounting log files were previously transported to the web application.

pbsa-dc-data-reset

For more information see section 13.8, “Resetting the data collector dataset”, on page 184.

Now, modify the PBSA configuration if necessary, and run the parsing cycle again by first starting the web application followed by the data collectors.

This pbsa-data-reset command resets the PBSA database password back to “pbsworks@123”. You can use the pbsa-data-password command to change the default.


Chapter 20

Disaster RecoveryThis chapter provides guidance on how to backup and restore PBS Analytics 12.2 in case of a server hardware failure. Three components are required to be backed up:

• PBSA web application and parser

• PBSA data collector

For documentation purposes, the PBSA installation directory will be denoted by <INSTALL_DIR>. The installation directory for a typical installation of PBSA is:

/opt/pbsworks/12.2

20.1 Backing up PBSA

It is highly recommended to backup PBSA onto a backup machine or to disk so that if the pro-duction machine or disk fails it does not affect the backup.


Chapter 20 Disaster Recovery

20.1.1 Backing up the web application and parser

Perform these steps on the machine where the PBSA web application and parser have been deployed:

1. Verify that parsing of the PBS Professional accounting logs is not currently in prog-ress - see section 7.7, “Parsing the accounting logs”, on page 103).

2. As the root user, stop the PBSA web application and parser - see Chapter 12, "PBSA service commands", on page 131.

3. On the backup machine, create a backup directory structure as shown in Figure 20-1.

Figure 20-1:.Backup directory structure


Disaster Recovery Chapter 20

4. Login to the server where the web application and parser has been deployed using the login credentials of the PBSA service user (specified during the installation).

5. Zip the <INSTALL_DIR>/portal directory and copy it to the PBSA-backup-YYYY-MM-DD/analytics-engine/portal directory on the backup machine/disk. Make sure there are no errors or warnings at the time of the zipping operation.

6. If PBSA is being backed up to an Operating System which is different from the one on which it is installed, perform the database dump manually, and copy the database dump file to the PBSA-backup-YYYY-MM-DD/analytics-engine/dbdump directory - see section 20.3, “Backing up the PBSA database”, on page 311.

7. Copy /etc/init.d/pbsworks-pbsa to the PBSA-backup-YYYY-MM-DD/analytics-engine/init.d directory.

8. Copy /etc/pbsworks-pbsa.conf to the PBSA-backup-YYYY-MM-DD/analytics-engine/conf directory.

20.1.2 Backing up the data collectors

Perform these steps on all machines where the PBSA data collector has been deployed:

1. As the root user, stop all PBSA data collectors - see Chapter 12, "PBSA service com-mands", on page 131.

2. On the backup machine, create a backup directory structure as shown in Figure 20-1 for every data collector installed. Create a unique directory called PBSA-backup-YYYY-MM-DD/analytics-datacollector-<DC_HOSTNAME>.

3. Login to the machine where the data collector has been deployed using the login cre-dentials of the PBSA service user (specified during the installation of PBSA).

4. Zip the <INSTALL_DIR>/dc directory and copy it to the PBSA-backup-YYYY-MM-DD/analytics-datacollector-<DC_HOSTNAME>/dc direc-tory on the backup machine/disk. Make sure there are no errors or warnings at the time of the zipping operation.

5. Copy /etc/init.d/pbsworks-dc to the PBSA-backup-YYYY-MM-DD/analytics-datacollector-<DC_HOSTNAME>/init.d directory.

6. Copy /etc/pbsworks-dc.conf to the PBSA-backup-YYYY-MM-DD/ana-lytics-datacollector-<DC_HOSTNAME>/conf directory.

Now that all components have been backed up, start the PBSA web application, parser, and the data collectors as the root user.



20.2 Restoring PBSA

20.2.1 Restoring the web application and parser

1. Verify that the previous installation of PBSA is completely removed. - see Chapter 6, "Uninstalling PBSA", on page 93.

2. Use the latest backup of PBSA for the restoration. The latest backup is determined by the backup date in the folder name.

3. Login to the server where the web application and parser has been deployed using the login credentials of the PBSA service user (specified during the installation).

4. Unzip the portal directory from the PBSA-backup-YYYY-MM-DD/analyt-ics-engine/portal directory into the <INSTALL_DIR>/portal direc-tory. Make sure there are no errors or warnings at the time of the unzipping operation.

5. If PBSA is being backed up to an Operating System which is different from the one on which it is installed, use the database dump file from the PBSA-backup-YYYY-MM-DD/analytics-engine/dbdump directory to restore the database - seesection 20.4, “Restoring the PBSA database”, on page 312.

6. Copy PBSA-backup-YYYY-MM-DD/analytics-engine/init.d/pbsworks-pbsa to /etc/init.d/pbsworks-pbsa.

7. Copy PBSA-backup-YYYY-MM-DD/analytics-engine/conf/pbsworks-pbsa.conf to /etc/pbsworks-pbsa.conf.

20.2.2 Restoring the data collectors

Perform these steps on all machines where the PBSA data collector has been deployed:

1. Unzip the dc directory from the PBSA-backup-YYYY-MM-DD/analytics-datacollector-<DC_HOSTNAME>/dc directory into the <INSTALL_DIR>/dc directory. . Make sure there are no errors or warnings at the time of the unzip-ping operation.

2. Copy PBSA-backup-YYYY-MM-DD/analytics-datacollector-<DC_HOSTNAME>/init.d/pbsworks-dc to /etc/init.d/pbsworks-dc.

3. Copy PBSA-backup-YYYY-MM-DD/analytics-datacollector-<DC_HOSTNAME>/conf/pbsworks-dc.conf to /etc/pbsworks-dc.conf.



20.3 Backing up the PBSA database

It is highly recommended to backup the PBSA database to a backup machine or to disk so that if the production machine or disk fails it does not affect the backup.


1. Verify that parsing of the PBS Professional accounting logs is not currently in prog-ress - see section 7.7, “Parsing the accounting logs”, on page 103.

2. As the root user, stop the PBSA web application, parser, and data collectors - see Chapter 12, "PBSA service commands", on page 131.

3. Run the following command:

export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:<INSTALL_DIR>/portal/third-party/monetdb/lib/

4. Navigate to the following directory by running the command:

cd <INSTALL_DIR>/portal/thirdparty/monetdb/scripts

5. Start the database service by running the command:

./startmonetdb.sh <INSTALL_DIR>/portal/thirdparty/monetdb pbsworksdata


cd <INSTALL_DIR>/portal/thirdparty/monetdb/bin

7. Run the command:

./mclient -p 9200 -d pbsworksdb -D > <BACKUP_LOCATION>/pbsworksdb.sql

8. You will be prompted to enter a user id and password. Enter the database super user “pbsworks” and the super user password.



10. Stop the database service by running the command:

./stopmonetdb.sh <INSTALL_DIR>/portal/thirdparty/monetdb pbsworksdata

11. As the root user, start the PBSA web application, parser, and data collectors - see Chapter 12, "PBSA service commands", on page 131.



20.4 Restoring the PBSA database


1. Verify that parsing of the PBS Professional accounting logs is not currently in prog-ress - see section 7.7, “Parsing the accounting logs”, on page 103.

2. As the root user, stop the PBSA web application, parser, and data collectors - see Chapter 12, "PBSA service commands", on page 131.

3. If you are restoring from a different operating system, perform the following steps.

a. Unzip the PBSA installer binary to a temporary directory:

unzip PBSA_12.2_Linux_x86_64.bin -d /tmp/pbsa_installer

b. Navigate to /tmp/pba_installer/$IA_PROJECT_DIR$/repo/mon-etdb_linux64.

c. Unzip the monetdb_64.zip file to a temporary directory:

unzip monetdb_64.zip -d /tmp/monetdb_64

d. If you are restoring the database to a CentOS platform, then:

- copy the /tmp/monetdb_64/bin directory to <INSTALL_DIR>/por-tal/thirdparty/monetdb.

- copy the /tmp/monetdb_64/lib directory to <INSTALL_DIR/por-tal/thirdparty/monetdb.

e. If you are restoring the database to a SUSE platform, then:

- copy the /tmp/monetdb_64/bin_SuSE10 directory to <INSTALL_DIR>/portal/thirdparty/monetdb.

- copy the /tmp/monetdb_64/lib_SuSE10 directory to <INSTALL_DIR>/portal/thirdparty/monetdb.

- Remove the directory <INSTALL_DIR/portal/thirdparty/mon-etdb/bin

- Remove the directory <INSTALL_DIR>/portal/thirdparty/mon-etdb/lib.

- Rename the directory <INSTALL_DIR>/portal/thirdparty/mon-etdb/bin_SuSE10 to <INSTALL_DIR>/portal/thirdparty/monetdb/bin.

- Rename the directory <INSTALL_DIR>/portal/thirdparty/mon-etdb/lib_SuSE10 to <INSTALL_DIR>/portal/thirdparty/



monetdb/lib.


export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:<INSTALL_DIR>/portal/third-party/monetdb/lib/

5. Navigate to the following directory:


6. Start the database service:

./startmonetdb.sh <INSTALL_DIR>/portal/thirdparty/monetdb pbsworksdata

7. Navigate to the following:

cd <INSTALL_DIR>/portal/thirdparty/monetdb/bin


./mclient -p 9200 -d pbsworksdb < <BACKUP_LOCATION>/pbsworksdb.sql

9. You will be prompted to enter a user id and password. Enter the database super user “pbsworks” and the super user password.

10. Navigate to the following directory by issuing the following command:


11. Stop the database service by issuing the following command:

./stopmonetdb.sh <INSTALL_DIR>/portal/thirdparty/monetdb pbsworksdata

12. As the root user, start the PBSA web application, parser, and data collectors - see Chapter 12, "PBSA service commands", on page 131.


IndexAadminSettings.xml 279, 280, 283Advanced Configuration 221, 222, 226, 229, 237, 243, 269

custom group configuration file 229custom resource configuration file 237exit status configuration file 226holiday configuration file 221, 222, 269node detail configuration file 243

advanced configuration 103, 116, 121application definitions 154application metrics 16

Cchange database password 186, 187Changing the accounting log location 284Changing the license schema 289Changing web application hostname

port 284chart rendering 286classifying PBS Professional nodes 15COMMAND_HOME 99config.xml 169Configuraiton files

holiday configuration file 219configuration 105Configuration files 219

configuring custom groups 115, 154, 155, 156, 158, 159, 229configuring custom resources 116, 237configuring data collector 169, 171configuring exit statuses 116, 165, 167, 226configuring holidays 112, 128, 143, 148, 150, 219, 269configuring JVM performance 281, 282

data collector 282web application 281

configuring logging 275configuring node details 243configuring nodes 106, 112, 128, 135, 136, 138, 140configuring parser 103, 121, 174, 176, 177configuring plot point decimation 286configuring prime time hours 113, 221, 222configuring SSL 269, 270, 271, 273

SSL over secure open port 271SSL over secure open port with redirec-

tion 273configuring the license server 277, 279custom group configuration file 154custom groups 111, 115custom resources 111, 116custom_group_YYYY.conf 154, 229customresources.conf 237


Index

Ddaily parsing 15data collector log file 122data reset 305dc.log 122decimation 286default custom group 154, 155, 229deployment options 7

demonstration database 7, 10separate servers 7, 9single server 7, 8

dimensions 193disaster recovery 307downsampling 286

Eexit status 111exit statuses 116exit_status.conf 226

FfactorySettings.xml 277, 278

Hhardware requirements 2

CPUs 2disk space 2licensing 2RAM 2

holiday configuration file 143, 148, 150holiday_YYYY.conf 143holidays 111, 128holidays_YYYY.conf 219, 269

Iinitial parsing 14, 127installation 11installation directory 99installing PBSA 19, 36, 51, 63, 76, 86

console mode 63, 76, 86separate servers 76, 86

install data collector 86install web application 76

single server 63swing mode 19, 36, 51

separate servers 36, 51install data collector 51install web application 36

single server 19

JJAVA_HOME 269

Kkeystore file 269, 270

Llog file size 275log files 191log4j.properties 275logging 275logging backup files 275logging behavior 275

Mmeasures 193modules.xml 169

Nnode configuration 106, 112, 128node details 105node details configuration file 135, 136, 138, 140nodeclass metrics 15nodedetails_YYYY.conf 135, 243non-prime time hours 111, 113

OOTHERS 155, 229

Pparser log file 122


Chapter 21

parser.log 122parsing 14, 15, 125

daily 15initial 14

parsing accounting logs 122PBS Analytics™ 1PBS Professional 11.2 154PBS Professional considerations 15

application metrics 16nodeclass metrics 15project metrics 16

PBSA Commands 103, 113, 115, 116, 121, 128, 135, 136, 138, 140, 143, 148, 150, 154, 155, 156, 158, 159, 165, 167, 169, 171, 174, 176, 177, 179, 180, 184, 186, 187

change database password 186, 187configuring custom groups 115, 154, 155, 156, 158, 159

modification after initial parsing 155configuring data collector 169, 171configuring exit statuses 116, 165, 167configuring holidays 128, 143, 148, 150configuring nodes 128, 135, 136, 138, 140configuring parser 174, 176, 177configuring prime time hours 113configuring the parser 103, 121resetting PBSA dataset 179, 180, 184

PBSA components 7data collector 7web application 7

PBSA configuration files 116custom resource 116

PBSA service commands 131, 132, 133, 134restarting data collector 133, 134restarting web application 131, 132starting data collector 133starting web application 131status of data collector 134status of web application 132stopping data collector 133stopping web application 131

pbsa-cofig-dc error messages 171, 177pbsa-config-dc 169, 171pbsa-config-dc examples 171pbsa-config-dc usage 169


Chapter 21

pbsa-config-exits 116, 165, 167pbsa-config-exits error messages 167pbsa-config-exits examples 165pbsa-config-groups 115, 154, 155, 156, 158, 159pbsa-config-groups error messages 159pbsa-config-groups examples 158pbsa-config-groups usage 155, 156pbsa-config-holidays 112, 113, 128, 143, 148, 150pbsa-config-holidays error messages 150pbsa-config-holidays examples 148pbsa-config-holidays usage 143pbsa-config-nodes 128, 135, 136, 138, 140pbsa-config-nodes error messages 140pbsa-config-nodes examples 138pbsa-config-nodes usage 136pbsa-config-parser 103, 121, 174, 176, 177pbsa-config-parser examples 176pbsa-config-parser usage 174pbsa-data-password 186, 187pbsa-data-password error messages 187pbsa-data-password uage 186pbsa-data-reset 179, 180, 184pbsa-data-reset error messages 180, 184pbsa-data-reset examples 180, 184, 186pbsa-data-reset usage 179, 184pbs-config-nodes 106, 112pbsnodes -av 106, 112, 135, 136, 138, 140pbsnodes.out 106, 112PBSWORKS_CONF_FILE 99pbsworks-dc 133, 134pbsworks-dc-start.sh 282pbsworks-pbsa 131, 132pbsworks-pbsa.conf 99post-installation 99, 103, 105, 106, 111, 112, 113, 115, 116, 121, 122, 125, 127, 128, 286

advanced configuration 103, 121, 286configuration 106, 112, 113, 115, 116, 128parsing accounting logs 122, 127PBSA environment 99starting PBSA 103, 121, 122, 127


Chapter 21

pre-installation planning 11, 14, 15, 16configuration 14installation 11parsing 14, 15PBS Professional considerations 15, 16

prime time hours 111, 113project level utilization 154project metrics 16

Qqsub -P 154

Rreparsing 305resetting PBSA dataset 179, 180, 184restarting data collector 133, 134restarting web application 131, 132

Sserver-start.sh 281SSL certification 270SSL over a secure open port 271SSL over a secure open port with redirection 273start 119starting data collector 103, 121, 133starting PBSA 103, 121, 122starting web application 103, 121, 131status of data collector 134status of web 132Still-Running 226stopping data collector 133stopping web application 131supported platforms 5

browsers 5operating systems 5

system requirements 2

Ttroubleshooting 209


Chapter 21

Uuninstalling PBSA 93

swing mode 93


PBS Analytics 12.2 Administrator’s...

Documents

Transcript of PBS Analytics 12.2 Administrator’s...