Version 2.4.0

Table of Contents

I. General Information
Mercury Architecture
Monitoring Protocol
Protocol Elements
Metric Definitions
Host metrics
Application metrics
Internal metrics
GridLab Project
Dissemination and Further Plans
II. Administrator and User Guide
Building and Installing Mercury
Software Requirements
Building and Installing the Mercury Grid Monitoring System
Quick Setup
Configuration Options
Monitoring System Configuration
File Format
Configuration Files
Common Sections
Access Control List files
The cluster_hosts file
Software Components of Mercury
Producer Daemons
Sensor modules
Module cpuid: processor type and cache information for ix86
Module darwin: host sensor for Darwin
Module gtop: retrieve information through the libgtop2 library
Module irix: host sensor for IRIX
Module linux: host sensor for Linux
Module mach: host sensor for operating systems based on the Mach microcernel
Module osf: host sensor for OSF/1-based systems
Module solaris: host sensor for Solaris
Module tru64: host sensor for Tru64 UNIX
Module unix: host sensor for various UNIX-like systems
Metric comparison table
III. Manual Pages
I. User Programs
MONCLIENT - Command-line consumer client
MONEXEC - Command-line actuator client
DBARCHIVER - Database consumer client
MONBENCH - Command-line consumer client
TESTCLIENT - Very simple consumer client
MONAPPTEST - Test program for application monitoring
MONGDB - GDB wrapper for remote debugging
II. System Programs
LM - Local monitor daemon
MM - Main monitor daemon
MONITOR_GETCFG - Configuration file parser
IV. API Reference
III. Common Functions
Authentication Support - API for loadable authentication modules
Metric and Control Arguments - Functions for managing argument lists used by metrics and controls
Basic IO Functions - Functions for stacking various I/O layers on top of each other
Buffer Handling - Buffer handling functions
Configuration - Parsing configuration files and querying configuration data
Lightweight Context Switching - Support for asychronous execution
IO Event Handling - Functions to support asynchronous I/O
Inter-Process Communication - Local authentication and shared memory management
Logging - Printing log messages to files, to syslog or to the terminal
Module Loading - Handling of dynamic shared objects (DSOs)
Expressions and Data Types - Parsing, printing and evaluating data types and values
Network-Related Functions - Various functions for managing network addresses and interfaces
Command Line Options - Support for long options
Path Discovery - Resolving file names with optional relocation support
Protocol Definitions - Constants and data structures used by both the consumer and the producer
Metric Definition Registry - Resolving metric and control names to metric/control definitions
Scheduler Functions - Support for delayed or periodic execution of functions
Shared Memory Management -
Misc. Functions - Utility functions that do not really fit anywhere else
IV. Consumer API
Consumer API - Consumer library
Concentrator API - Functions for handling several channels or subscribed metrics together
V. Producer API
Producer Module API - Functions and definitions available to loadable modules
Producer API - Producer library control functions
Access Control Checking - Parse ACL definitions and perform access control checks
Actuators - Actuator support functions
Command Processing - Handling of commands received from consumers
Connections - Management of network connections
Producer API Core Functions - Common functions for different producer components
Filters - Filtering which metric values should be really sent
Module Support - Support for producer-side protocol modules
Asynchronous registry interface -
Common RPC Functions - Generic RPC functions used by various producer components
Sensors - Sensor support functions
Task Management -
Users - Managing connected users
VI. External Process Support
External Sensor Connector Interface - API for external processes to connect to RPC services inside a producer daemon
VII. Application-Embedded Sensor Support
Application Monitoring - Application monitoring and instrumentation support