Report Gateway. User Guide. Document 5141

Transcription

1

2 Notice Copyright Notice Copyright 2003 by Aprisma Management Technologies, Inc. All rights reserved worldwide. Use, duplication, or disclosure by the United States government is subject to the restrictions set forth in DFARS (c)(1)(ii) and FAR Liability Disclaimer Aprisma Management Technologies, Inc. ( Aprisma ) reserves the right to make changes in specifications and other information contained in this document without prior notice. In all cases, the reader should contact Aprisma to inquire if any changes have been made. The hardware, firmware, or software described in this manual is subject to change without notice. IN NO EVENT SHALL APRISMA, ITS EMPLOYEES, OFFICERS, DIRECTORS, AGENTS, OR AFFILIATES BE LIABLE FOR ANY INCIDENTAL, INDIRECT, SPECIAL, OR CONSEQUENTIAL DAMAGES WHATSOEVER (INCLUDING BUT NOT LIMITED TO LOST PROFITS) ARISING OUT OF OR RELATED TO THIS MANUAL OR THE INFORMATION CONTAINED IN IT, EVEN IF APRISMA HAS BEEN ADVISED OF, HAS KNOWN, OR SHOULD HAVE KNOWN, THE POSSIBILITY OF SUCH DAMAGES. Trademark, Service Mark, and Logo Information SPECTRUM, IMT, and the SPECTRUM IMT/VNM logo are registered trademarks of Aprisma Management Technologies, Inc., or its affiliates. APRISMA, APRISMA MANAGEMENT TECHNOLOGIES, the APRISMA MANAGEMENT TECHNOLOGIES logo, MANAGE WHAT MATTERS, DCM, VNM, SpectroGRAPH, SpectroSERVER, Inductive Modeling Technology, Device Communications Manager, SPECTRUM Security Manager, and Virtual Network Machine are unregistered trademarks of Aprisma Management Technologies, Inc., or its affiliates. For a complete list of Aprisma trademarks, service marks, and trade names, go to: All referenced trademarks, service marks, and trade names identified in this document, whether registered or unregistered, are the intellectual property of their respective owners. No rights are granted by Aprisma Management Technologies, Inc., to use such marks, whether by implication, estoppel, or otherwise. If you have comments or concerns about trademark or copyright references, please send an to spectrum-docs@aprisma.com; we will do our best to help. Restricted Rights Notice (Applicable to licenses to the United States government only.) This software and/or user documentation is/are provided with RESTRICTED AND LIMITED RIGHTS. Use, duplication, or disclosure by the government is subject to restrictions as set forth in FAR (June 1987) Alternate III(g)(3) (June 1987), FAR (June 1987), or DFARS (c)(1)(ii) (June 1988), and/or in similar or successor clauses in the FAR or DFARS, or in the DOD or NASA FAR Supplement, as applicable. Contractor/manufacturer is Aprisma Management Technologies, Inc. In the event the government seeks to obtain the software pursuant to standard commercial practice, this software agreement, instead of the noted regulatory clauses, shall control the terms of the government's license. Virus Disclaimer Aprisma makes no representations or warranties to the effect that the licensed software is virus-free. Aprisma has tested its software with current virus-checking technologies. However, because no antivirus system is 100-percent effective, we strongly recommend that you write protect the licensed software and verify (with an antivirus system with which you have confidence) that the licensed software, prior to installation, is virus-free. Contact Information Aprisma Management Technologies, Inc., 273 Corporate Drive, Portsmouth, NH USA Phone: U.S. toll-free: Web site: Page 2

3 Contents Notice... 2 Preface... 6 Intended Audience... 6 Text Conventions... 6 Document Feedback... 7 Online Documents... 7 Overview... 8 Introduction... 8 Round Robin Databases (RRD)... 9 SPECTRUM (SRG) Operation... 9 Installation and Setup Installation Recommendations and Requirements...11 Minimum Requirements for SPECTRUM...11 Implementing SPECTRUM...12 Downloading the Required SRG Accessory Pack...13 Data Collector: SSLogger Setup...13 Recommended SSLogger Setup Parameters...13 Data Miner: Setup...14 Setting up on a Standalone Windows Machine...14 Setting up on a Standalone Solaris Machine...16 Data Graphing Utility: Cacti...18 Windows Installation...19 Solaris Installation...23 Creating Graphs With Cacti Injecting RRD Information Into Cacti...29 Inject RRD Information Into Cacti via the Command Line...30 Data Sources...31 Building a Graph...32 Page 3

4 Adding a Graph to the Graph Hierarchy...35 Service Performance Manager and Introduction...38 Installation and Setup...39 Data Collector: SPM with Data Logging Enabled...39 Data Miner: SPM Setup...40 Configuring SPM with Web Operator on Windows...40 Configuring SPM with Web Operator on Solaris...42 Data Grapher: Cacti...44 Appendix A: Sample Configurations Sample Configuration SSLogger models File...45 sslogger.dat File...45 SRG.conf File...47 Sample Configuration SSLogger models File...49 sslogger.dat File...49 SRG.conf File...50 Sample Configuration SSLogger models File...52 sslogger.dat File...52 SRG.conf File...53 Appendix B: Configuration Parameter Definitions The SRG.conf File...56 Location of SSLogger Files...56 RRD Configuration Files...56 Data Collection Options...57 Trend Analysis Options...57 Page 4

5 Sample SRG.conf Configuration File...57 Configuration Parameter Definitions...60 Appendix C: Sample SRG_SPM Configurations SRG_SPM.conf Sample Configuration...69 Configuration Parameter Definitions...70 Appendix D: Frequently Asked Questions Running SRG Independently...73 Installing SPECTRUM and SRG on Machines with Different Operating Systems...73 Changes to SSLogger Files on Remote Machine...73 Running Web Operator with SRG and Cacti on a Machine Separate from SPECTRUM...73 General SSLogger Tips...74 Trending and SRG...74 Index Page 5

6 Preface In This Section Intended Audience [page 6] Text Conventions [page 6] Document Feedback [page 7] Online Documents [page 7] Intended Audience This guide is intended for users of the SPECTRUM. Text Conventions The following text conventions are used in this document: Element Convention Used Example Variables (The user supplies a value for the variable.) The directory where you installed SPECTRUM (The user supplies a value for the variable.) Courier and Italic in angle brackets (<>) <$SPECROOT> Type the following: DISPLAY=<workstation name>:0.0 export display Navigate to: <$SPECROOT>/app-defaults Solaris and Windows directory paths Unless otherwise noted, directory paths are common to both operating systems, with the exception that slashes (/) should be used in Solaris paths, and backslashes (\) should be used in Windows paths. <$SPECROOT>/app-defaults on Solaris is equivalent to <$SPECROOT>\app-defaults on Windows. On-screen text Courier The following line displays: path= /audit User-typed text Courier Type the following path name: C:\ABC\lib\db Page 6

7 Element Convention Used Example Cross-references References to SPECTRUM documents (title and number) Underlined and hypertextblue Italic See Document Feedback [page 7]. SPECTRUM Installation Guide (0675) Document Feedback Please send feedback regarding SPECTRUM documents to the following address: Thank you for helping us improve our documentation. Online Documents SPECTRUM documents are available online at: Check this site for the latest updates and additions. Page 7

8 Overview This section introduces the SPECTRUM (SRG). The SRG was designed to create Round Robin Databases (RRD) based on SSLogger configuration and data files. In This Section Introduction [page 8] Round Robin Databases (RRD) [page 9] SPECTRUM (SRG) Operation [page 9] Introduction SPECTRUM s SSLogger tool (discussed in detail in the SSLogger 5071) is a SPECTRUM command-line application that works in tandem with the SpectroSERVER to poll network devices and log the polled data to files suitable for import into databases and reporting systems. Because SSLogger records data to flat-files with hex notation, these files can become extremely large and difficult to analyze with no means of efficient archiving or reporting. With the SPECTRUM (SRG), Aprisma has provided one solution to these issues by building a gateway to convert and archive raw SSLogger data into Round Robin Databases (RRD) [page 9]. Once SSLogger data is in RRD format, there are many different tools and utilities available to generate graphical reports. The SRG utilizes SSLogger as its data-collection engine, RRDtool as a means of efficient SpectroSERVER data storage (RRD creation), and Cacti or DDRAW to graph the resulting data sets. Note: RRDtool, Cacti, and DRRAW are open-source applications (available under the terms of the GNU General Public License) used with the SPECTRUM. These and other referenced opensource products are not designed, developed, or supported by Aprisma Management Technologies. However, for your convenience, this document includes installation instructions for these products. Page 8

9 Round Robin Databases (RRD) A Round Robin Database (RRD) is a system for storing and displaying timeseries data (for example, network bandwidth, router CPU, or average server load). An RRD stores data in a very compact way that does not expand over time, and can present useful graphs by processing the data to enforce a certain data density. SPECTRUM (SRG) Operation The SPECTRUM (SRG) creates Round-Robin-Databases based on the SSLogger configuration and raw data files. Once SSLogger is properly configured and running, the SRG only needs read access to or a copy of the SSLogger configuration and raw data files. The SPECTRUM reads the SSLogger configuration files (the model and sslogger.dat files) to convert hexadecimal model handles and attribute IDs to model names and attribute names, respectively, before creating and populating the Round Robin Database(s). This is done so that all data sources (attributes) in the RRDs have meaningful names instead of hexadecimal values. The SPECTRUM also reads the SRG configuration file at runtime (SRG.conf). This file can be used to customize RRD database configurations. SRG calls RRDTool when creating, updating, and/or accessing any RRD. When SRG is run for the first time, it creates a RRD for each device or port listed in the SSLogger models file. On subsequent runs, it simply updates the pre-existing RRDs or, if any new models or data sources are found in the models, sslogger.dat, SRG.conf file, and/or in the SSLog.log raw data file, SRG will dynamically create/add the new RRD/data source to the appropriate RRD. Scheduling SRG to update all RRDs with new SSLogger data can be done on both Windows and Solaris by setting the on_rotate_execute parameter in the SSLogger.dat file. You can also schedule SRG updates by using a cron job on Solaris or by setting up a scheduled task on Windows. At the end of each RRD update, SRG records information to a series of log files (i.e..srg_history) indicating the work completed as well as any error messages. This verifies which SSLogger files have been archived into Round-Robin-Databases. In SPECTRUM Service Pack 5 and later, SRG can perform trending calculations based on historical data. That is, SRG can mine historical data from specified data-sources or RRD files, average the retrieved values, and Page 9

10 store the calculated result(s) in newly created RRD file(s). This trend data can then be graphed with current, real-time data for quantitative analysis and comparison based on historical trends. For additional details see Trend Analysis Options [page 57]. Page 10

11 Installation and Setup The following section describes installation and setup procedures for running the SPECTRUM (SRG) on Windows and Solaris platforms. In This Section Installation Recommendations and Requirements [page 11] Implementing SPECTRUM [page 12] Downloading the Required SRG Accessory Pack [page 13] Data Collector: SSLogger Setup [page 13] Data Miner: Setup [page 14] Data Graphing Utility: Cacti [page 18] Installation Recommendations and Requirements To avoid adding additional workload to the SpectroSERVER, Aprisma recommends installing the, web server, and data graphing utility (Cacti or DRRAW) together on a standalone machine. This also provides a single location to store and archive old SSLogger data files. This machine must have access to the SPECTRUM SSLogger machine as well as the SSLogger raw data files. Minimum Requirements for SPECTRUM Before installing the SPECTRUM on a dedicated machine, make sure your Solaris or Windows workstation meets the minimum requirements listed in Table 1: SRG Minimum System Requirements (Solaris), or Table 2: SRG Minimum System Requirements (Windows). For more precise system requirements specific to your service assurance needs, please contact your Aprisma technical representative or authorized Aprisma Channel Partner. Page 11

12 Table 1: SRG Minimum System Requirements (Solaris) Component Requirement Operating System Solaris 8 or 9 Processor Free Hard Disk Space RAM UltraSparc series 400MHz or higher 10 GB 512 MB Table 2: SRG Minimum System Requirements (Windows) Component Operating System Processor Free Hard Disk Space RAM Requirement Windows 2000, Windows XP, or Windows 2003 Server 800 MHz Pentium III 10 GB 512 MB Implementing SPECTRUM Three major components are required to complete an end-to-end implementation of the : 1. Data Collector: Properly configured and running SSLogger. See Data Collector: SSLogger Setup [page 13]. 2. Data Miner: Properly installed and scheduled using RRDTool. See Data Miner: Setup [page 14]. 3. Data Grapher: Properly configured web server with 3rd-party webbased graph generation tool (i.e. open-source Cacti or DRRAW). See Data Graphing Utility: Cacti [page 18] Note: Many different open-source RRD-Tool graphing tools are available. However, Aprisma has found Cacti to be the most powerful. For this reason, installation and setup instructions for Cacti have been included in this guide. Page 12

13 Downloading the Required SRG Accessory Pack For your convenience (and required under the terms of the GNU General Public License), Aprisma has pre-packaged all required open-source software. This SRG Accessory Pack is available for download at: The RRDTool binary executable for both Windows and Solaris is included with SRG. Both SRG and RRDTool can be found in the following directory: <$SPECROOT>/SSLOGGER/SRG Data Collector: SSLogger Setup See the SSLogger (5071) for complete SSLogger setup instructions. Recommended SSLogger Setup Parameters The recommended minimum poll interval for all attributes is 300 seconds. Polling data more often than 5 minutes could result in degraded SpectroSERVER performance. Set all attributes to poll at the same interval (i.e. 300 seconds). Configure SSLogger to create a new log file every hour. Do this by adding the following line to the end of the sslogger.dat file: Rotate_log_interval: 1 Ensure that SSLogger is configured to collect Device and/or List attributes as described in the SSLogger (5071). Note: The SRG does not support Port level attributes as described in the SSLogger (5071). To log specific ports and associated attributes, add the required port model handles to the SSLogger models file. See Sample Configuration 3 in Appendix A: Sample Configurations [page 45] for a sample of valid SSLogger.dat and model files when logging specific port data. Page 13

14 Data Miner: Setup Prerequisites When running the on an independent machine (as recommended), FTP access to the SpectroSERVER machine running SSLogger may be required. FTP is only necessary when mapping or mounting a remote directory is not possible. Setting up on a Standalone Windows Machine [page 14] Setting up on a Standalone Solaris Machine [page 16] Setting up on a Standalone Windows Machine 1. Copy the following files from your remote SPECTRUM machine (example: C:\Win32app\Spectrum\SSLOGGER\) to a local directory (i.e. C:\ReportGateway): SRG\SRG.exe SRG\SRG.conf SRG\rrdtool.exe models sslogger.dat All 5 files should now exist locally in C:\ReportGateway (in this example). 2. Edit the SRG.conf file and set all flags to your specific environment. See Appendix B: Configuration Parameter Definitions [page 56] for details on all configuration parameters in the SRG.conf file. 3. If you wish to encrypt your FTP password using 64-bit encryption, run the following command: command prompt> SRG.exe encrypt Running this command will encrypt the password in the SRG.conf file. The following changes will occur in the SRG.conf file: Unencrypted: FTP PASSWORD = sample_password Encrypted: Page 14

15 FTP PASSWORD (encrypted) = 52616e646f6d495641a2a010ab204c8f15 4. Once configuration is complete and SSLogger has collected data for over 1 hour, test your SRG configuration by running it at the command prompt: command prompt> cd $SPECROOT\SSLOGGER\SRG command prompt> SRG.exe The first time SRG is executed, it will create Round-Robin-Databases (RRDs), insert data into the appropriate RRDs, and generate a series of history files all in the local directory. These history files include:.srg_logfiles Contains the name of the raw SSLogger log file (or group of files) read by SRG since the last run of SRG. This file is overwritten at each scheduled run of SRG..SRG_history Contains a history of raw SSLogger log files converted in RRD format with date and timestamp..srg_data Contains post-converted data used to update all RRDs. This file is overwritten at each scheduled run of SRG..<rrd_name_1> For every RRD created by SRG, a corresponding "." (dot) file is created for each. These files contain the data sources configured for each RRD. SRG references these files to determine when a new data source (attribute) is found and to dynamically insert the new data source(s) into the RRD. WARNING! When SRG is configured and running normally on a scheduled basis, the above files should not be removed or edited. Doing so could corrupt SRG configuration. If any errors occur in the output of SRG, these errors must first be eliminated before moving forward. Typically, any errors that occur are due to configuration issues. To retest SRG after fixing configuration parameters, you must first remove all.history_files and *.rrd files: command prompt> cd <$SPECROOT>\SSLOGGER\SRG Page 15

16 command prompt> del.* command prompt> del *.rrd command prompt> SRG.exe Important: Do not set up the following until SSLogger has collected data for a minimum of one full hour. 5. Next, schedule SRG.exe to run every hour to update all RRDs with data collected by SSLogger. Ensure that the Task Scheduler service is started and open up the Scheduled Tasks control panel item. Add a new task, browse to your SRG.exe file and click Next. Have the task run daily (for now) and click Next twice until you are at the username/password screen. You must enter a user that has read/ write permissions to Cacti rra/ and log/ directories here. Click Next, check the box to open Advanced Properties and click Finish. Enter the full command line in the Run field. Your command line should look something like: C:\ReportGateway\SRG.exe Select the Schedule tab and click Advanced. Check the Repeat task check box and change it to every hour, then change the Duration to 24 hours. This will schedule SRG.exe to run every hour. Note: To keep DOS boxes from showing up on your screen, schedule the event using an NT service ID such as cacti_service. Doing this will remove those messages from your screen during the execution of the scheduled event. Setting up on a Standalone Solaris Machine 1. Copy the following files from your remote SPECTRUM machine (<$SPECROOT>/SSLOGGER) to a local directory (i.e. /usr/reportgateway): SRG\SRG SRG\SRG.conf SRG\rrdtool models sslogger.dat All 5 files should now exist locally in /usr/reportgateway (for example). Page 16

17 2. Edit the SRG.conf file and set all flags to your specific environment. See Appendix B: Configuration Parameter Definitions [page 56] for details on all configuration parameters in the SRG.conf file. 3. If you wish to encrypt your FTP password using 64-bit encryption, run the following command: shell>./srg encrypt Running this command will encrypt the password in the SRG.conf file. The following changes will occur in the SRG.conf file: Unencrypted: FTP PASSWORD = sample_password Encrypted: FTP PASSWORD (encrypted) = 52616e646f6d495641a2a010ab204c8f15 4. Once configuration is complete and SSLogger has collected data for over 1 hour, test your SRG configuration by running it at the command prompt: shell> cd $SPECROOT/SSLOGGER/SRG shell>./srg The first time SRG is executed, it will create Round-Robin-Databases (RRDs), insert data into the appropriate RRDs, and generate a series of history files-all in the local directory. These history files include:.srg_logfiles Contains the name of the raw SSLogger log file (or group of files) read by SRG since the last run of SRG. This file is overwritten at each scheduled run of SRG..SRG_history Contains a history of raw SSLogger log files converted in RRD format with date and timestamp..srg_data Contains post-converted data used to update all RRDs. This file is overwritten at each scheduled run of SRG..<rrd_name_1> For every RRD created by SRG, a corresponding "." (dot) file is created for each. These files contain the data sources configured for Page 17

18 each RRD. SRG references these files to determine when a new data source (attribute) is found and to dynamically insert the new data source(s) into the RRD. WARNING! When SRG is configured and running normally on a scheduled basis, the above files should not be removed or edited. Doing so could corrupt SRG configuration. If any errors occur in the output of SRG, these errors must first be eliminated before moving forward. Typically, any errors that occur are due to configuration issues. To retest SRG after fixing configuration parameters, you must first remove all.history_files and *.rrd files: shell> cd $SPECROOT/SSLOGGER/SRG shell> rm.* shell> rm *.rrd shell>./srg Important: Do not set up the following until SSLogger has collected data for a minimum of one full hour. 5. Schedule SRG to run every hour to update all RRDs with data collected by SSLogger. This can be done via cron job: Navigate to /var/spool/cron/crontabs and edit the appropriate cron file for the user that will be running SRG. For example, add the following line to the bottom of the 'root' file: 05 * * * * cd </path/to/srg>; </path/to/srg>/srg Save the file and reset the root cron by entering the following command: shell> crontab root SRG will now update all RRDs at 5-minutes past every hour. Data Graphing Utility: Cacti The following section describes setup of one of many open-source graphing utilities for RRDtool called Cacti. Windows Installation [page 19] Solaris Installation [page 23] Page 18

19 Windows Installation WARNING! Aprisma does not recommend installing Cacti on the same machine as SPECTRUM. Aprisma has identified potential configuration and compatibility issues with Cacti that could corrupt your SPECTRUM installation. The installation of this 3rd-party open-source tool requires the following files (see Downloading the Required SRG Accessory Pack [page 13]): RRDtool version or higher PHP4.0 or newer WARNING! If downloading from use the PHP4.0 zip download only. Do not install the MSI Windows Installer version of PHP because it does not contain all the necessary files. MYSQL Standard or higher Note: This is not included in the package described in Downloading the Required SRG Accessory Pack [page 13]. Download it from Apache or higher Cacti-0.6.8a.tar.gz inject_rrds_cl 1. Unzip the SRG Accessory Pack for Windows to a temporary directory on the target system. 2. Install the Apache web server. (for example, C:\Apache) 3. Extract PHP to a local drive and rename the folder to PHP (i.e. C:\PHP). 4. Move the C:\PHP\php4ts.dll file to your system directory: C:\winnt\system32 5. Rename the php.ini-dist file to php.ini, copy it to your winnt/ directory and make the following changes to the file: extension_dir = C:/php/extensions extension=php_snmp.dll Page 19

20 include_path=c:/apache/htdocs/cacti register_globals = On register_argc_argv = On max_execution_time = 200 session.save_path = C:/temp Note: Use "/" slash, not "\". 6. Ensure that the value of include_path= (C:/apache/htdocs/cacti above) is your full path to Cacti (to be determined in step 11). In addition, make sure to use forward slashes [/] instead of backslashes [\] above and that the C:/temp directory exists. 7. Add the following lines to Apache's C:\Apache\conf\httpd.conf file: LoadModule php4_module c:/php/sapi/php4apache.dll AddModule mod_php4.c AddType application/x-httpd-php.php DirectoryIndex index.html index.htm index.php 8. Ensure that C:/php/sapi/php4apache.dll (specified in step 7) is your full path to the php4apache.dll file. 9. Install MySQL (i.e. in C:\mysql) and start the MySQL service (mysqld-nt.exe). 10. Add C:\mysql\bin to the system path and open a new commandprompt window. 11. Install Cacti. Locate Cacti-0.6.8a.tar.gz and extract the distribution archive. You can use a program like WinZip to open.tar.gz files. These instructions will assume that the archive has been extracted to C:\Apache\htdocs\cacti, although you can use a different path if you wish (making sure the path matches the path value referenced in step 5 and step 6). When using WinZip, make sure you extract with Use folder names enabled, so that the necessary sub-folders will be used. 12. Modify C:\Apache\htdocs\cacti\include\config.php and specify the MySQL user, password, and database configured in step 17: $database_default = "cacti"; $database_hostname = "localhost"; $database_username = "cactiuser"; $database_password = "cacti"; Page 20

21 13. Change the operating system variable to "win32": $cacti_server_os = "win32"; 14. If you are using NTFS security, make sure the I_USR_ user has write access to both the log/ and rra/ sub-directories. Also, ensure that the I_ USR_<hostname> user has execute permissions to the C:\PHP and C:\PHP\SAPI directories. If you do not do this, the ISAPI process will fail. 15. Create the MySQL database: C:\> cd Apache\htdocs\cacti C:\Apache\htdocs\cacti> mysqladmin create cacti Note: These examples assume that the MySQL executables directory (commonly C:\mysql\bin) is in your %PATH%. 16. Import the default Cacti database: C:\Apache\htdocs\cacti> mysql cacti < cacti.sql 17. Create a MySQL username and password for Cacti. C:\Apache\htdocs\cacti> mysql --user=root mysql mysql> GRANT ALL ON cacti.* TO cactiuser@localhost IDENTIFIED BY 'cacti'; mysql> flush privileges; 18. Point your web browser to: Log in with a username and password of admin. You will be required to change this password immediately. Once you are logged in, see Creating Graphs With Cacti [page 29] to complete the setup. Make sure to fill in all the path variables carefully and correctly on the following screen (Figure 1 [page 22]). Page 21

22 Figure 1: Entering Path Variables Using the default paths described here, your paths should look something like: PHP Binary Path: c:/php/php.exe RRDtool Binary Path: c:/rrdtool/rrdtool.exe Cacti Web Root: /cacti Web Server Document Root (Apache default): c:/apache/htdocs Page 22

23 Solaris Installation WARNING! Aprisma does not recommend installing Cacti on the same machine as SPECTRUM. Aprisma has identified potential configuration and compatibility issues with Cacti that could corrupt your SPECTRUM installation. Installing Cacti on Solaris is a bit more time consuming since pre-compiled binaries are not available for many of the required 3rd-party applications. For convenience, all required components for Solaris 8 are available as described in Downloading the Required SRG Accessory Pack [page 13]. Unzip the SRG Accessory Pack for Solaris to a temporary directory on the target system 1. Install the necessary compilers. In order to build all required components, Make v3.8 and GCC v are required. These are included in the SRG Accessory Pack. If you download these packages directly from be sure to download the compiled binary distribution (not the source). Uncompress both files and add the packages using the following commands for each (you must be logged in as the root user in order to run pkgadd). For example: shell> gzip -d make-3.80-sol8-sparc-local.gz shell> pkgadd -d make-3.80-sol8-sparc-local all shell> gzip -d gcc sol8-sparc-local.gz shell> pkgadd -d gcc sol8-sparc-local all Important: Ensure that the PATH setting for the root user includes both the /usr/local/bin and /usr/ccs/ bin paths before proceeding by doing the following: shell> ksh shell> echo $PATH If you do not see the /usr/local/bin and /usr/ccs/bin paths in the echo output, add them both as follows: shell> ksh shell> export PATH=/usr/local/bin:/usr/ccs/bin:$PATH shell> echo $PATH The echo output should now include the paths added above. Page 23

24 2. Install Perl. The Perl Solaris package is included in the SRG Accessory Pack and is also available at (ActivePerl sun4-solaris.gz). Install it by running the following commands as the root user: shell> gzip -d ActivePerl sun4-solaris.gz shell> pkgadd -d ActivePerl sun4-solaris all When prompted, enter the destination directory for the Perl install. Aprisma recommends that the current version of Perl be over-written with this new, updated version. If it is not, your path to Perl may have to be modified and/or changed. Run the following command in another shell window to find the location of the current version of perl: shell> which perl If the output of the above command was /usr/bin/perl, then to replace this version with the new version, the destination install directory entered during the pkgadd would be /usr. 3. Install Required Operating System Packages: These packages are included in the SRG Accessory Pack and are also available at Install these packages by running the following commands: Uncompress each package by running the following command: shell> gzip -d <package.gz> Install the packages: shell> pkgadd -d m4-1.4-sol8-sparc-local all shell> pkgadd -d bison sol8-sparc-local all shell> pkgadd -d automake sol8-sparc-local all shell> pkgadd -d autoconf-2.57-sol8-sparc-local all shell> pkgadd -d flex-2.5.4a-sol8-sparc-local all 4. Install Apache: This package is included in the SRG Accessory Pack and is also available at (apache_ tar.z). Uncompress and tar the Apache source and build it using the following commands: shell> uncompress apache_ tar.z shell> tar -xvf apache_ tar shell> cd apache_ shell>./configure --enable-module=so Page 24

25 shell> make shell> make install Add the following lines to the bottom of the /usr/local/apache/conf/httpd.conf file: AddType application/x-httpd-php.php DirectoryIndex index.html index.htm index.php 5. Install MySQL standard (or later): Download MySQL standard version from (mysql-standard sunsolaris8-sparc.tar.z) to your system and install it using the following commands: shell> groupadd mysql shell> useradd -g mysql mysql shell> cd /usr/local shell> gzip -d < /pathto/mysql-version-os.tar.gz tar xvf - shell> ln -s full-path-to-mysql-version-os mysql shell> cd mysql shell> scripts/mysql_install_db shell> chown -R root. shell> chown -R mysql data shell> chgrp -R mysql. Start the MySQL daemon: shell> bin/mysqld_safe --user=mysql & Detailed instructions can be found at 6. Install PHP4.3.1: This package is included in the SRG Accessory Pack and is also available at (php tar.gz). Install it using the following commands: shell> gzip -d php tar.gz shell> tar -xvf php tar shell> cd php shell>./configure --with-mysql=/usr/local/mysql -with-apxs= /usr/local/apache/bin/apxs Note: If an "apxs" error occurs, check the top of the /usr/local/apache/bin/apxs file and make sure it specifies your newly installed perl binary (i.e. #!/usr/bin/perl). Page 25

26 shell> make shell> make install shell> cp php.ini-dist /usr/local/lib/php.ini Edit /usr/local/lib/php.ini: Make sure you have the following options set in your php.ini file: register_globals = On register_argc_argv = On Detailed instructions can be found at 7. Install Cacti: This package is included in the SRG Accessory Pack and is also available at (cacti-0.6.8a.tar.gz) using the following commands. Note: Aprisma recommends that the version of Cacti included with SRG Accessory Pack be used since a few minor SRG integration enhancements have been made. shell> gzip -d cacti-0.6.8a.tar.gz shell> tar -xvf cacti-0.6.8a.tar shell> mv cacti-0.6.8a cacti shell> cp -R cacti /usr/local/apache/htdocs 8. Create the MySQL database: shell> cd /usr/local/apache/htdocs/cacti shell> /usr/local/mysql/bin/mysqladmin create cacti 9. Import the default Cacti database: shell> /usr/local/mysql/bin/mysql cacti < cacti.sql 10. Optional: Create a MySQL username and password for Cacti. shell> mysql --user=root mysql mysql> GRANT ALL ON cacti.* TO cactiuser@localhost IDENTIFIED BY 'cacti'; mysql> flush privileges; 11. Edit /usr/local/apache/htdocs/cacti/include/config.php: Specify the MySQL user, password and database for your Cacti configuration (configured in step 10). $database_default = "cacti"; $database_hostname = "localhost"; Page 26

27 $database_username = "cactiuser"; $database_password = "cacti"; 12. Set the appropriate permissions on Cacti's directories for graph/log generation. You should execute these commands from inside Cacti's directory to change the permissions. shell> chown root rra/ log/ 13. Start the Apache Web Server. shell> /usr/local/apache/bin/apachectl start Note: To restart Apache if it is already running: shell> /usr/local/apache/bin/apachectl stop shell> /usr/local/apache/bin/apachectl start 14. Point your web browser to: Log in with a username/password of admin. You will be required to change this password immediately. Make sure to fill in all the path variables carefully and correctly on the following screen (Figure 2 [page 28]). WARNING! Cacti may not function properly when running Netscape on Solaris. Aprisma recommends using Mozilla on Solaris or Windows Internet Explorer web browsers whenever possible for all Cacti administration. Page 27

28 Figure 2: Entering Path Variables Page 28

29 Creating Graphs With Cacti This section describes how to generate basic graphical reports using Cacti. For information on advanced techniques, review the documentation included with Cacti and review the RRDTool web page at In This Section Injecting RRD Information Into Cacti [page 29] Data Sources [page 31] Building a Graph [page 32] Injecting RRD Information Into Cacti After successfully logging into Cacti, you must configure it to reference all of the RRDs created by the SRG. If you did not install the version of Cacti in the SRG Accessory Pack, you will need to inject RRD information via the command line as described in Inject RRD Information Into Cacti via the Command Line [page 30]. Otherwise, inject RRD information into Cacti by following this procedure: Procedure Note: The process of injecting RRD information into Cacti simply registers all RRD specific information into Cacti's MySQL database. The MySQL database does not store any statistical information. It only stores RRD data source names and configuration parameters related to Cacti. 1. Click Cacti Settings from the top-left menu (under Configuration) and then scrolling down to the bottom of the resulting screen (Figure 3). Page 29

30 Figure 3: Inject RRD Information 2. In the RRD: field, input the path to the location of the RRDs and a single RRD name or *.rrd to inject all RRDs. For example: or C:\win32app\Spectrum\SSLOGGER\SRG\your_rrd_name.rrd /usr/spectrum/sslogger/srg/*.rrd 3. In the User Name: field, enter the name of the Cacti MySQL database user configured in the config.php during installation (i.e. cactiuser). 4. In the Password: field, enter the password for this user (i.e. cacti) and click Save. Inject RRD Information Into Cacti via the Command Line If Figure 3 does not appear in Cacti Settings of your Cacti install, you will need to inject all RRD information via the command line executable. Instructions for doing this follow below. Procedure 1. Copy the inject_rrds_cl executable from your apache/htdocs/cacti directory to the same directory where your *.rrd files are located. 2. Open a new shell or command prompt window and type the following: shell> cd /<location of RRDs> shell> inject_rrds_cl *.rrd Page 30

31 You will be prompted for the Cacti MySQL database username and password. Use cactiuser and cacti, respectively (unless you ve configured Cacti differently). 3. Enter the absolute path to the directory containing your RRDs. All RRD information should now be listed in the Data Sources section of Cacti. Data Sources Click Data Sources from the top-left menu bar. You should see a list of all current data sources supplied by each injected RRD (Figure 4). Figure 4: Current Data Sources Page 31

32 Building a Graph Once data sources are available, graphical reports can be generated. Procedure 1. Click the Graphs link under Graph Setup in the left menu bar of Cacti. 2. In the upper-right corner of the new window, click Add. The rrdtool Graph Configuration screen will appear (Figure 5). Figure 5: rrdtool Graph Configuration 3. Enter a graph name in the Title box and click Save at the bottom of the window. You should now have a graph entry (Figure 6). Page 32

33 Figure 6: Graph Configuration 4. Click Edit Graph Items on the line of the new graph you just created and click Add in the upper-right corner of the new window displayed. You can now select a data source (attribute) you wish to plot from the Data Source drop-down list (Figure 7). Figure 7: Graph Items Configuration Page 33

34 5. After selecting a data source, choose the color to represent this data source on the graph. 6. Scroll down and enter a name of the data source you wish to appear in the graph legend in the Text field, and click Save. You should now see the data source listed. Clicking Turn Graph Preview On will allow you to view the current graph configuration. Figure 8: The Graph Hierarchy 7. To add another data source or attribute to this graph, click Add in the upper-right corner and repeat the process above. Once the graph is configured, it must then be added to the Graph Hierarchy (see Adding a Graph to the Graph Hierarchy [page 35]). Page 34

35 Adding a Graph to the Graph Hierarchy The Graph Hierarchy allows you to group graphs in any manner you wish for presentation. Procedure 1. Click Graph Hierarchy in the menu bar and click Edit Graph Hierarchy. 2. Click Add in the upper-right corner of the new window displayed. 3. Select the This Item is a Graph radio button. 4. Select the graph you just created from the drop-down list, and click Save (Figure 9). 5. The graph is placed in the Graph Hierarchy for presentation. Click the graphs tab at the top of the screen to see the graph. 6. Clicking on the graph will display a series representing all Round- Robin-Archives (RRAs) configured in the SRG.conf file. Now that the graph is built, it will automatically update with new data at the end of each scheduled SRG update (Figure 10 [page 36]). Figure 9: Adding a Graph to the Graph Hierarchy Page 35

36 Figure 10: Graph Hierarchy Page 36

37 Figure 11 shows an example of a fully configured Cacti with many graphs represented in a multi-level graph hierarchy. Figure 11: Multi-Level Graph Hierarchy Note: Cacti includes many advanced features not discussed here. To learn more about Cacti, go to Page 37

38 Service Performance Manager and This section describes the configuration and use of SPM_SRG, the SRG component required for Report Gateway integration with Service Performance Manager (SPM). Note: For more information about SPM, see the Service Performance Manager (5093). Introduction Aprisma s Service Performance Manager (SPM) product provides dynamic response time testing of your network and can log and export response time test data. The SPECTRUM for SPM was designed to create RRDs based on the data contained in the SPM data log files. SPM test result data files are written in a file format different from that of SSLogger. Because of this, SPECTRUM for SPM (SRG_SPM) is required to convert the SPM data to RRDs. Once SPM (with data logging enabled) is properly configured and running, the SPM needs only read access to or a copy of the SPM log data files. SRG_SPM reads the raw SPM log files to create and populate the RRDs with data. Other than the SRG_SPM configuration file (SRG_SPM.conf), no other configuration files are required. SRG_SPM calls RRDTool when creating, updating, and/or accessing any RRD. When SRG_SPM first runs, it creates an RRD for each configured test found in the SPM log file(s). On subsequent runs, SRG_SPM simply updates the pre-existing RRDs, or, if any new tests are found, SRG_SPM creates new RRD(s). SRG_SPM can dynamically adapt to changes in configured SPM tests. Some of the supported adaptations include: Auto-creation of new RRDs Test interval updates Test name changes Threshold violation interval changes Page 38

39 Source and/or destination configuration changes Scheduling SRG_SPM to update all RRDs with new SPM data can be done via a cron job on Solaris or a scheduled task on Windows, just like SRG. At the end of each RRD update, SRG_SPM records information to a series of log files (i.e..spm_history) indicating the work completed as well as any error messages. This verifies which SPM export files have been archived into Round-Robin-Databases. Installation and Setup This section describes installation and setup procedures for running the SPM on Windows and Solaris platforms. Setup of SRG_SPM differs slightly from SRG and requires less manual configuration. Three major components are required to complete an end-to-end implementation of the SPM : 1. Data Collector: SPM with Data Logging Enabled [page 39]. 2. Data Miner: SPM Setup [page 40]. A properly installed and scheduled for SPM using RRDTool. 3. Data Grapher: Cacti [page 44]: A properly configured web-server with 3rd-party web-based graph generation tool (i.e. open-source Cacti or DRRAW). If Cacti or DRRAW is already implemented with SRG, there is no need to complete this step. Data Collector: SPM with Data Logging Enabled Note: See the Service Performance Manager (5093) for complete data export setup instructions. The following SPM data logging setup parameters are recommended: 1. Configure the SPM data logging feature with the spm-log-filecycle-time=5 minutes. 2. Configure the SPM data logging feature to write the log files to the same directory where SRG_SPM.exe will exist (i.e. C:\ SPM_ReportGateway). Page 39

40 Data Miner: SPM Setup Prerequisites If running the SPM on an independent machine, it may require FTP access to the SPECTRUM Web Operator Suite web-server machine. FTP is only necessary when there is no other means to transfer raw SPM data files to the SRG_SPM machine. WARNING! Do not attempt to install Cacti on the same machine as the SPECTRUM Assurance Server as you could risk corrupting your SPECTRUM install. Cacti requires a different version of Perl that ships with SPECTRUM. Mixing two versions of Perl on the same machine could corrupt the SPECTRUM installation. Cacti is an open source application, therefore, Aprisma does not support Cacti nor is Aprisma responsible for any damages as a result of disregarding this warning. Cacti can be installed on the same machine as Web Operator and SPM, however, this warning still applies. Configuring SPM with Web Operator on Windows 1. Copy the following files from your SPECTRUM machine (C:\Win32app\ Spectrum\SSLOGGER\SRG) to a local directory (i.e. C:\ SPM_ReportGateway): SRG_SPM.exe SRG_SPM.conf rrdtool.exe All 3 files should now exist locally in C:\SPM_ReportGateway (in this example). 2. Edit the SRG_SPM.conf file and set the appropriate parameters to your specific environment. See Appendix C: Sample SRG_SPM Configurations [page 69] for details on all configuration parameters in the SRG_SPM.conf file. 3. Once configuration is complete and SPM log files have been generated in the same directory as SRG_SPM.exe, test your SRG_SPM configuration by running it at the command prompt: command prompt> cd C:\SPM_ReportGateway Page 40

41 command prompt> SRG_SPM.exe The first time SRG_SPM is executed, it will create Round-Robin- Databases (RRDs) for all test results included in the SPM log file(s), insert data into the appropriate RRDs, and generate a series of history files-all in the local directory. These history files include:.spm_history Contains an up-to-date list of RRDs generated by SRG_SPM..SPM_log_history Contains a history of SPM log files converted in RRD format with date and timestamp..spm_data Contains post-converted data used to update all RRDs. This file is overwritten at each scheduled run of SRG. WARNING! When SRG_SPM is configured and running normally on a scheduled basis, these history files should not be removed or edited. Doing so could corrupt the SRG_SPM configuration. To retest SRG_SPM after modifying or changing configuration parameters, you must first remove all.<spm history files> and *.rrd files: command prompt> cd C:\SPM_ReportGateway command prompt> del.* command prompt> del *.rrd command prompt> SRG_SPM.exe 4. You must run SRG_SPM.exe on a scheduled basis to update all RRDs with new data collected by SPM. The schedule interval is typically the same interval as the spm-log-file-cycle-time configured in step 1 under Data Collector: SPM with Data Logging Enabled [page 39]. To run SRG_SPM.exe on a scheduled basis: a. Make sure the Task Scheduler service is running. b. Open up the Scheduled Tasks control panel item. c. Double-click Add Scheduled Task, browse to your SRG_SPM.exe file, and click Next. Set the task to run daily (for now) and click Next twice until you are at the username/password screen. Click Page 41

42 Next, check the box to open Advanced Properties and click Finish. d. In the Task tab, enter the full command line in the Run field. Your command line should look something like this: C:\SPM_ReportGateway\SRG_SPM.exe e. Select the Schedule tab and click Advanced. Check the Repeat task checkbox and change it to every hour, then change the Duration to 24 hours. That should schedule SRG_SPM.exe to run every hour. Note: You can also schedule the event using an NT service ID such as cacti_service. Doing this will remove the DOS box messages from your screen during the execution of the scheduled event. Configuring SPM with Web Operator on Solaris 1. Copy the following files from your SPECTRUM machine (<$SPECROOT>/ SSLOGGER/SRG) to a local directory (i.e. /usr/spm_reportgateway): SRG_SPM SRG_SPM.conf rrdtool All 3 files should now exist locally in /usr/spm_reportgateway (in this example). 2. Edit the SRG_SPM.conf file and set the appropriate parameters to your specific environment. See Appendix C: Sample SRG_SPM Configurations [page 69] for details on all configuration parameters in the SRG_SPM.conf file. 3. Once configuration is complete and SPM log files have been generated in the same directory as SRG_SPM, test your SRG_SPM configuration by running it at the command prompt: shell> cd /usr/spm_reportgateway shell>./srg_spm The first time SRG_SPM is executed, it will create Round-Robin- Databases (RRDs) for all test results included in the SPM log file(s), insert data into the appropriate RRDs, and generate a series of history files-all in the local directory. These history files include: Page 42

43 .SPM_history Contains an up-to-date list of RRDs generated by SRG_SPM..SPM_log_history Contains a history of SPM log files converted in RRD format with date and timestamp..spm_data Contains post-converted data used to update all RRDs. This file is overwritten at each scheduled run of SRG. WARNING! When SRG_SPM is configured and running normally on a scheduled basis, these history files should not be removed or edited. Doing so could corrupt the SRG_SPM configuration. To retest SRG_SPM after modifying or changing configuration parameters, you must first remove all.<spm history files> and *.rrd files: shell> cd /usr/spm_reportgateway shell> rm.* shell> rm *.rrd shell>./srg_spm 4. You must run SRG_SPM on a scheduled basis to update all RRDs with data collected by SPM. The schedule interval is typically the same interval as the spm-log-file-cycle-time configured in step 1 under Data Collector: SPM with Data Logging Enabled [page 39]. To configure SRG_SPM to run on a scheduled basis via cron job: Navigate to /var/spool/cron/crontabs and edit the appropriate cron file for the user that will be running SRG_SPM. For example, add the following line to the bottom of the 'root' file: 05 * * * * cd <path/to/srg_spm>; <path/to/srg_spm/srg_spm>* Save the file and reset the root cron by entering the following command: shell> crontab root SRG_SPM will now update all RRDs at 5-minutes past every hour. Page 43

44 Data Grapher: Cacti If you are installing Cacti on an independent machine, see the Cacti installation and setup instructions in the SRG section of this document: Data Graphing Utility: Cacti [page 18]. If you are installing Cacti on the same machine as Web Operator, see Running Web Operator with SRG and Cacti on a Machine Separate from SPECTRUM [page 73]. Page 44

45 Appendix A: Sample Configurations This section lists three samples of valid SSLogger models, sslogger.dat, and SRG.conf file groupings. All three files in each sample are dependent on each other. Sample Configuration 1 SSLogger models File 0x180598c; ; 0x3f20000; VH_Switch 0x1800c72; ; 0x3cb0003; RoamAboutAP 0x1800c76; ; 0x3cb0003; RoamAboutAP 0x ; ; 0x2c60022; XPedSwRtr 0x18020a1; ; 0x2c60022; XPedSwRtr 0x18086e9; ; 0x21b0015; 6H202_24 0x180790c; ; 0x21b0015; 6H202_24 0x180067c; ; 0x21b0015; 6H202_24 0x1800c66; ; 0x3cb0003; RoamAboutAP 0x1800c62; ; 0x3cb0003; RoamAboutAP 0x18079fc; ; 0x3cb0003; RoamAboutAP 0x18024a8; ; 0x3cb0003; RoamAboutAP 0x ; amt-ns2; 0x116008c; Host_Sun 0x18087ef; amt-nsm; 0x116008c; Host_Sun 0x18087cc; amt-ns4; 0x116008c; Host_Sun 0x18087c6; amt-ns3; 0x116008c; Host_Sun 0x180000d; SSPerformance; 0x10421; SSPerformance sslogger.dat File group: device_port_info ifinoctets ; 300 ; 0x0 ; 0x100cd ;.1 ifoutoctets ; 300 ; 0x0 ; 0x100d3 ;.1 group: CPU_info_XPedSwRtr Page 45