Go to main content

Oracle® Solaris Cluster Data Services Developer's Guide

Exit Print View

Updated: September 2015
 
 

Monitoring a Resource

Typically, you implement monitors to run periodic fault probes on resources to detect whether the probed resources are working correctly. If a fault probe fails, the monitor can attempt to restart locally or request failover of the affected resource group. The monitor requests the failover by calling the scha_control() or scha_control_zone() RMAPI function or the scds_fm_action() DSDL function.

You can also monitor the performance of a resource and tune or report performance. Writing a resource type-specific fault monitor is optional. Even if you choose not to write such a fault monitor, the resource type benefits from the basic monitoring of the cluster that Oracle Solaris Cluster software itself does. Oracle Solaris Cluster software detects failures of the host hardware, gross failures of the host's operating system, and failures of a host to be able to communicate on its public networks.

The RGM provides callbacks for automatically starting and stopping resource monitors. When bringing a resource offline, the RGM calls the Monitor_stop method to stop the resource's monitor on the local nodes before stopping the resource itself. When bringing a resource online, the RGM calls the Monitor_start method after the resource itself has been started.

The scha_control() or scha_control_zone() RMAPI function and the scds_fm_action() DSDL function (which calls scha_control()) enable resource monitors to request the failover of a resource group to a different node. As one of its sanity checks, scha_control() and scha_control_zone() call Monitor_check (if defined) to determine whether the requested node is reliable enough to master the resource group that contains the resource. If Monitor_check reports back that the node is not reliable, or the method times out, the RGM looks for a different node to honor the failover request. If Monitor_check fails on all nodes, the failover is canceled.

The resource monitor can set the Status and Status_msg properties to reflect the monitor's view of the resource state. Use the scha_resource_setstatus() or scha_resource_setstatus_zone() RMAPI function, the scha_resource_setstatus command, or the scds_fm_action() DSDL function to set these properties.


Note - Although the Status and Status_msg properties are of particular use to a resource monitor, any program can set these properties.

See Defining a Fault Monitor for an example of a fault monitor that is implemented with the RMAPI. See ORCL.xfnts Fault Monitor for an example of a fault monitor that is implemented with the DSDL. See the Oracle Solaris Cluster 4.3 Data Services Planning and Administration Guide for information about fault monitors that are built into data services that are supplied by Oracle.

Implementing Monitors and Methods That Execute Exclusively in the Global Zone

Most resource types execute their methods in whatever node appears in the resource group's node list. A few resource types must execute all of their methods in the global zone, even when the resource group is configured in a zone-cluster node. This is necessary for resource types that manage system resources, such as network addresses or disks, which can only be managed from the global zone. These resource types are identified by setting the Global_zone property to TRUE in the resource type registration (RTR) file.


Caution

Caution  - Do not register a resource type for which the Global_zone property is set to TRUE unless the resource type comes from a known and trusted source. Resource types for which this property is set to TRUE circumvent zone isolation and present a risk.


A resource type that declares Global_zone=TRUE might also declare the Global_zone_override resource property. In this case, the value of the Global_zone_override property supersedes the value of the Global_zone property for that resource. The Global_zone_override property is described in more detail in Resource Properties and the r_properties(5) man page.

If the Global_zone resource type property is not set to TRUE, monitors and methods execute in whatever nodes are listed in the resource group's node list.

The scha_control() and scha_resource_setstatus() functions and the scha_control and scha_resource_setstatus commands operate implicitly on the node from which the function or command is run. If the Global_zone resource type property equals TRUE, these functions and commands need to be invoked differently when the resource is configured in a zone cluster.

When the resource is configured in a zone-cluster node, the value of the zonename operand is passed to the resource type method by the –Z option. If your method or monitor invokes one of these functions or commands without the correct handling, it incorrectly operates on the global zone. Your method or monitor should operate on the zone-cluster node in which the resource that is included in the resource group's node list is configured.

    To ensure that your method or monitor code handles these conditions correctly, check that it does the following:

  • Specifies the –Z zonename option in calls to the scha_control and scha_resource_setstatus commands. Use the same value for zonename that the RGM passes to the data service method with the –Z option.

  • Includes calls to the scha_control_zone() function rather than to the scha_control() function. Ensure that your call passes the zonename operand that was passed by the –Z option.

  • Includes calls to the scha_resource_setstatus_zone() function rather than to the scha_resource_setstatus() function. Ensure that your call passes the zonename operand that was passed by the –Z option.

The DSDL functions inherently handle the –Z zonename option.

You can use the DSDL function scds_get_zone_name() to query the name of the zone that is passed to the method in the –Z zonename command-line option. If no –Z zonename is passed, the scds_get_zone_name() function returns NULL.