Configuring Events and Logging - TIBCO Software · 1.2 Overview of Events and Logging Events...

www.tibco.com

GlobalHeadquarters 3303HillviewAvenue PaloAlto,CA94304

Tel:+1650-846-1000 +1800-420-8450 Fax:+1650-846-1005

ProfessionalServices

TIBCOSoftwareempowersexecutives,developers,andbusinessuserswithFastDatasolutionsthatmaketherightdataavailableinrealtimeforfasteranswers,betterdecisions,andsmarteraction.Overthepast15years,thousandsofbusinessesacrosstheglobehavereliedonTIBCOtechnologytointegratetheirapplicationsandecosystems,analyzetheirdata,andcreatereal-timesolutions.LearnhowTIBCOturnsdata—bigorsmall—intodifferentiationatwww.tibco.com.

Configuring Events and Logging



Revision History Version Date Author Comments

1.0 March 2015 Tony Young Initial version

Related Documents This document is related to:

Document Date Author

Configuring Events and Logging.xlsx

March 2015 Tony Young



Copyright Notice COPYRIGHT© TIBCO Software Inc. This document is unpublished and the foregoing notice is affixed to protect TIBCO Software Inc. in the event of inadvertent publication. All rights reserved. No part of this document may be reproduced in any form, including photocopying or transmission electronically to any computer, without prior written consent of TIBCO Software Inc. The information contained in this document is confidential and proprietary to TIBCO Software Inc. and may not be used or disclosed except as expressly authorized in writing by TIBCO Software Inc. Copyright protection includes material generated from our software programs displayed on the screen, such as icons, screen displays, and the like.

Trademarks All brand and product names are trademarks or registered trademarks of their respective holders and are hereby acknowledged. Technologies described herein are either covered by existing patents or patent applications are in progress.

Confidentiality The information in this document is subject to change without notice. This document contains information that is confidential and proprietary to TIBCO Software Inc. and its affiliates and may not be copied, published, or disclosed to others, or used for any purposes other than review, without written authorization of an officer of TIBCO Software Inc. Submission of this document does not represent a commitment to implement any portion of this specification in the products of the submitters.

Content Warranty The information in this document is subject to change without notice. THIS DOCUMENT IS PROVIDED "AS IS" AND TIBCO MAKES NO WARRANTY, EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO ALL WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. TIBCO Software Inc. shall not be liable for errors contained herein or for incidental or consequential damages in connection with the furnishing, performance or use of this material.

Export This document and related technical data, are subject to U.S. export control laws, including without limitation the U.S. Export Administration Act and its associated regulations, and may be subject to export or import regulations of other countries. You agree not to export or re-export this document in any form in violation of the applicable export or import laws of the United States or any foreign jurisdiction.

For more information, please contact:

TIBCO Software Inc. 3303 Hillview Avenue Palo Alto, CA 94304 USA



Table of Contents 1 Introduction ................................................................................................... 8

1.1 Purpose ........................................................................................................................... 81.2 Overview of Events and Logging .................................................................................... 81.3 Configuring SNMP Traps .............................................................................................. 10

1.3.1 Enable SNMP Events ....................................................................................... 101.3.2 Trap Host List ................................................................................................... 101.3.3 TDV MIB File .................................................................................................... 10

2 Cache Events .............................................................................................. 122.1 Cache Clear .................................................................................................................. 122.2 Cache Disable ............................................................................................................... 122.3 Cache Enable ................................................................................................................ 122.4 Cache Refresh End ....................................................................................................... 122.5 Cache Refresh Fail ....................................................................................................... 122.6 Cache Refresh Start ...................................................................................................... 12

3 Cluster 133.1 Server Connected ......................................................................................................... 133.2 Server Disconnected ..................................................................................................... 133.3 Server joined ................................................................................................................. 133.4 Server Shunned ............................................................................................................ 13

4 Data Source ................................................................................................. 144.1 Connection Check In ..................................................................................................... 144.2 Connection Check Out .................................................................................................. 144.3 Connection Fail ............................................................................................................. 144.4 Connection Invalid ......................................................................................................... 144.5 Connection Pool Exhausted .......................................................................................... 144.6 Connection Pool Size Decrease ................................................................................... 144.7 Connection Pool Size Increase ..................................................................................... 154.8 Data Source Down ........................................................................................................ 154.9 Data Source Fail ........................................................................................................... 154.10 Data Source Modify ....................................................................................................... 154.11 Data Source Off ............................................................................................................ 154.12 Data Source On ............................................................................................................ 154.13 Data Source Up ............................................................................................................. 154.14 Introspection Cancel ..................................................................................................... 154.15 Introspection End .......................................................................................................... 164.16 Introspection Fail ........................................................................................................... 164.17 Introspection Start ......................................................................................................... 164.18 Statistics Processing Complete ..................................................................................... 164.19 Statistics Processing Fail .............................................................................................. 164.20 Statistics Processing Start ............................................................................................ 164.21 Test Fail ......................................................................................................................... 164.22 Test Start ....................................................................................................................... 174.23 Test Success ................................................................................................................. 17

5 Request 18



5.1 Prepared Statement Fail ............................................................................................... 185.2 Prepared Statement Success ....................................................................................... 185.3 Request Cancel ............................................................................................................. 185.4 Request End ................................................................................................................. 185.5 Request Fail .................................................................................................................. 185.6 Request Inactive Time .................................................................................................. 185.7 Request Run Time ........................................................................................................ 185.8 Request Start ................................................................................................................ 185.9 Request Wait ................................................................................................................. 195.10 Request Wait Queue Threshold Passed ....................................................................... 195.11 Request Wait Queue Threshold Reset ......................................................................... 19

6 Resource 206.1 Resource Create ........................................................................................................... 206.2 Resource Delete ........................................................................................................... 206.3 Resource lock ............................................................................................................... 206.4 Resource Unlock ........................................................................................................... 206.5 Statistics Processing Complete ..................................................................................... 206.6 Statistics Processing Fail .............................................................................................. 206.7 Statistics Processing Start ............................................................................................ 20

7 Security 217.1 RBS Assign ................................................................................................................... 217.2 RBS Create ................................................................................................................... 217.3 RBS Delete ................................................................................................................... 217.4 RBS Disable .................................................................................................................. 217.5 RBS Enable ................................................................................................................... 217.6 RBS Remove................................................................................................................. 217.7 RBS Update .................................................................................................................. 217.8 User Lock Status Changed ........................................................................................... 217.9 User Locked Implicitly ................................................................................................... 22

8 Session 238.1 Session End .................................................................................................................. 238.2 Session Login Fail ......................................................................................................... 238.3 Session Max Connections Exhausted ........................................................................... 238.4 Session Non Localhost Request Fail ............................................................................ 238.5 Session Open Time ....................................................................................................... 238.6 Session Start ................................................................................................................. 238.7 Session Terminate ........................................................................................................ 23

9 Storage 249.1 Storage Low Critical ...................................................................................................... 249.2 Storage Low Warning .................................................................................................... 24

10 System Overview ........................................................................................ 2510.1 Domain Create .............................................................................................................. 2510.2 Domain Delete .............................................................................................................. 2510.3 Group Create ................................................................................................................ 2510.4 Group Delete ................................................................................................................. 25



10.5 Monitor Fail .................................................................................................................... 2510.6 Monitor Start .................................................................................................................. 2510.7 Monitor Stop .................................................................................................................. 2510.8 Server Repository Down ............................................................................................... 2610.9 Server Repository Up .................................................................................................... 2610.10Server Restart ............................................................................................................... 2610.11Server Restart Fail ........................................................................................................ 2610.12Server Start ................................................................................................................... 2610.13Server Stop ................................................................................................................... 2710.14Server Stop Planned ..................................................................................................... 2710.15Server Stop Unplanned ................................................................................................. 2710.16User Add To Group ....................................................................................................... 2710.17User Create ................................................................................................................... 2710.18User Delete ................................................................................................................... 2710.19User Password Modify .................................................................................................. 2810.20User Remove From Group ............................................................................................ 28

11 Transaction ................................................................................................. 2911.1 Transaction Commit ...................................................................................................... 2911.2 Transaction Compensate .............................................................................................. 2911.3 Transaction Fail ............................................................................................................. 2911.4 Transaction Rollback ..................................................................................................... 2911.5 Transaction Start ........................................................................................................... 29

12 Trigger 3012.1 Trigger End ................................................................................................................... 3012.2 Trigger Fail .................................................................................................................... 3012.3 Trigger Start .................................................................................................................. 30

13 Conclusion .................................................................................................. 31



1 Introduction

1.1 Purpose The purpose of this paper is to provide guidance for setting event logging targets for TIBCO Data Virtualization (TDV)

This document assumes a working knowledge of TDV, as well as the ability to navigate Studio to access the Configuration panel

This document is broken into major sections according to the major sections of the events sub-section of the configuration panel, with a discussion of settings changes that would assist the majority of clients in properly logging and auditing the TDV server. Individual client requirements may override these general recommendations

1.2 Overview of Events and Logging Events referenced are configured in the Configuration panel in Studio under Server / Events and Logging / Event Generation and are separated by category. Events may be logged to zero or more logging targets. The following logging targets are available:

• DB: Log the event in the system database

• LOG: Log the event in the cs_server_events.log file



• SNMP: Send the event as an SNMP trap

• CUSTOM: Send the event to the custom logger

• ALL: Log the event to all four of the above logging targets

• NONE: Ignore the event

For each event, it is possible to specify a comma-separated list of logging targets. For example, to log an event to the cs_server_events.log file, and the system database, set the event value in the Configuration panel to DB,LOG

NOTE: event values of ALL and NONE cannot be combined with other logging targets

The remainder of this document is structured to discuss the recommended logging targets for each event type, organized by category. A description of each event will be followed by a recommendation of logging targets. For events where SNMP traps are recommended, a discussion of notification methods and troubleshooting steps is also included

In general, events are sent to logging targets for certain reasons:

• NONE: This is a user-controlled event, and, we assume the user caused and will resolve any problems

• LOG: Events that may be incorporated into a corporate audit should be sent to the events log file, where a separate archival process should retain logs for a period defined as required by the client

• DB: Events that may require investigation, but are not urgent, should be sent to the system database



• SNMP: Events that require immediate investigation and resolution should raise SNMP traps. These particular events will also discuss suggested notification paths and troubleshooting steps

1.3 Configuring SNMP Traps TDV must be configured to send SNMP traps, if desired. To configure TDV to send SNMP traps, set the configuration parameters under Server / Events and Logging / Logging / SNMP (i.e. enable SNMP trap generation, and specify the SNMP listener hostname and port.) The Trap Port and Trap Community parameters do not require modification. However, Enable SNMP Events and Trap Host List must both be set:

1.3.1 Enable SNMP Events true: enable SNMP for sending events. false: disable SNMP for sending events.

Recommended setting: true

Reasoning: TDV implements passive monitoring and notification through SNMP traps. TIBCO highly recommends enabling SNMP traps, and monitoring traps through a network monitoring tool. If using SNMP traps with TDV, see the “Configuring Events and Logging” document, and accompanying tracking spreadsheet

1.3.2 Trap Host List A comma separated list of host names/IPs that will be sent SNMP v1 trap messages.

Recommended setting: comma separated list of network monitoring tool hostnames

Reasoning: TDV implements passive monitoring and notification through SNMP traps. TIBCO highly recommends enabling SNMP traps, and monitoring traps through a network monitoring tool. If using SNMP traps with TDV, see the “Configuring Events and Logging” document, and accompanying tracking spreadsheet

1.3.3 TDV MIB File The MIB (Management Information Base) is a file that describes the SNMP traps that can be raised by an application. The TDV MIB resides in

$TDV_HOME/apps/server/CompositeSoftware-MIB.mib

Each TDV MIB file is versioned, and, each SNMP trap includes the MIB version number. A given TDV release or patch may include a modified MIB, which may result in a new version number. When performing a TDV upgrade, check the release notes to determine if the MIB file has changed, and, provide the updated MIB to your network monitoring team

TDV raises SNMP v1 compliant traps. The latest version for SNMP is v3, but any Network Monitoring tool that supports SNMP v3 should be backward compatible. This allows TDV to support as many monitoring tools as possible, and these tools must be configured to receive and process traps. To configure a Network Monitoring tool to receive and process TDV SNMP traps:

• Import the MIB

• Configure the Trap Community credential

• Configure the device/application to be monitored – i.e. TDV

• Choose the interesting TDV SNMP traps to monitor (see below for recommendations)

• Assign an action to each trap (see below for recommendations)



2 Cache Events

2.1 Cache Clear A resource cache has been cleared

Recommended logging targets: LOG,DB

2.2 Cache Disable A resource cache has been disabled

Recommended logging targets: LOG

2.3 Cache Enable A resource cache has been enabled


2.4 Cache Refresh End A resource cache refresh operation has finished


2.5 Cache Refresh Fail A resource cache refresh operation has failed

Recommended logging targets: LOG,DB,SNMP

Recommended notification action: Send a pager notification to TDV admins

Possible troubleshooting steps: Determine the cause of the failure. Resolve any errors and restart the refresh operation

2.6 Cache Refresh Start A resource cache refresh operation has started




3 Cluster

3.1 Server Connected A server has connected to a cluster


Recommended notification action: Send an email to TDV admins

Possible troubleshooting steps: If the notification was expected, it may be ignored. If the notification was not expected, determine why the server connected to the cluster and take remedial action to correct any errors

3.2 Server Disconnected A server has disconnected from a cluster



Possible troubleshooting steps: Examine cs_cluster.log and determine what caused the server to disconnect from the cluster. Take remedial action and re-join the node to the cluster

3.3 Server joined A server has joined a cluster


3.4 Server Shunned A server has been shunned from a cluster



Possible troubleshooting steps: Examine cs_cluster.log and determine what caused the server to be shunned. Re-join the server to the cluster



4 Data Source

4.1 Connection Check In A connection to a data source has been checked into the connection pool

Recommended logging targets: NONE

4.2 Connection Check Out A connection to a data source has been checked out of the connection pool


4.3 Connection Fail A connection to a data source has failed



Possible troubleshooting steps: Determine cause of failure: invalid or expired password, broken network link, data source down, etc

4.4 Connection Invalid A connection to a data source has been found to be invalid


Recommended notification action: Send an email notification to TDV admins and developers

Possible troubleshooting steps: Investigate the cause of the invalidation: a timeout, data source down, etc

4.5 Connection Pool Exhausted A data source connection pool has been exhausted



Possible troubleshooting steps: Look to increase connection pool size (if appropriate) or reduce connection use

4.6 Connection Pool Size Decrease A data source connection pool size has been decreased




4.7 Connection Pool Size Increase A data source connection pool size has been increased


4.8 Data Source Down A data source connection test has completed and the data source is down




4.9 Data Source Fail A data source connection has failed




4.10 Data Source Modify A data source has been modified


4.11 Data Source Off A data source has been disabled


4.12 Data Source On A data source has been enabled


4.13 Data Source Up A data source connection test has completed and the data source is up


4.14 Introspection Cancel Data source introspection has been cancelled




4.15 Introspection End Data source introspection has completed


4.16 Introspection Fail Data source introspection has failed


4.17 Introspection Start Data source introspection has started


4.18 Statistics Processing Complete Statistics gathering has completed for a data source


4.19 Statistics Processing Fail Statistics gathering has failed for a data source



Possible troubleshooting steps: Notify the developers to investigate and restart processing if appropriate

4.20 Statistics Processing Start Statistics gathering has started for a data source


4.21 Test Fail A datasource connection test has failed






4.22 Test Start A datasource connection test has started


4.23 Test Success A datasource connection test was successful




5 Request

5.1 Prepared Statement Fail A prepared statement that was executed in/by TDV has failed


5.2 Prepared Statement Success A prepared statement was executed in/by TDV successfully


5.3 Request Cancel A request has been cancelled inside TDV or from a client tool


5.4 Request End A request has completed


5.5 Request Fail A request has failed


5.6 Request Inactive Time Controls the period of time after which a request is checked for inactivity. If found inactive, it is considered stale, resulting in the generation of a RequestInactive event

Recommended setting: >= Request Idle Timeout

5.7 Request Run Time Controls the period of time after which a request is considered to be long-running, resulting in the generation of a RequestRunForTooLong event

Recommended setting: >= Request Idle Timeout

5.8 Request Start A request has started




5.9 Request Wait A request has entered the "waiting" state


Recommended notification action: Send an email to TDV administrators

Possible troubleshooting steps: Increase the number of concurrent requests allowed. Add more servers to a cluster

5.10 Request Wait Queue Threshold Passed The maximum amount of time a request may wait for execution has passed


Recommended notification action: Send an email to TDV administrators

Possible troubleshooting steps: Increase the number of concurrent requests allowed. Add more servers to a cluster

5.11 Request Wait Queue Threshold Reset The maximum amount of time a request may wait has been reset for a request




6 Resource

6.1 Resource Create A resource was created


6.2 Resource Delete A resource was deleted


6.3 Resource lock A resource has been locked


6.4 Resource Unlock A resource has been unlocked


6.5 Statistics Processing Complete Statistics gathering has completed for a data source


6.6 Statistics Processing Fail Statistics gathering has failed for a data source



Possible troubleshooting steps: Notify the developers to investigate and restart processing if appropriate

6.7 Statistics Processing Start Statistics gathering has started for a data source




7 Security

7.1 RBS Assign A row based security policy has been assigned to a resource


7.2 RBS Create A row based security policy has been created


7.3 RBS Delete A row based security policy has been deleted


7.4 RBS Disable Row based security has been disabled


7.5 RBS Enable Row based security has been enabled


7.6 RBS Remove A row based security policy has been removed from a resource


7.7 RBS Update A row based security policy has been updated


7.8 User Lock Status Changed A user account has either been locked or unlocked


Recommended notification action: Send an email notification to TDV admins



Possible troubleshooting steps: Notify the user their account has been locked/unlocked and determine why. Unlock as appropriate

7.9 User Locked Implicitly A user account is locked




8 Session

8.1 Session End A user has logged out of TDV


8.2 Session Login Fail A user has attempted to login to TDV and the login attempt failed


8.3 Session Max Connections Exhausted A user has attempted to login to TDV and the login attempt failed because the maximum number of user sessions have already been created



Possible troubleshooting steps: Increase the number of servers in a cluster. Increase the number of allowed sessions on a server

8.4 Session Non Localhost Request Fail A request has failed for a session that is not internal to TDV


8.5 Session Open Time The number of minutes since the session started. After which, a server event SessionRunForTooLong is generated

Recommended setting: >= Session Idle Timeout

8.6 Session Start A user has logged into TDV


8.7 Session Terminate A user session was terminated




9 Storage

9.1 Storage Low Critical The disk space allocated to TDV has reached the "critical" threshold



Possible troubleshooting steps: Check the directory noted as close to full. Remove unneeded files - or - add more space to the partition holding the files

9.2 Storage Low Warning The disk space allocated to TDV has reached the "low" threshold



Possible troubleshooting steps: Check the directory noted as close to full. Remove unneeded files - or - add more space to the partition holding the files



10 System Overview

10.1 Domain Create A new LDAP domain was created in Manager


10.2 Domain Delete A LDAP domain was deleted in Manager


10.3 Group Create A group was created in the Composite domain in Manager


10.4 Group Delete A group was deleted in the Composite domain in Manager


10.5 Monitor Fail The monitor daemon has failed



Possible troubleshooting steps: Look in cs_monitor.log file to determine cause of failure; Look in cs_monitor.out for cause of failure

10.6 Monitor Start The monitor daemon has started



Possible troubleshooting steps: Look in cs_monitor.log file to determine cause of startup

10.7 Monitor Stop The monitor daemon has stopped





Possible troubleshooting steps: Look in cs_monitor.log file to determine cause of stop Look in cs_monitor.out for cause of stop

10.8 Server Repository Down The metadata repository is not accessible or has failed



Possible troubleshooting steps: Look at repository database log file for cause of failure. Look at cs_server.log for cause of failure

10.9 Server Repository Up The metadata repository is accessible



Possible troubleshooting steps: If the notification was expected, it may be ignored. If the notification was not expected, determine why the repository came up and determine if any remediation steps are necessary

10.10 Server Restart TDV has restarted



Possible troubleshooting steps: Determine the cause of the server restart (failure, planned, etc.) and take any necessary remediation steps

10.11 Server Restart Fail TDV failed to restart



Possible troubleshooting steps: Check cs_server.log, cs_monitor.log, cs_server.out, cs_monitor.out for errors and clues to failure

10.12 Server Start TDV started





Possible troubleshooting steps: If the server start was expected, the notification may be ignored. If the server start was not expected, determine why the server started and if any remediation steps are necessary

10.13 Server Stop TDV stopped




10.14 Server Stop Planned TDV executed a planned stop from the Stop button or scripts



Possible troubleshooting steps: If the stop was expected, the notification may be ignored. If the stop was not expected, determine why the server stopped

10.15 Server Stop Unplanned TDV server crashed




10.16 User Add To Group A user was added to a group in the Composite domain in Manager


10.17 User Create A user was created in the Composite domain in Manager


10.18 User Delete A user was deleted in the Composite domain in Manager




10.19 User Password Modify The password for a user in the Composite domain has been modified


10.20 User Remove From Group A user was removed from a group in the Composite domain in Manager




11 Transaction

11.1 Transaction Commit A commit operation was executed inside a transaction


11.2 Transaction Compensate A compensating transaction has executed for a failed or rolled back transaction


11.3 Transaction Fail A transaction has failed


11.4 Transaction Rollback A rollback operation was executed inside a transaction


11.5 Transaction Start A transaction has begun




12 Trigger

12.1 Trigger End Execution of a trigger ends


12.2 Trigger Fail Execution of a trigger fails


Recommended notification action: Send an email to TDV developers; Send an email to TDV admins

Possible troubleshooting steps: Log into Manager / Studio and check event log and trigger panels for details on cause

12.3 Trigger Start Execution of a trigger begins




13 Conclusion

This document has outlined some event logging targets that will configure TDV for optimal monitoring, management, and auditing

TIBCO recommends the use of a tracking tool to keep track of TDV event logging settings. Please see the example spreadsheet accompanying this document as a sample

Configuring Events and Logging - TIBCO Software · 1.2 Overview of Events and Logging Events...

Documents

Transcript of Configuring Events and Logging - TIBCO Software · 1.2 Overview of Events and Logging Events...