SAS 9.2 Enterprise Business Intelligence Audit and Performance Measurement for UNIX Environments. Last Updated: May 23, 2012

SAS 9.2 Enterprise Business Intelligence Audit and Performance Measurement for UNIX Environments Last Updated: May 23, 2012

Copyright Notice The correct bibliographic citation for this manual is as follows: SAS Institute Inc., SAS 9.2 Enterprise Business Intelligence Audit and Performance Measurement for UNIX Environments, Cary, NC: SAS Institute Inc., 2009. SAS 9.2 Enterprise Business Intelligence Audit and Performance Measurement for UNIX Environments Copyright 2009, SAS Institute Inc., Cary, NC, USA. All rights reserved. Printed in the United States of America. No part of this publication may be reproduced, stored in a retrieval system, or transmitted, by any form or by any means, electronic, mechanical, photocopying, or otherwise, without the prior written permission of the publisher, SAS Institute Inc. Limited permission is granted to store the copyrighted material in your system and display it on terminals, print only the number of copies required for use by those persons responsible for installing and supporting the SAS programming and licensed programs for which this material has been provided, and to modify the material to meet specific installation requirements. The SAS Institute copyright notice must appear on all printed versions of this material or extracts thereof and on the display medium when the material is displayed. Permission is not granted to reproduce or distribute the material except as stated above. U.S. Government Restricted Rights Notice. Use, duplication, or disclosure of the software by the government is subject to restrictions as set forth in FAR 52.227-19 Commercial Computer Software-Restricted Rights (June 1987). SAS Institute Inc., SAS Campus Drive, Cary, North Carolina 27513. SAS and all other SAS Institute Inc. product or service names are registered trademarks or trademarks of SAS Institute Inc. in the USA and other countries. indicates USA registration. Other brand and product names are trademarks of their respective companies.

Table of Contents Overview... 5 SAS 9.2 Enterprise Business Intelligence Package... 5 SAS 9 Enterprise Business Intelligence... 5 Installation Overview... 6 UNIX Installation Instructions... 6 Audit and Performance Measurement Package Installation Updates... 7 Configuration Overview... 7 Configuration Details... 8 Configuring the Audit and Reporting Environment Settings... 8 Step 1: Updating the "setenvlogs.cfg.sh" Sample Program... 8 Step 2: Executing the "runcfg.sh" Sample Program... 9 Step 3: Enabling the Customized Property Files into the SAS BI environment... 9 Step 4: Configuring Environment Settings for Multiple Machine Deployments... 15 Step 4a: Create PerfLogs Directories for Multi-Machine Deployments... 15 Step 4b: Create AuditLogs Directories for Multi-Machine Deployments... 16 Step 5: Customization of the Server and Web Tier Reports... 16 Validating the Configuration... 25 Validating Metadata Server Audit Logs... 25 Validating BI Server Performance Logs... 26 Validating the Audit and Performance Log Processing... 26 Validating the Performance Report Processing... 27 Validating the SAS Server and Web Application Status Reporting... 27 Validating Data Collection and Log Archiving Processing... 28 Operational Administration and Reporting... 29 Scheduling an Interval for Validating Server Status... 29 Scheduling an Interval for Data Collection and Log Archiving... 29 Archiving and Administration of Package SAS Data Sets... 30 Utilizing Performance, Status and Audit Reports... 30 Metadata Server Audit Reports... 30 Enterprise BI Server Performance Reports... 31 Enterprise BI Server and Web Tier Status Report... 36 Enabling Alert Capabilities for Status Failures... 38 Enabling an Email Alert, via SMTP... 38 Enabling Third Party Alert Features... 39 Conclusion... 39 Appendix... 41 Additional References... 41 Updating an Existing Audit and Performance Measurement Package... 41 Audit and Performance Measurement Package Installation Updates... 41 Update to SAS 9.2 Platform ARM Support... 41 Update to SAS 9.2 Platform Validate Server Support... 41 3

SAS 9.2 Enterprise Business Intelligence Audit and Performance Measurement Update to SAS 9.2 Platform URL Access Method... 42 Configuring Environment Settings for Multiple Machine Deployments... 42 SAS 9.2 Enterprise BI Audit and Performance Programs and Scripts... 43 SAS 9.2 Enterprise BI server tier and Web tier Logs... 44 SAS 9.2 Enterprise BI Audit and Performance Data Model... 45 Audit Reporting Data Model... 45 Audit Access Control Details Data Model... 46 Performance Measurement Data Model - ArtifactUsageDetails... 46 Audit and Performance Measurement Log File Date Model... 47 Acknowledgments... 47 Contact Information... 47 4

SAS 9.2 Enterprise Business Intelligence Audit and Usage Instrumentation and Reporting Overview SAS 9.2 Enterprise Business Intelligence Package The SAS 9.2 Enterprise Business Intelligence Audit and Performance Measurement instrumentation package is a collection of utilities provided by SAS that customers may download, install and configure for their organizations. The package allows a SAS 9.2 Enterprise BI site to monitor the state of the SAS 9 BI architecture, implement audit authentication reports for regulatory compliance, and report on the performance and usability of the SAS 9 BI analytic server environment. The package allows a site administrator to customize the reporting environment to create and deploy a framework that may be used to meet operational business requirements for real-time status reporting. Additionally, Information Technology (IT) and business unit organizations may use the reports to track utilization metrics for analytic services, user usage of the environment as well as analyze SAS procedure, SAS stored process and SAS data library access. SAS 9 Enterprise Business Intelligence The SAS 9 Enterprise BI framework is depicted in Diagram 1. The key elements of the framework include: Multiple integrated tiers, including: o The SAS server tier, which is comprised of various analytic severs o The SAS Web tier, which includes SAS Web-based applications to present SAS analytics o The SAS client tier, which includes a diverse and robust set of desktop clients and Web browser applications that exploit the services of the SAS server and Web tiers The SAS Metadata Server, which is the hub of the deployment architecture. This server provides: o Mapping for logical and physical computing services o Mapping of logical and physical SAS libraries and data sets o User ID authentication and authorization controls o Web tier and client tier context information for user-customized presentation services A distributed heterogeneous computing framework, including: o Server-tier analytic applications, which can be deployed across multiple physical or logical servers environments as well as different processor architectures o Web-tier applications, which can be deployed within multiple industry-standard Web application servers o Client-tier applications, which can be hosted in a diverse collection of hardware and software environments The distributed environment allows a site to optimize the SAS deployment for site specific computing infrastructure. This flexibility also compels a requirement for an administrator to have a thorough understanding of the usage behavior and patterns of the BI architecture. The audit and usage 5

SAS 9.2 Enterprise Business Intelligence Audit and Performance Measurement reporting package facilitates the ability of a site to understand and gain insight into the operational usage of the Enterprise BI architecture. Diagram 1: Deployment diagram for SAS 9 Enterprise BI Server Installation Overview The Audit and Performance Measurement package (referred to as package for the remainder of this document) is distributed in a compressed archive format appropriate for UNIX, Windows or z/os environments. The organization of the package includes the customization scripts, batch files and SAS programs, integration documentation and operational instructions. Refer to the specific operating system instructions for additional details on deployment. The follow-on sections, customization and operational administration describe requirements to complete the deployment and implementation phases of the package. Finally, an appendix provides additional details related to references and internal architecture of the package. UNIX Installation Instructions The package for UNIX environments is distributed in a.tar format, sas.unix.ebiapm92.tar, and contains all the necessary components to deploy into a UNIX environment. The directory organization for the UNIX package includes the following directories:./ebiapm92/archivelog./ebiapm92/auditlogs./ebiapm92/batchserver 6

SAS 9.2 Enterprise Business Intelligence Audit and Usage Instrumentation and Reporting./ebiapm92/Config./ebiapm92/ConnectServer./ebiapm92/Data./ebiapm92/GridServer./ebiapm92/Html./ebiapm92/MetadataServer./ebiapm92/Misc./ebiapm92/OLAPServer./ebiapm92/PooledWorkspaceServer./ebiapm92/SASEnvironment./ebiapm92/SASWebReportStudio./ebiapm92/StoredProcessServer./ebiapm92/Utilities./ebiapm92/WorkspaceServer./ebiapm92/runSASReportsLog SAS recommends installing the package into the /opt/sas/ebiapm92 directory, using the SAS installation User ID. It may be necessary to create the /opt/sas/ebiapm92 directory using the root account, and setting appropriate ownership and write permissions to the ebiapm92 directory for the SAS installation User ID. The following commands may be used to extract the compressed.tar package. If the site has a previous version of the audit and performance package, review the Updating an Existing Audit and Performance Measurement Package step, before proceeding with the installation. Using the root User ID: cd /opt; mkdir SAS; Using the sas installation User ID : cd /opt/sas/ tar xvf <path>/sas.unix.ebiapm92.tar Audit and Performance Measurement Package Installation Updates This package may also include special SAS provided programs, utilities or fixes that enable unique features within the SAS framework. Refer to the appendix for a list of additional software that may need to be installed to complete the installation process. Configuration Overview Configuration of the package is be broadly defined into three unique phases or stages. Each operating system configuration will have slightly unique configuration requirements, where details for each 7

SAS 9.2 Enterprise Business Intelligence Audit and Performance Measurement operating system are described in the following sections. The three main phases of configuration include: 1. Configuration of the audit and reporting package environment settings 2. Configuration of the SAS 9.2 Enterprise BI environment to enable the package features 3. Customization of the reporting framework to emit reports, collect and archive logs Administrators may optionally elect to modify the default reports, archive strategy and related processing for local site installation requirements. SAS recommends that this customization be enabled after initial installation, configuration and validation of the package using the supplied configuration recommendations. This will ensure the supplied package capabilities are operating properly and allow a site to retain a base level of capability as a functional foundation. NOTE: SAS recommends that all configuration files and the SAS Metadata repository be backed up and archived before proceeding with the configuration of the Enterprise BI environment. Refer to the SAS 9.2 Intelligence Platform: System Administration Guide for additional details. Configuration Details Configuring the Audit and Reporting Environment Settings The package requires property files with environment variables settings that allow the package to execute within the SAS Enterprise BI installation. The property files are automatically generated as part of the auto-configuration process. The auto-configuration process includes the following steps: 1. Updating the setenvlogs sample program 2. Executing the runcfg sample program 3. Enabling the Customized Property Files into the SAS BI environment The auto-configuration process, added in February 2011, replaces the manual configuration processing with earlier versions of this package. Administrators will still need to manually deploy the customized property files into the environment and restart the affected servers. Step 1: Updating the "setenvlogs.cfg.sh" Sample Program The setenvlogs.cfg sample script is the primary user configured property file. This file contains property settings that define the local SAS environment, which are subsequently used to update the various configuration files required to enable the package. 8

SAS 9.2 Enterprise Business Intelligence Audit and Usage Instrumentation and Reporting Edit the properties as described in the setenvlogs.cfg.sh file. Sites may want to use the SAS procedure PROC PWENCODE to set an encoded password for the property meta_pwd, eg: proc pwencode in='ebiapm92'; run; Step 2: Executing the "runcfg.sh" Sample Program The runcfg sample script uses the property values specified in setenvlogs.cfg file to build the required configuration files. The processing in the runcfg program includes: Creating the Audit and PerfLogs configuration directories in the SAS configuration directory Creating the EBIAPM92 setenvlogs property files used by the package Creating customized Audit and Performance configuration files for SAS servers Execute the runcfg.sh script and verify the script runs successfully by verifying the following: Review the./ebiapm92/runsasreportslog/apmconfigauto.sas.log for errors Review the./ebiapm92 directory and confirm the directory is populated with the following files: o setenvlogs.sas o setenvlogs.sh o sasv9.cfg Review the./ebiapm92/config directory and confirm the directory is populated with configuration files generated at the time of the runcfg program Step 3: Enabling the Customized Property Files into the SAS BI environment The runcfg script creates the required property and configuration files. However, the package does NOT deploy the files automatically into the SAS BI environment. These tasks must be performed by the system administrator. To enable the Audit and Performance features, the affected SAS BI servers will need to be stopped and restarted after the configuration files are deployed. The customized SAS BI environment files are stored in the./ebiapm92/config directory. There are two files per supported BI Server, and associated operating system specific files. The deployment process for each of the servers includes: Review the customized server configuration files (eg. <servername>.logconfig.apm.xml) to ensure the path to the AuditLogs or PerfLogs directories are correct. Copy the customized server configuration file to the associated BI Server Restart the affected server and verify the audit or performance logs are emitted properly 9

SAS 9.2 Enterprise Business Intelligence Audit and Performance Measurement NOTE: SAS recommends making backup copies of the original configuration files before modification. Administrators may alternately consider backing up the entire <sasconfigdir> as an additional best practice. NOTE for MULT-MACHINE environments: If the BI Server is part of a multi-machine deployment, the configuration files will need to be copied to the remote node. Verify that the path to the server configuration files is correct for the remote node as well as the path to the AuditLogs or PerfLogs directories. Deploying the custom appserver_autoexec_usermods.sas program Review the custom appserver_autoexec_usermods.sas program to ensure the %logarmsetup; SAS macro statement was added to the end of the file. The %logarmsetup SAS macro enables the ARM performance log options for the BI servers. Copy the./config/appserver_autoexec_usermods.sas to the location specified in the comments within the custom appserver_autoexec_usermod.sas file Deploying the custom SASEnvironment/SASMacro programs The package includes three SAS macro programs which should be copied into the <sasconfigdir> location. For example, assuming the package is installed into /opt/sas/ebiapm92 issue the following command: cd /opt/sas/ebiapm92/sasenvironment/sasmacro cp logarmsetup.sas <sasconfigdir>/<lev1>/<sasapp>/sasenvironment/sasmacro cp stparmstart.sas <sasconfigdir>/<lev1>/<sasapp>/sasenvironment/sasmacro cp stparmstop.sas <sasconfigdir>/<lev1>/<sasapp>/sasenvironment/sasmacro NOTE: <Lev1>/<SASApp> is the default name for the application directory during a SAS deployment and configuration, your site installation may have a selected a different value during deployment. Substitute the appropriate value for <Lev1>/<SASApp> as required. Deploying setenvlogs.js Java Script Copy the./ebiapm92/config/setenvlogs.js generated files into the./ebiapm92/html directory. Deploying the MetadataServer customized property files The MetadataServer support includes two generated files in the./ebiapm92/config directory, MetadataServer.logconfig.apm.xml and MetadataServer.sasv9.cfg. Copy these files to the site <sasconfigdir>/lev1/sasmeta/metadataserver directory. 10

SAS 9.2 Enterprise Business Intelligence Audit and Usage Instrumentation and Reporting Rename the MetadataServer.logconfig.apm.xml to: logconfig.apm.xml Rename the MetadataServerServer.sasv9.cfg to: sasv9.cfg Restart the Metadata Server and validate that the AuditLogs directory is populated with two files Access_*.log and Audit_*.log files Deploying the OLAPServer customized property files The OLAPServer support includes two generated files in the./ebiapm92/config directory, OLAPServer.logconfig.apm.xml and OLAPServer.sasv9.cfg. Copy these files to the site <sasconfigdir>/lev1/sasapp/olapserver directory. Rename the OLAPServer.logconfig.apm.xml to: logconfig.apm.xml Rename the OLAPServer.sasv9.cfg to: sasv9.cfg Restart the OLAPServer and verify that PerfLogs directory is populated with an arm4_olapserver*.log file. Deploying the BatchServer customized property files The BatchServer support includes two generated files in the./ebiapm92/config directory, BatchServer.logconfig.apm.xml and BatchServer.sasv9.cfg. Copy these files to the site <sasconfigdir>/lev1/sasapp/batchserver directory. Rename the BatchServer.logconfig.apm.xml to: logconfig.apm.xml Rename the BatchServer.sasv9.cfg to: sasv9.cfg Deploying the ConnectServer customized property files The ConnectServer support includes two generated files in the./ebiapm92/config directory, ConnectServer.logconfig.apm.xml and ConnectServer.sasv9.cfg. Copy these files to the site <sasconfigdir>/lev1/sasapp/connectserver directory. Rename the ConnectServer.logconfig.apm.xml to: logconfig.apm.xml Rename the ConnectServer.sasv9.cfg to: sasv9.cfg Deploying the GridServer customized property files The GridServer support includes two generated files in the./ebiapm92/config directory, GridServer.logconfig.apm.batch.xml and. GridServer.logconfig.apm.connect.xml Copy these files to the site <sasconfigdir>/lev1/sasapp/gridserver directory. 11

SAS 9.2 Enterprise Business Intelligence Audit and Performance Measurement Rename the GridServer.logconfig.apm.batch.xml to: logconfig.apm.batch.xml Rename the GridServer..logconfig.apm.connect.xml to: logconfig.apm.connect.xml Modify the <sasconfigdir>/lev1/sasapp/gridserversas/grid script The GridServer may initiate grid sessions in one of two modes, either DMR mode or BATCH mode. These two modes require unique configuration settings to enable the performance reports and to ensure the grid session logs are emitted properly. Therefore, changes to the sasgrid command script are required. Make a backup copy of the sasgrid.cmd file before proceeding with the changes described below. Modify the sasgrid script, after the lines that read: if [ "${RUNMODE}" = "DMR" ] then Insert the test if section, testing for the existence of the logconfig.apm.connect.xml: if [ "${RUNMODE}" = "DMR" ] then if [ -s "$SASGRIDCMDPATH/logconfig.apm.connect.xml" ] then SASLOGCFGFILE="-logconfigloc \"$SASGRIDCMDPATH/logconfig.apm.connect.xml\"" export SASLOGCFGFILE fi Modify the script after the lines that read: SASLOG="-LOG \"${SASGRIDWORKDIR}/${SASGRIDBATCHPGM}.log\"" SASLST="-PRINT \"${SASGRIDWORKDIR}/${SASGRIDBATCHPGM}.lst\"" Insert the test if section, testing for the existence of the logconfig.apm.batch.xml and export the required environment variables: SASLOG="-LOG \"${SASGRIDWORKDIR}/${SASGRIDBATCHPGM}.log\"" SASLST="-PRINT \"${SASGRIDWORKDIR}/${SASGRIDBATCHPGM}.lst\"" if [ -s "$SASGRIDCMDPATH/logconfig.apm.batch.xml" ] then SASLOGCFGFILE="-logconfigloc \"$SASGRIDCMDPATH/logconfig.apm.batch.xml\"" export SASLOGCFGFILE SASGRIDWORKDIR SASGRIDBATCHPGM fi Deploying the PooledWorkspaceServer customized property files The PooledWorkspaceServer support includes two generated files in the./ebiapm92/config directory, PooledWorkspaceServer.logconfig.apm.xml and PooledWorkspace.sasv9.cfg. Copy these files to the site <sasconfigdir>/lev1/sasapp/pooledworkspaceserver directory. 12

SAS 9.2 Enterprise Business Intelligence Audit and Usage Instrumentation and Reporting Rename the PooledWorkspaceServer.logconfig.apm.xml to: logconfig.apm.xml Rename the PooledWorkspaceServer.sasv9.cfg to: sasv9.cfg Deploying the StoredProcessServer customized property files The StoredProcessServer support includes two generated files in the./ebiapm92/config directory, StoredProcessServer.logconfig.apm.xml and StoredProcessServer.sasv9.cfg. Copy these files to the site <sasconfigdir>/lev1/sasapp/storedprocessserver directory. Rename the StoredProcessServer.logconfig.apm.xml to: logconfig.apm.xml Rename the StoredProcessServer.sasv9.cfg to: sasv9.cfg Deploying the WorkspaceServer customized property files The WorkspaceServer support includes two generated files in the./ebiapm92/config directory, WorkspaceServer.logconfig.apm.xml and WorkspaceServer.sasv9.cfg. Copy these files to the site <sasconfigdir>/lev1/sasapp/workspaceserver directory. Rename the WorkspaceServer.logconfig.apm.xml to: logconfig.apm.xml Rename the WorkspaceServer.sasv9.cfg to: sasv9.cfg Update the BatchServer Properties in SAS Management Console Using the SAS Management Console, navigate to the Server Manager Plug-ins hierarchy, select the SASApp SAS DATA Step BatchServer, right-click, Properties and navigate to the Options tab, select Advanced Options. Replace the default Rolling Log Options: value of _#Y.#m.#d_#H.#M.#s.log with an _, underscore. For example: 13

SAS 9.2 Enterprise Business Intelligence Audit and Performance Measurement SAS Management Console, DATA Step BatchServer Advanced Options Dialog Update the StoredProcessServer Properties in SAS Management Console Using the SAS Management Console, with the SAS administrator User ID, navigate to the Stored Process Server, Server Properties, Request dialog. For example: Select: Server Manager -> SASApp->SASApp - Logical StoredProcess Server Right-Click, select: Properties -> Options -> Set Server Properties -> Request Within the dialog box, set the initialization and termination programs to be SASEnvironment/SASMacro/stparmstart.sas and SASEnvironment/SASMacro/stparmstop.sas respectively. 14

SAS 9.2 Enterprise Business Intelligence Audit and Usage Instrumentation and Reporting SAS Management Console: Enabling the stparmstart.sas and stparmstop.sas macros Restart the SAS ObjectSpawner to enable the package updates The SAS ObjectSpawner should be restarted after completing the previous updates and changes to enable the package. Restarting the ObjectSpawner will re-cycle the various SAS Analytic Server and the performance logs will be emitted for each of the customized servers. Step 4: Configuring Environment Settings for Multiple Machine Deployments The default installation and configuration instructions describe how to enable audit and reporting for an environment where the SAS Server Tier resides on a single machine. Sites that have multiple machine deployments should refer to section Configuring Environment Settings for Multiple Machine Deployments, in the appendix, for information and instructions to enable audit and performance reporting for these environments. Step 4a: Create PerfLogs Directories for Multi-Machine Deployments 15

SAS 9.2 Enterprise Business Intelligence Audit and Performance Measurement The directories for the performance logs were created on the local node during the runcfg script. For multi-machine deployments navigate to the <sasconfigdir>/sasapp server directory and create a new directory named./perflogs. A directory should be created for each server that will have ARM performance logs enabled, for example, a typical server deployment may have the following directory organization: $ pwd /data/92/configdir/lev1/sasapp $ ls -1l */PerfLogs grep PerfLogs BatchServer/PerfLogs: ConnectServer/PerfLogs: GridServer/PerfLogs: OLAPServer/PerfLogs: PooledWorkspaceServer/PerfLogs: StoredProcessServer/PerfLogs: WorkspaceServer/PerfLogs: Step 4b: Create AuditLogs Directories for Multi-Machine Deployments If applicable, the directory for the Metadata Server audit logs was created on the local node during the runcfg script. For multi-machine deployments navigate to the <sasconfigdir>/sasmeta directory and create a new directory named./metadataserver/auditlogs. Step 5: Customization of the Server and Web Tier Reports The package includes support to monitor the state of the SAS Server and Web Tier as well as the ability to present the status reports through an http server or as a dashboard using SAS Portal and SAS BI Dashboard Web applications. The following section describes how to enable and customize the server and web tier status reports. Customization is accomplished through a series of deployment steps and updates to include: 1. Registering SAS Metadata Server to Enable Dynamic Reports 2. Customizing Status Reports SAS LIBNAME and SAS Web Application 3. Customizing the Environment to Generate Dynamic HTML Reports 4. Creating a SAS Portal Dashboard for Server and Web Tier Reports Registering SAS Metadata Server to Enable Dynamic Reports 16

SAS 9.2 Enterprise Business Intelligence Audit and Usage Instrumentation and Reporting Enabling the server and web tier dynamic reports requires customizing several metadata library repositories and deploying SAS stored processes to execute on demand or through a recurring or scheduled process. The SAS stored processes are distributed as an exported SAS Management Console package. The following information describes creating the required metadata libraries and stored processes. Using the SAS Management Console, with an administrative User ID, navigate to the Folders tab and select SAS Folders -> Shared Data. Right click and select Import SAS Package. Select the EBIAPM92.spk package, which is located in the <sasusagedir>/ebiapm92/utilities directory. The following images depict the steps required to import the package. Note that during the import process, the SAS Application Server and the Source Code Repository properties should be updated to match the local site settings. Additionally, select the import options, Include Access Controls check-box and the All Objects radio button. SAS Management Console, Select Import SAS Package, /SAS Folders/Shared Data 17

SAS 9.2 Enterprise Business Intelligence Audit and Performance Measurement SAS Management Console, Select both Audit Reports and QueryServer SAS Management Console, Update Target value, <SASApp> for example 18

SAS 9.2 Enterprise Business Intelligence Audit and Usage Instrumentation and Reporting SAS Management Console, verify SASEnvironment/SASCode/Jobs Customizing the Dynamic Status and Audit Reports The previous step, Registering SAS Metadata, distributed the SAS stored processing into the local SAS 9.2 Enterprise BI Server configuration directory. The following file will need to be modified to enable the SAS Web Application Server stored processes and to customize the SAS LIBNAME processing to access and update the appropriate libraries:./sasenvironment/sascode/jobs/setenv_ebiapm.sas Modify the <package_install_location> value to match the value defined during the Configuring the Audit and Reporting Environment Settings section. /* Set SAS Usage Report Directory */ %let sasusagedir=<package_install_location>/ebiapm92; Modify the <www.webappserver.com> and <port> statements in the program to match the Web Application Server and Port values for the local environment.... /* Set the SAS Web Application Server URL and Port */ %let STPURL=http://<www.WebAppServer.com>:<port>/SASStoredProcess/do?;... 19

SAS 9.2 Enterprise Business Intelligence Audit and Performance Measurement This completes the metadata registration process and updates for the dynamic status and audit reports. Customizing the Environment to Generate Dynamic HTML Reports The dynamic HTML reports are distributed within the package in the Html directory. The following table describes each of the html files and their function: SAS Enterprise BI Status Report HTML files Name bi_audit_reports.html bi_perf_reports.html bi_status.html bi_status_portal.html bienv.html setenvlogs.js Description Launches SAS stored process to emit metadata audit reports Displays the static server performance usage reports Launches SAS stored process to display SAS server and web tier status SAS Portal html page to display SAS server and web tier status Primary server and web tier status frame, with links to the dependent pages Javascript program that sets local environment properties for the HTML files To enable reports, copy the contents of the.\ebiapm92\html directory to the HTTPServer directory specified in the sashttpdocspath environment variable in setenvlogs.cfg.sh The underlying status, performance and audit reports will be deployed into the web server environment during the validation processing described in subsequent sections. When the pages are integrated into a web server framework and customized, the Enterprise BI Server and Audit Reports will resemble the following page: 20

SAS 9.2 Enterprise Business Intelligence Audit and Usage Instrumentation and Reporting SAS 9.2 Enterprise BI Audit and Performance Web Page This completes the required steps to install, configure and customize the Audit and Performance reporting package. Sites may optionally choose to add the status reports into a SAS Portal environment, described in the next section. Creating a SAS Portal Dashboard for Server and Web Tier Reports SAS 9.2 Enterprise BI installations that have licensed SAS Information Delivery Portal and SAS BI Dashboard may optionally integrate the status reporting framework into the SAS Portal. This step is optional, and is intended to complement features that are available within the SAS Enterprise BI framework. Step 1: Using a Portal Administrative User ID, log onto the SAS Portal and select the Options ->Add Page menu. Complete the Name, Description, Keywords and Rank fields as desired, select Add and then select Done. For example, the following images demonstrate a sample page. 21

SAS 9.2 Enterprise Business Intelligence Audit and Performance Measurement SAS Portal Add Page Menu Dialog SAS Portal Add Pages to Profile Dialog Step 2: Navigate to the new page tab within the portal, select Options ->Edit Page Content, Add Portlet, then select URL Display Portlet menu item. Complete the Name, Description and Keywords as desired, select Add. Repeat the Add step for each of the desired audit and performance reports to be integrated into the SAS Portal. The following example demonstrates adding the SAS Institute Home page to the portal. When completed, there will be a total of four URL portlets defined to include: 22

SAS 9.2 Enterprise Business Intelligence Audit and Usage Instrumentation and Reporting SAS Institute Home Page SAS 9.2 Metadata Server Audit Reports SAS 9.2 Enterprise BI Server Performance Reports SAS 9.2 Enterprise BI Server and Web Tier Status Report SAS Portal Add Portlets to Page Dialog Select Done on the Add Portlets to Page dialog Step 3. Selecting Done on the previous page returns to the Edit Page Content dialog. This dialog enables the administrator to select the size, column and position of the URL portlets on the portal. Organize the portlets as desired, select OK. SAS Portal Edit Page Content Dialog 23

SAS 9.2 Enterprise Business Intelligence Audit and Performance Measurement Step 4. In the previous dialogs, the portlets were defined as page content, the final step is to define the URL associated with each of the portlets. From the main portal page, select the Edit Content menu item on the header for each URL portlet. Specify the URL value, and content height as desired, select Save. For example, using the previously defined portlets, the URL values include: SAS Institute Home Page: http://www.sas.com Metadata Server Audit Reports: http://domain.name/path/ bi_audit_reports.html BI Server Performance Reports: http://domain.name/path/ bi_perf_reports.html BI Server and Web Tier Status Report: http://domain.name/path/ bi_status_portal.html NOTE: The BI Server and Web Tier Status Report uses a portal specific html page. SAS Portal Edit Portlet Dialog The underlying status, performance and audit reports will be deployed into the web server environment during the validation processing described in subsequent sections. When complete, the Portal page for the Enterprise BI Audit and Performance reports should resemble the following page: 24

SAS 9.2 Enterprise Business Intelligence Audit and Usage Instrumentation and Reporting SAS 9.2 Enterprise BI Audit and Performance Portal Page This completes the configuration for adding the package reports to the SAS Information Delivery Portal. Validating the Configuration The installation and configuration process required a number of steps to customize the Enterprise BI environment. It is important to validate the correct behavior of the modifications before enabling any automated processes for scheduled reporting. The following information will guide the administrator through the steps to ensure the configurations changes and reports processes are executing correctly. The steps to validate the configuration include the following: 1. Verify the SAS Enterprise BI Servers are emitting the correct logs 2. Verify the performance and audit logs are processed by the reporting package 3. Verify the status, audit and performance reports are generated correctly Validating Metadata Server Audit Logs Ensure the metadata server has been restarted after making the required changes to the MetadataServer logconfig.xml file. These changes are described in the section Enabling Metadata 25

SAS 9.2 Enterprise Business Intelligence Audit and Performance Measurement Server Audit Logs. Navigate to the <sasconfigdir>/lev1/sasmeta/metadataserver/auditlogs directory and confirm log files exist in the form of: For example: Access_SASMeta_MetdataServer_<yyyy-mm-dd>_<pid>.log Audit_SASMeta_MetdataServer_<yyyy-mm-dd>_<pid>.log Access_SASMeta_MetadataServer_2010-03-12_188576.log Audit_SASMeta_MetadataServer_2010-03-12_188576.log The contents of these logs are used as input data for generating the Metadata Server Audit reports. If the logs are not present, verify the changes to the logconfig.xml file for the metadata server; verify the server has been restarted; and confirm no warnings or errors in the server log file. Validating BI Server Performance Logs The server performance logs were enabled by modifications to each of the server logconfig.xml files, described in the section Enabling Enterprise BI Server Performance Logs. Restart each server by using the <sasconfigdir>/<lev1>/sas.servers script, with the restart option. Navigate to the./perflogs directory for each of the servers that were configured and confirm a log file in the form of: For example: arm4_<servername>_<yyyy-mm-dd>_<pid>.log arm4_olapserver_2010-01-18_868576.log The contents of this log are used as input data for generating the usage and performance reports. If the log files are not present, verify the changes to the logconfig.xml file for the affected server; verify the server has been restarted; and confirm no warnings or errors in the server log file. Validating the Audit and Performance Log Processing The package includes a shell script, readsaslogs.sh, which performs several key steps for processing the Audit and Performance logs. The steps include moving the server logs from the <sasconfigdir>/<lev1>/<sasapp>/<servername>/perflogs directory into the <sasusagedir>/<servername>/logs directory and creating the artifacts SAS dataset used by subsequent processing. Execute the readsaslogs.sh and review the generated log file for any warnings or errors. The log file is: <sasusagedir>/runsasreportslog/runartifactanalyzer.sas_<setenvlogs>.log 26

SAS 9.2 Enterprise Business Intelligence Audit and Usage Instrumentation and Reporting Additionally, view the <sasusagedir>/data/artifacts directory to confirm the following SAS data sets are created: artifactusagedetails.sas7bdat dtinfoall.sas7bdat Validating the Performance Report Processing The runsasreports.sh script initiates the process of analyzing the SAS data sets created during the readsaslogs.sh processing. The source code for the reports is located in the directory: <sasusagedir>/sasenvironment/sascode/jobs/usagereports The script iterates through each SAS program in the directory and run the reports successively. A unique log file is created for each SAS program, review the log files located in the directory: <sasusagedir>/runsasreportslog Additionally, using SAS ODS features, each SAS report generates an HTML file in the directory: <sasusagedir>/html/results Review these reports and confirm that the reports are being generated properly and the contents are as expected for the environment and usage. If the reports are not being generated, review the logs for any errors or warnings. Initially, some of the audit and performance reports will not contain data, until such time as sufficient audit and performance log data is collected, analyzed and archived. Validating the SAS Server and Web Application Status Reporting The runcheckserver.sh script initiates the validation of the SAS Server and Web Tier application status. The script queries the SAS Metadata Server for the local configuration settings, then executes a series of SAS programs to test the status of the applications. Execute the script and review the logs for any errors or warnings. The process creates the following log files: <sasusagedir>/runsasreportslog/bi_metadata_query.sas.log <sasusagedir>/runsasreportslog/bi_webhealth_status.sas.log <sasusagedir>/runsasreportslog/bi_server_status.sas.log Additionally, view the <sasusagedir>/data/status directory to confirm the following SAS data sets are created: sas92_bi_health.sas7bdat metadata_list.sas7bdat sas92_webapp_health.sas7bdat 27

SAS 9.2 Enterprise Business Intelligence Audit and Performance Measurement Validating Data Collection and Log Archiving Processing The rundataachive.sh utility enables collection of server logs, report processing and archiving of collected logs. The utility also includes client validation of configured servers, backup of metadata and deploying the generated reports from the <sasusagedir>/html/results location to the configured HTTPServerPath location. Execution of the script may take several minutes, depending on the amount of data collected in the logs and processing time to execute the steps. Any errors encountered during script will cause the processing to stop with a failing ERROR message. Execute the rundataarchive.sh and review the generated logs file for any warnings or errors. The logs are created file in the directory: <sasusagedir>/runsasreportslog/ The script calls several dependent shell utilities during execution, to include the readsaslogs.sh and the runsasreports.sh script. If errors are encountered, it may be necessary to review the specific dependent shell utility or log to determine the nature of the issue. Navigate to the HTTPServerPath location to confirm that the reports from the <sasusagedir>/html/results location were copied into the HTTPServerPath location. Finally, using a web browser, navigate to the web server address and path that were configured in the setenvlogs.js configuration script to confirm the status, audit and performance reports are correct. For example, assuming a JBOSS deployment, with the following configuration settings in setenvlogs.sh: :: Usage reports will be copied from the sasusagedir to this location set HTTPServerPath=/opt/jboss-4.2.3/server/SASServer1/deploy/jbossweb.deployer/ROOT.war/Ebiapm92 And, the configuration settings in setenvlogs.js : /* Set the local http server address */ setenvarray[0] = "http://sasebiserver.domain.com:8080"; /* Set the local path for html source files */ setenvarray[1] = "Ebiapm92"; Navigate to the HTTP path for bienv.html : http://sasebiserver.domain.com:8080/ebiapm92/bienv.html This completes the configuration phase and validation stages for the deployment. To finalize the package deployment and integration, enable the environment to execute on a recurring basis using recommendations described in the following section. 28

SAS 9.2 Enterprise Business Intelligence Audit and Usage Instrumentation and Reporting Operational Administration and Reporting The installation and customization updates in the previous sections, allowed the site to define and enable the required reports for the Server and Web Tier environments. The following information prescribes recommendations on how an administrator may want to manage the environment on a recurring basis. The recommendations include the following main areas: 1. Scheduling an Interval for Validating Server Status 2. Scheduling an Interval for Data Collection and Log Archiving 3. Archiving and Administration of Package SAS Data Sets 4. Utilizing Performance, Status and Audit Reports Scheduling an Interval for Validating Server Status The package includes a utility program, runcheckserver.sh which queries the SAS Enterprise BI Server and Web Tier environment. The program executes a series of SAS and host specific programs to verify the server status, generate SAS output data sets and reports. These reports are then made available through the bi_status.html and bi_status_portal.html that were configured in the previous section. The runcheckserver.sh program should be enabled to run periodically, as desired, to report on the environment. The following output from a UNIX crontab l command displays runcheckserver.sh configured to execute every 5 minutes from 9AM to 4PM, Monday Friday. Note that the crontab command includes a cd command to the installation location for the package: # Run every xx minutes from 9am to 4pm and Mon-Fri 0,5,10,15,20,25,30,35,40,45,50,55 9,10,11,12,13,14,15,16 * * 1,2,3,4,5 cd /opt/var/sas/ebiapm92; /bin/ksh /opt/var/sas/ebiapm92/runcheckserver.sh > /opt/var/sas/ebiapm92/runcheckserver.log 2>&1 Scheduling an Interval for Data Collection and Log Archiving The rundataarchive.sh script enables collection, report processing and archiving of the server logs. The rundatearchive.sh processing will need to be scheduled on a recurring basis, so that the static audit and performance reports are updated for daily server activity. SAS recommends that the data collection be initiated during a period of inactivity for the analytic server environment, preferably after 12 AM. This ensures that all server activity is collected on a daily basis, as well as, ensures rollover logs for the previous day s activities are closed near midnight. Additionally, the supplied rundataarchive.sh script includes support to backup and archive the current Metadata Server metadata repository. 29

SAS 9.2 Enterprise Business Intelligence Audit and Performance Measurement The following output from a UNIX crontab l command displays rollover.log configured to execute daily at 12:01 AM. Note that the crontab command includes a cd command to the installation location for the package: 01 00 * * 1,2,3,4,5,6 cd /opt/var/sas/ebiapm92;/bin/ksh /opt/var/sas/ebiapm92/ rundataarchive.sh > /opt/var/sas/ebiapm92/rundataarchive.log 2>&1 Archiving and Administration of Package SAS Data Sets The package includes two utility SAS programs for administration of the package data libraries. The log processing and reporting phases of the package include creating a number of SAS data sets. Periodically, a site should archive or backup the data sets for audit or regulatory compliance purposes. Additionally, a site may choose to index or archive historical data for performance optimization purposes of current audit and performance data. The two utility programs are ebiapm_archive_data.sas ebiapm_create_indexs.sas The ebiapm_archive_data.sas program may be customized to archive historical data that is associated with the artifactusagedetails and the audit_transactions SAS data sets. The ebiapm_create_indexs.sas program creates indexs for improving runtime performance for the query and reporting processing. Utilizing Performance, Status and Audit Reports The set of performance, status and audit reports that are delivered with the package are intended to serve as a framework for initial reporting of a site deployment. Administrators may want to optimize the reports to their unique site requirements. The following information provides an overview of the reports, to help the administrator determine what changes or modification may be required to meet local site installation requirements. Metadata Server Audit Reports The metadata server audit data is processed during the data collection and log archiving steps as described earlier in this section. The data is collected and stored in a SAS data set for subsequent reporting, using the Metadata Server Audit Reports form. The form includes several pre-defined reports, along with user selected date ranges, report formats and output styles. The following images depict a typical query and output report for Metadata Access Control Changes : 30

SAS 9.2 Enterprise Business Intelligence Audit and Usage Instrumentation and Reporting Metadata Server Audit Access Control Reports Metadata Server Audit Access Control Report Enterprise BI Server Performance Reports The BI Server Performance data is processed during the data collection and log archiving steps as described earlier in this section. The server statistics are collected, analyzed and reports are generated based on the last data collection execution cycle. These reports may be customized as needed by an administrator. Additionally, reports may be added to the collection by simply writing a new report 31

SAS 9.2 Enterprise Business Intelligence Audit and Performance Measurement and placing the report into the SASEnvironment/SASCode/Jobs/usageReports directory. The following images depict the default reports available, as well as the output from a SAS WebReportStudio and SAS PROC Usage report: Enterprise BI Server Performance Reports SASWebReportStudio Key Actions Report The default report, ReportUsageTopTen.html, includes a report type of REPORT. This report uses data collected from the SASWebReportStudio key actions log. The report depicts the SAS WRS report name and frequency of usage. A site may consider optimizations to this report to include information such as: User ID, date and time of report usage and related metrics. 32

SAS 9.2 Enterprise Business Intelligence Audit and Usage Instrumentation and Reporting SASWebReportStudio Usage REPORT type SAS Workspace Server Usage Reports There are two default reports which include usage information for Workspace servers, WorkspaceTopUsers.html and WorkspaceTopMemoryUsers.html. These reports allow administrators to ascertain workspace server usage patterns for SAS client applications such as Enterprise Guide and Data Integration Studio. The reports include session metrics such as cumulative sessions per user, total elapsed time, processor utilization, session IO operations and session memory allocation. These reports may serve as a basis for administrators to create highly customized reports for workspace server usage patterns and capacity planning purposes. Refer to the comments provided in the.sas source code for modifying the user count or reporting period, as well as, using the elapsed time, total cpu time or session input/output metrics as reporting criteria. The source code for these reports is located in: <sasusagedir>/sasenvironment/sascode/jobs/usagereports/workspacetopusers.sas <sasusagedir>/sasenvironment/sascode/jobs/usagereports/workspacetopmemoryuser.sas 33

SAS 9.2 Enterprise Business Intelligence Audit and Performance Measurement Workspace Server Top Users by Session Count Workspace Server Top Users by Memory Utilization SAS Procedure Usage Report 34

SAS 9.2 Enterprise Business Intelligence Audit and Usage Instrumentation and Reporting Enterprise BI Server PROC USAGE Elapsed Time Graph 35

SAS 9.2 Enterprise Business Intelligence Audit and Performance Measurement Enterprise BI Server Performance PROC USAGE report, continued Enterprise BI Server and Web Tier Status Report The server and web tier status reports consists of three unique set of validation metrics. The Monitoring column contains three values, Mid-Tier, Ports and Servers. 36

SAS 9.2 Enterprise Business Intelligence Audit and Usage Instrumentation and Reporting The Mid-Tier results are generated through a SAS StoredProcess that validates that the SAS Web Application services, such as SASWebReportStudio, are available through a HTTP Web Application Server. The status and last checked columns represent that availability and time of the last validation. If a SAS Web Application is not respoding, the status will report down. The Servers results are generated though a SAS supplied validation program to interogate the status of a SAS Server tier application. If a server does not respond, the status will report down. Additionally, the elapased time to validate the server status is retained for historical reporting purposes. SAS 9.2 Enterprise BI Server and Web Tier Status Report In the following image, the status results when the SAS OLAP and SAS Table Server are not responding to a validation query. In this instance, both the OLAP and Table Server were quiesced, which denies new connections, causing the validation of the server to fail. 37

SAS 9.2 Enterprise Business Intelligence Audit and Performance Measurement SAS 9.2 Enterprise BI Server failure status report Enabling Alert Capabilities for Status Failures The features of the package are enabled using capabilities within the SAS language and therefore may be further optimized using SAS language elements. This includes generating alerts for status errors within the server environment. The following information describes how to enable site specific alert features for errors detected when generating the Enterprise BI Server and Web Tier Status Report. Enabling an Email Alert, via SMTP The SAS EMAIL (SMTP) access method enables the ability to send an email using the Simple Mail Transfer Protocol from within a SAS language program. The package includes an email feature that can be enabled to automatically emit an email, should an error or failure occurring during processing. To automatically generate an email alert for a status failure, customize the ebiapm92/setenvlogs.sas program, by adding the following SAS macro definitions: /* Enable EMAIL Alerts for Server and WebTier Status Failures */ /* Syntax requires each email address to be double quoted, */ 38