|
Adaptive Server Enterprise Monitor Client-Library Programmer's Guide
|
About This Book
Sybase(R) Adaptive Server(TM) Enterprise Monitor(TM) Client Library Programmer's Guide describes how to write Sybase Adaptive Server Enterprise Monitor Client Library (Monitor Client Library) applications that access Sybase Adaptive Server Enterprise performance data.
Audience
This guide is for programmers who use Adaptive Server Enterprise Monitor Server or Adaptive Server Enterprise Monitor Historical Server.
How to Use This Book
When writing a Monitor Client Library application, use this book as a source of general information on how to construct Monitor Client Library programs.
- Chapter 1, "Getting Started with Monitor Client Library" explains how to structure a basic Monitor Client Library program and includes a simple, complete Monitor Client Library application.
- Chapter 2, "Data Items and Statistical Types" describes data items, statistical types, and valid data item combinations of data items used in Monitor Client Library applications to gather performance data.
- Chapter 3, "Monitor Client Library Functions" describes each function including syntax, parameter values, examples, permissions, and related functions.
- Chapter 4, "Building a Monitor Client Library Application" describes how to compile and link a Monitor Client Library program.
- Chapter 5, "Monitor Client Library Configuration Instructions," explains how to configure Monitor Client Library on UNIX or Windows NT.
- Appendix A, "Examples of Views" provides examples of valid views.
- Appendix B, "Datatypes and Structures" summarizes datatypes used by Monitor Client Library and describes the datatypes that have no equivalent in C or Open-Client Client Library.
- Appendix C, "Backward Compatibility" lists obsolete functions and their replacement functions.
- Appendix D, "Troubleshooting Information and Error Messages" explains how to respond to problems that you might have with Monitor Client Library and lists error messages that may be reported.
Related Documents
Read the following books for more information about Adaptive Server Enterprise Monitor Client Library, Monitor Server, and Historical Server:
- Adaptive Server Enterprise Monitor Release Bulletin contains the product description, release notes, and platform-specific information about your release of Adaptive Server Enterprise Monitor.
- Adaptive Server Enterprise Monitor Server User's Guide describes how to set up and start Monitor Server.
- Adaptive Server Enterprise Monitor Historical Server User's Guide describes how to set up and start Historical Server.
Other Sources of Information
Use the following books for more information about Adaptive Server Enterprise configuration and tuning:
- Managing and Monitoring Sybase Adaptive Server Enterprise describes how to manage Adaptive Server Enterprise and monitor its activities using Sybase Central(TM).
- Adaptive Server Enterprise Performance and Tuning Guide describes how to analyze Adaptive Server Enterprise performance and tune it to improve performance.
- Adaptive Server Enterprise Reference Manual describes SQL commands, functions, and stored procedures used with Sybase Adaptive Server Enterprise.
- Adaptive Server Enterprise System Administration Guide contains information about administering Adaptive Server Enterprise.
Use the SyBooks(TM) and SyBooks-on-the-Web online resources to learn more about your product:
- SyBooks documentation is on the CD that comes with your software. The DynaText browser, also included on the CD, allows you to access technical information about your product in an easy-to-use format.
Refer to Installing SyBooks in your documentation package for instructions on installing and starting SyBooks.
- SyBooks-on-the-Web is an HTML version of SyBooks that you can access using a standard Web browser.
To use SyBooks-on-the-Web, go to http://www.sybase.com, and choose Documentation.
Conventions
The following sections describe the conventions used in this manual.
Text Conventions
Commands to enter online are in a narrow, bold typeface:
monserver
Boldface also indicates emphasis or indicates that a definition accompanies the highlighted term.
Variable names, document titles, file names, directory names, and Adaptive Server Enterprise table names are in italic typeface:
-Umyname
Adaptive Server Enterprise Monitor Server User's Guide
SQLMon.mrg file
$SYBASE directory
systables
Command Syntax
Command syntax statements use the following notational conventions:
Table 1: Command syntax conventionsExample | Description |
|---|
monserver | Command keywords appear in lowercase. |
option | Variables (words that stand for values that you supply in the command) appear in italic. |
[option] | Brackets mean that including the enclosed items in the command is optional. Do not include the brackets in your command. |
option... | Ellipses indicate that you may repeat the preceding item as many times as you like in the command. Do not include ellipses in your command. |
If You Need Help
You can get help about the Monitor Client Library from the documentation and from the Technical Support Center.
Technical Support
Each Sybase installation that has purchased a support contract has one or more designated people who are authorized to contact Sybase Technical Support. If you cannot resolve a problem using the manuals or online help, please have the designated person contact Sybase Technical Support or the Sybase subsidiary in your area.