c-treeace Server Monitor
c-treeace Server Monitor
Contents 1. c-treeace Monitor... 4 2. Startup... 5 3. Active Connections Tab... 6 4. System SnapShot Tab... 8 5. User SnapShot Tab... 9 6. SnapShot Favorites Tab... 11 7. System Configuration Tab... 13 8. I/O Performances Tab... 14 9. Function Timing Tab... 16 10. System Monitor Tab... 17 11. Files / Locks... 19 12. Server Monitor Menus and Tool Bar... 21 13. Stop Server Dialog... 23 14. Quiesce the Server... 23 15. Index... 26 All Rights Reserved iii
1. c-treeace Monitor The c-treeace Monitor is a client tool designed to monitor and report Server activity. It can be useful to check events, configuration settings, connected users and much more. All Rights Reserved 4
Startup 2. Startup The following connection window appears each time an instance of this utility is started. Server Connection Server Name/Port Number - Using this combo box you can select if you are going to specify the c-treeace Server Name or its TCP/IP port number in the underlying text box. This example shows the Server Name "FAIRCOMS". Machine Name/IP Address - Use this text box to specify the IP address or the machine name where the c-treeace Server is running. If your c-treeace Server is running on your local machine, using the "localhost" machine name will provide better performance. User Options User Name - Specify the user name you want to use to make the connection to the c-treeace Server. Password - Use this text box to enter the user's password. Note the default "User Name" and "User Password" are both "ADMIN" and the Password is case sensitive. When you're done press OK to establish the connection. If you press Cancel the tool will not be connected to the c-treeace Server. All Rights Reserved 5
Active Connections Tab 3. Active Connections Tab This page shows information about each user actively connected to the c-treeace Server. Connected User Columns Task Id - This column lists the user's unique task id assigned by the c-treeace Server. Name - This column lists the name the user specified at connection time. Last Function - This column lists the last function called by this user. Logon Time - This column lists when this user connected to the c-treeace Server. Last Request Time - This column lists the last time this user made a request to the c-treeace Server. Last TRANBEG Time - This column lists when this issued the last Transaction Begin (TRANBEG()) function call. This is a common function call for signifying activity (note, it is possible to design an application that will not make this function call so it is possible for this value to be static). Open Files # - This column lists the number of files opened by the current user. Memory - This column lists the amount of memory in use by the current user. A.R.I. - This column reports the "Active Request Indicator" which indicates if the process is currently making a request to the c-treeace Server. A value of "1" indicates a request (or function call) is being made to the Server and a value of "0" indicates no request is currently in process. Comm Info - This column lists the communication protocol being used by the current user to connect to the c-treeace Server. Typical values will be: All Rights Reserved 6
Active Connections Tab FSHAREMM = a non-sql connection has been established from the local machine using the Shared Memory communication protocol. SQL_SHAREMM = a SQL connection has been established from the local machine using the Shared Memory communication protocol. F_TCPIP = a non-sql connection has been established using the TCP/IP communication protocol. SQL_TCPIP = a SQL connection has been established using the TCP/IP communication protocol. Node ID Info - This column lists the node information set by the client application used by current user. (See F.227 SetNodeName on page F385 of the c-tree Function Reference Guide) Connected Users Contextual Menu (Terminating a User Connection) Kill Selected Connection - It is possible to terminate a user from this list of connected users by right clicking on the user's row and clicking on the "Kill Selected Connection" menu item. Note, if Auto Refresh is active all the values listed here will be automatically updated every time the Auto Refresh Rate (page 21) (defined in the Options menu) lapses. All Rights Reserved 7
System SnapShot Tab 4. System SnapShot Tab The System SnapShot tab shows all the information stored within the c-treeace System SnapShot Structure which includes useful Server activity and performance information. Items listed in this tab can be added to the SnapShot Favorites tab by right clicking on a specific item. System SnapShot Columns Number - A unique number assigned to each System SnapShot structure member for display purposes on this page Member - The current System SnapShot member name. Category - The System SnapShot members are grouped into categories to simplify finding related information. Description - A description for the current System SnapShot member. Value - The total cumulative value for the current System SnapShot member. Value/Sec - The per-second average for the current System SnapShot member. System SnapShot Contextual Menu The System SnapShot contextual menu is available by right clicking on each System SnapShot Item and provides support for: All Rights Reserved 8
User SnapShot Tab Add Selected To Favorites - Adds the selected System SnapShot member to the SnapShot Favorites tab. Add Selected Category To Favorites - Adds all the selected System SnapShot members contained within the selected member category to the SnapShot Favorites tab. More information about the User SnapShot structure and its members can be found in the c-treeace product documentation by searching for "SnapShot". Note, if Auto Refresh is active all the values listed here will be automatically updated every time the Auto Refresh Rate (page 21) (defined in the Options menu) lapses. Otherwise you will need to press the Refresh Icon to renew the values. 5. User SnapShot Tab The User SnapShot tab displays information stored in c-treeace User SnapShot structure for the connected user. User SnapShot entries can be added to SnapShot favorites by right clicking the desired row header and selecting Add to Favorites. User SnapShot Columns Number - A unique number assigned to each User SnapShot structure member for display purposes on this page. All Rights Reserved 9
User SnapShot Tab Member - The current User SnapShot member name. Category - The User SnapShot members are grouped into categories to simplify finding related information. Description - A description for the current User SnapShot member. Value - The total cumulative value for the current User SnapShot member. Value/Sec - The per-second average for the current User SnapShot member. User SnapShot Contextual Menu The User SnapShot contextual menu is available by right clicking on each User SnapShot Item and provides support for: Add Selected To Favorites - Adds the selected System SnapShot member to the SnapShot Favorites tab. Add Selected Category To Favorites - Adds all the selected System SnapShot members contained within the selected member category to the SnapShot Favorites tab. More information about the User SnapShot structure and its members can be found in the c-treeace product documentation by searching for "SnapShot". Note, if Auto Refresh is active all the values listed here will be automatically updated every time the Auto Refresh Rate (page 21) (defined in the Options menu) lapses. Otherwise you will need to press the Refresh Icon to renew the values. All Rights Reserved 10
SnapShot Favorites Tab 6. SnapShot Favorites Tab This page shows the User and System SnapShot values you have added by using the contextual menu (accessed by right clicking) on the System SnapShot and User SnapShot pages. Favorite schemes can be saved and loaded from disk with the Load Favorites and Save Favorites buttons. Live monitoring can be recorded and saved to disk for detailed analysis at a future time by using the Record menu. SnapShot Favorite Buttons Load Favorites - Loads a previously saved SnapShot Favorites scheme from a file. Save Favorites - Saves the current SnapShot Favorite scheme to a file. Record Start - Begins recording the current SnapShot Favorite session to a file. Record Pause - Pauses the recording session. Record Stop - Stops the recording session. Current Value - Check this box if you want to include the Current Value column in the recording session. Values / sec. - Check this box if you want to include the Values / sec. column in the recording session. All Rights Reserved 11
SnapShot Favorites Tab SnapShot Columns # - A unique number assigned to each member listed on the SnapShot "Favorites" page. SnapShot - This column reports the current SnapShot type, User, or System indicating the source the listed value was obtained from. Member - The current System SnapShot member name. Category - The System SnapShot members are grouped into categories to simplify finding related information. Description - A description for the current System SnapShot member. Value - The total cumulative value for the current System SnapShot member. Value/Sec - The per-second average for the current System SnapShot member. SnapShot Favorites Contextual Menu The SnapShot Favorites contextual menu is available by right clicking on each SnapShot Item and provides support for: Remove From Favorites - Removes the selected member from the SnapShot Favorites tab. Remove Category From Favorites - Removes all the members in the selected category from the SnapShot Favorites tab. Remove All - Removes all the entries from the SnapShot Favorites tab. More information about the SnapShot structure and its members can be found in the c-treeace product documentation by searching for "SnapShot". Note, if Auto Refresh is active all the values listed here will be automatically updated every time the Auto Refresh Rate (page 21) (defined in the Options menu) lapses. Otherwise you will need to press the Refresh Icon to renew the values. All Rights Reserved 12
System Configuration Tab 7. System Configuration Tab This read-only page shows information about the configuration and current values of selected metrics (e.g., current memory usage, number of open file handles, etc.) for the c-treeace Server. System Configuration Columns Element Index - The unique number of the element item for display purposes on this page. Element Name - The current element name. Value - The total cumulative value for the current configuration element. Value/Sec - The per-second average for the current configuration element. Note, if Auto Refresh is active all the values listed here will be automatically updated every time the Auto Refresh Rate (page 21) (defined in the Options menu) lapses. Otherwise you will need to press the Refresh Icon to renew the values. All Rights Reserved 13
I/O Performances Tab 8. I/O Performances Tab This tab details the following input/output performance metrics for the c-treeace Server. Most of the metrics are also available in a graphical view within c-treeace Performance Monitor. Data Buffer Requests Data Buffer Hits Index Buffer Requests Index Buffer Hits Number of Read Operations Number of Bytes Read Number of Write Operations Number of Bytes Written Number of Committed Read Operations Number of Committed Bytes Read Number of Committed Write Operations All Rights Reserved 14
I/O Performances Tab Number of Committed Bytes Written Number of Transaction Savepoint Number of Transaction Restores Number of Transaction Begins Number of Transaction Ends Number of Transaction Aborts Number of Transaction Checkpoints System Time Value Number of SyncDosFlush Number of SyncLogFile Number of SyncCtreeFile I/O Performance Columns Element Index - The unique number of the element item for display purposes on this page. Element Name - The current element name. Value - The total cumulative value for the current element. Value/Sec - The per-second average for the current element. Note, if Auto Refresh is active all the values listed here will be automatically updated every time the Auto Refresh Rate (page 21) (defined in the Options menu) lapses. Otherwise you will need to press the Refresh Icon to renew the values. All Rights Reserved 15
Function Timing Tab 9. Function Timing Tab The Function Timing Tab collects call frequency and accumulates execution time for the functions executed by the c-treeace Server. To start collecting timing information press the Start Collecting button. To stop collecting press the Stop Collecting button. Reset the counters by pressing Clear Timings button. Function Timing Buttons Start Collecting - Starts collecting function call frequency and execution time. Stop Collecting - Stops collecting function call frequency and execution time. Clear Timings - Clears the function call counters. Function Timing Columns Number - The unique function call number for display purposes on this page. Name - This column lists the function call name. Call Count - This column lists how many times the function has been called since the last time this tool loaded or the counters were reset with the Clear Timing button. Call Count/Sec. - This column lists how many times the function has been called in the current second. Note this column is measured in seconds. All Rights Reserved 16
System Monitor Tab Total Time (sec) - This column lists the total execution time of the current function since the last time this tool loaded or the counters were reset with the Clear Timing button. Note this column is measured in seconds. Time/Call (msec)- This column lists the amount of time (measured in milliseconds) the last execution of the function required to execute. Chart Total Row The top row (highlighted in yellow) lists the call count totals and the total elapsed time. Call Count - Represents the number of different function calls Total Time (sec.) - Represents the sum of the total execution time for all function calls. Note, if Auto Refresh is active all the values listed here will be automatically updated every time the Auto Refresh Rate (page 21) (defined in the Options menu) lapses. Otherwise you will need to press the Refresh Icon to renew the values. 10. System Monitor Tab The System Monitor Tab collects system event information. Example of this would be: each time the Server is stopped, a Thread is terminated; a Dynamic Dump (the c-treeace hot backup facility) is initiated; etc. System monitor has two separate monitors: (1) the Main Monitor watches critical server events; and (2) Perf Monitor watches performance-related events. To enable either Monitor press the Start Monitor button. To stop collecting press the stop Stop Monitor button. Note you may only have one instance of the Main Monitor and the Perf Monitor per c-treeace Server. However, if another process already has a monitor started, you may terminate their instance and start your own instance by using the Forced Start button. Only users within the "ADMIN" group may use the Forced Start button. All Rights Reserved 17
System Monitor Tab Remember if you don't have auto-refresh enabled you will need to press the refresh button in order to see new System Monitor events. System Monitor "Main" Monitor Group Buttons Start Monitor - Starts the system monitor in "Main" mode and begins to collect "Main" monitor events, which include Server Shutdown messages, Thread Terminated messages, Dynamic Dump status, etc. Forced Start - Forces the start of the system monitor in "Main" mode by first shutting down any other active Main Monitors. Stop Monitor - Stops the system monitor in "Main" mode. System Monitor "Perf" Monitor Group Buttons Start Monitor - Starts the system monitor in "Perf" mode and begins to collect performance related events. Forced Start - Forces the start of the system monitor in "Perf" mode by first shutting down any other active Perf Monitors. Stop Monitor - Stops the system monitor in "Main" mode. System Monitor Columns Date/Time - The date and time when the current event occurred. Type - The type of Monitor (Main or Perf) that triggered the event. Return Value - The current event return value or error code. All Rights Reserved 18
Files / Locks Event Text or Error Description - The description of the current event or error code. Note, if Auto Refresh is active all the values listed here will be automatically updated every time the Auto Refresh Rate (page 21) (defined in the Options menu) lapses. Otherwise you will need to press the Refresh Icon to renew the values. 11. Files / Locks This page shows files opened by the c-treeace Server and individual Users in addition to locks held by individual users. Files Opened by Options Server / User Buttons - Click Server to see the files opened by the Server or click User to see the files opened by a specific user. Use the pull down list to the right of the User label to select the user of interest. Users / Locks Buttons - Use these two buttons to change the view for the bottom window. Select a file of interest in the Opened Files pane and then click Users to change the bottom window to a view of other users that also have this file open. Select a file of interest in the Opened Files pane and then click Locks to change the bottom window to a view of other users that also have active locks within this file. All Rights Reserved 19
Files / Locks Opened Files Columns # - A unique file number assigned for display purposes on this page. Filename - The name of the file as it appears on disk. File Type - The type of file. Options for this column include: D = Data File with Fixed length records; V = Data File with Variable length records; I = Index File; H = Superfile Host; M = Superfile Member. UFN - User File Number - This is the file number the end user application is using for the specific file, or if the file number is a negative value, it has one of the following meanings: -1 = File is blocked by a c-treeace file close. -3 = File is blocked by a ctfbsysclose file block. -4 = File is blocked by a ctfbsysclose file block established by this connection (or user). -5 = File is suspended by a ctfbsysclose file block. SFN - System File Number - Specifies the file number the c-treeace Server is using for this file. Opened - This column specifies the number of users that have the specific file open. Users for File Columns # - A unique user number assigned for display purposes on this page. Task Id - This column lists the user's unique task ID assigned by the c-treeace Server. User Name - This column lists the name the user specified at connection time. UFN - User File Number - This is the file number the end user application is using for the specific file, or if the file number is a negative value, it has one of the following meanings: -1 = File is blocked by a c-treeace file close. -3 = File is blocked by a ctfbsysclose file block. -4 = File is blocked by a ctfbsysclose file block established by this connection (or user). -5 = File is suspended by a ctfbsysclose file block. Host IP Address - This is the IP address or the Host Name (DNS) for the specified User. Locks for File Columns # - A unique lock number assigned for display purposes on this page. Offset - The offset from the beginning of the file where the lock is being held. Lock Type - The type of lock being held. Types of Locks Types of Locks The possible lock types are shown in the following table. Lock Type Value Explanation SS open 1 SS (strict serializer) logical Open lock SS commit intent 2 SS commit intent lock SS commit 3 SS commit lock NS commit intent 4 NS (nonstrict serializer) commit intent lock All Rights Reserved 20
Server Monitor Menus and Tool Bar Lock Type Value Explanation NS commit 5 NS commit lock read 6 Read lock - A read lock requested and held by a user thread. write/1 9 Exclusive write lock - A write lock requested and held by a user thread. write/2 10 Exclusive write lock (no aggregate check) - An internal lock very briefly held by the c-tree Server for files under transaction control. You may occasionally observe these in a system with a high transaction volume, and these can be safely ignored. forcei cmtlok 11 A very briefly held commit read lock enforced by the c-tree Server. These will only occur when the COMMIT_READ_LOCK option is enabled in the server configuration file. These may be occasionally observed in systems with high transaction volumes. Note: The first five lock types listed in the table are only supported with a c-tree Server built with strict serialization support. User Name - The Task Id (see above) that is currently holding the lock. Host IP Address - The IP address or the Host Name (DNS) for the user currently holding the lock. Waiters - The number of other users (or processes) currently waiting for the lock. 12. Server Monitor Menus and Tool Bar Server Menu - Use this menu to manage c-treeace Monitor connections with the c-treeace Server. Connect - Shows the connection dialog in order to create a new connection between this utility and the c-treeace Server. Disconnect - Closes the current connection between this utility and the c-treeace Server. Stop Server - Shows the stop server dialog in order to stop the c-treeace Server. See the Stop Server Dialog (page 23) chapter in this book for more information. All Rights Reserved 21
Server Monitor Menus and Tool Bar Quiesce Server - Puts the c-treeace Server into a quiet (or suspended) state of operation. See the Quiesce the Server (page 23) chapter in this book for more important details. Exit - Disconnects this utility from the c-treeace Server and closes this utility. Options Menu - Use this menu to access the c-treeace Monitor option settings. AutoConnect - If this option is active, a checkbox will appear next to the menu label and this utility will save the connection information used the last time to connect to the c-treeace Server. This will keep the Connection Options (page 5) dialog box from appearing the next time this utility is started. Remember Password - If this option is active, a checkbox will appear next to the menu label and this utility will save the password used during this instance. This is a nice feature to use in conjunction with AutoConnect. AutoRefresh - Shows the dialog box that allows you to enable/disable auto refresh and to specify the number of seconds to wait between refresh operations. Set to 0 (zero) to disable this feature. Help Menu - Use this menu to access the c-treeace Monitor help information. Help Contents - Display the c-treeace Performance Monitor help file. Help Index - Display the c-treeace Performance Monitor help index. Help Search - Display the c-treeace Performance Monitor help search window. About - Provide information about the version of the c-treeace Performance Monitor executable. Server Monitor Tool Bar Tool bar items are shortcuts to the Menu commands, they can be very useful to pick fast server operation. - Connect - Shows the connection dialog in order to create a new connection between this utility and the c-treeace Server. All Rights Reserved 22
Stop Server Dialog or - Disconnect - Closes the current connection between this utility and the c-treeace Server. If the "gray" icon is currently showing it means this utility is not currently connected to the Server. - Stop Server - Shows the stop server dialog in order to stop the c-treeace Server. See the Stop Server Dialog (page 23) chapter in this book for more information. - Quiesce Server - Puts the c-treeace Server into a quiet (or suspended) state of operation. See the Quiesce the Server (page 23) chapter in this book for more important details. - Refreshes all the values. 13. Stop Server Dialog This dialog box is accessed from the Server Menu and Toolbar Stop Server icon and allows you to stop the c-treeace Server. To stop the server, set the delay time and then click OK. Cancel will abandon the dialog with no action taken. 14. Quiesce the Server Temporarily suspends operation of the c-treeace Server for specific administrative actions. Periodically, there may be times where an administrator may wish to open a maintenance window for more detailed and comprehensive data management. Stopping the c-treeace Server can be a challenging task in a high availability setting with large numbers of users. Coordinating this down time can be a frustrating experience. What is needed is a functionality to halt c-tree Server operations cleanly, while allowing user applications to remain connected. This function is frequently referred to as quiesce. The quiesce functionality allows an administrator to suspend, quiet or quiesce, c-treeace operations and later re-enable them. This allows c-treeace administrators to perform maintenance or other on-demand activities without having to stop an application. Users are temporarily held back from operations. Files can be readily accessed for backup, especially useful for hardware-based disk snapshot utilities. All Rights Reserved 23
Quiesce the Server To use this powerful feature, simply set the "Pending transaction not committed" time and then press the Quiesce button. Note that any transactions that have not committed within the setting specified here will be aborted, so set this value wisely. Note, it is also important to understand that any applications being serviced by the c-treeace Server during a quiescent state (e.g., quiet state) will be suspended. Therefore be careful not to put the Server in this state and then induce any unnecessary delays. All Rights Reserved 24
Copyright Notice Copyright 1992-2015 FairCom Corporation. All rights reserved. No part of this publication may be stored in a retrieval system, or transmitted in any form or by any means, electronic, mechanical, photocopying, recording or otherwise without the prior written permission of FairCom Corporation. Printed in the United States of America. Information in this document is subject to change without notice. Trademarks c-treeace, c-treertg, c-treeams, c-tree Plus, c-tree, r-tree, FairCom and FairCom s circular disc logo are trademarks of FairCom, registered in the United States and other countries. The following are third-party trademarks: AMD and AMD Opteron are trademarks of Advanced Micro Devices, Inc. Macintosh, Mac, Mac OS, and Xcode are trademarks of Apple Inc., registered in the U.S. and other countries. Embarcadero, the Embarcadero Technologies logos and all other Embarcadero Technologies product or service names are trademarks, service marks, and/or registered trademarks of Embarcadero Technologies, Inc. and are protected by the laws of the United States and other countries. Business Objects and the Business Objects logo, BusinessObjects, Crystal Reports, Crystal Decisions, Web Intelligence, Xcelsius, and other Business Objects products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of Business Objects Software Ltd. Business Objects is an SAP company. HP and HP-UX are registered trademarks of the Hewlett-Packard Company. AIX, IBM, POWER6, POWER7, and pseries are trademarks or registered trademarks of International Business Machines Corporation in the United States, other countries, or both. Intel, Intel Core, Itanium, Pentium and Xeon are trademarks or registered trademarks of Intel Corporation or its subsidiaries in the United States and other countries. Microsoft, the.net logo, the Windows logo, Access, Excel, SQL Server, Visual Basic, Visual C++, Visual C#, Visual Studio, Windows, Windows Server, and Windows Vista are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. Novell and SUSE are registered trademarks of Novell, Inc. in the United States and other countries. Oracle and Java are registered trademarks of Oracle and/or its affiliates. QNX and Neutrino are registered trademarks of QNX Software Systems Ltd. in certain jurisdictions. CentOS, Red Hat, and the Shadow Man logo are registered trademarks of Red Hat, Inc. in the United States and other countries, used with permission. UNIX and UnixWare are registered trademarks of The Open Group in the United States and other countries. Linux is a trademark of Linus Torvalds in the United States, other countries, or both. Python and PyCon are trademarks or registered trademarks of the Python Software Foundation. OpenServer is a trademark or registered trademark of Xinuos, Inc. in the U.S.A. and other countries. Btrieve is a registered trademark of Actian Corporation. ACUCOBOL-GT, MICRO FOCUS, RM/COBOL, and Visual COBOL are trademarks or registered trademarks of Micro Focus (IP) Limited or its subsidiaries in the United Kingdom, United States and other countries. iscobol and Veryant are trademarks or registered trademarks of Veryant in the United States and other countries. All other trademarks, trade names, company names, product names, and registered trademarks are the property of their respective holders. Portions 1987-2015 Dharma Systems, Inc. All rights reserved. This software or web site utilizes or contains material that is 1994-2007 DUNDAS DATA VISUALIZATION, INC. and its licensors, all rights reserved. Portions Copyright 1995-2013 Jean-loup Gailly and Mark Adler. 12/16/2015
15. Index A Active Connections Tab 6 C Copyright Notice xxv c-treeace Monitor 4 F Files / Locks 19 Function Timing Tab 16 I I/O Performances Tab 14 Q Quiesce the Server 22, 23 S Server Monitor Menus and Tool Bar 7, 9, 10, 12, 13, 15, 17, 19, 21 SnapShot Favorites Tab 11 Startup 5, 22 Stop Server Dialog 21, 23 System Configuration Tab 13 System Monitor Tab 17 System SnapShot Tab 8 U User SnapShot Tab 9 All Rights Reserved 26