How do I enable and manage analytics server logging?

Purpose

The following steps describe how to enable, configure, or disable the logging of Analytics events on an NSP analytics server, for example, when troubleshooting purposes.

By default, an analytics server logs only error events.

CAUTION 

CAUTION

System disruption

Performing the procedure restarts the analytics server.

Also, the logging is verbose; the created log files may consume excessive disk space if logging is enabled for an extended period.

Perform the procedure only if required, and only for the period required to collect the log entries of interest. Contact technical support for assistance or more information.

Note: The following RHEL CLI prompt in a command line denotes the nsp user, and is not to be included in a typed command:

Note: If the analytics servers are redundant, you must perform the procedure on each analytics server to ensure that all log events are collected, for example, in the event that Analytics begins using a different analytics server, or if analytics load balancing is enabled.

Steps
 
1 

Log in as the nsp user on the NSP analytics server station.

2 

Open a console window.

3 

Enter the following:

bash$ cd /opt/nsp/analytics/bin ↵

4 

Enter the following:

bash$ ./AnalyticsAdmin.sh enableLog object ↵

where object is one of the following:

  • ADHOC—generates logs during ad hoc report design

  • SQL—logs the SQL commands that the analytics server generates during report execution

  • ALL—enables all available log objects

The following message and prompt are displayed.

This Action requires Analytics Server restart.

Please type 'YES' to continue.

5 

Enter YES.

The following is displayed as the analytics server restarts and the logging begins.

Stopping Analytics Application

date time Starting Analytics Application

Waiting for Analytics Server to come up

date time Analytics Server is UP and Running

Analytics Server successfully started!

The log entries are stored in the following file:

  • /opt/nsp/analytics/log/analytics.server.log

6 

To change the logging level, perform the following steps:

Note: You must use the resetLog option to disable any logging level that is enabled. For example, if ALL logging is enabled, and you want only SQL logging, you must disable ALL logging, and then enable SQL logging; using the enableLog option does not disable any previously enabled logging level.

  1. Reset the logging level, as described in Step 7.

  2. Go to Step 4.

7 

To reset the logging function to the default of logging only error events, perform the following steps.

  1. Enter the following:

    bash$ AnalyticsAdmin.sh resetLog ↵

    The following message and prompt are displayed.

    This Action requires Analytics Server restart.

    Please type 'YES' to continue.

  2. Enter YES.

    The following is displayed as the analytics server restarts and the logging is reset to the default level.

    Stopping Analytics Application

    date time Starting Analytics Application

    Waiting for Analytics Server to come up

    date time Analytics Server is UP and Running

    Analytics Server successfully started!

8 

Close the console window.

End of steps