opensolaris man page for scds_syslog_debug

scds_syslog_debug(3HA)					 Sun Cluster HA and Data Services				    scds_syslog_debug(3HA)

NAME
       scds_syslog_debug - write a debugging message to the system log

SYNOPSIS
       cc [flags...] -I /usr/cluster/include file -L /usr/cluster/lib  -l  dsdev
       #include <rgm/libdsdev.h>

       void  scds_syslog_debug(int debug_level, constchar *format...

DESCRIPTION
       The  scds_syslog_debug() function writes a debugging message to the system log. It uses the facility returned by the scha_cluster_getlogfa-
       cility(3HA) function.

       All syslog messages are prefixed with: SC[<resourceTypeName>,<resourceGroupName>,<resourceName>,<methodName>

       If you specify a debug_level greater than the current debugging level being used, no information is written.

       The DSDL defines the maximum debugging level, SCDS_MAX_DEBUG_LEVEL, as 9. The scds_initialize(3HA) function, which the calling program must
       call before scds_syslog_debug(), retrieves the current debugging level from the file: /var/cluster/rgm/rt/<resourceTypeName>/loglevel.

       Caution -

	 Messages written to the system log are not internationalized.	Do not use gettext() or other message translation functions in conjunction
	 with this function.

PARAMETERS
       The following parameters are supported:

       debug_level	   Debugging level at which this message is to be written. Valid debugging levels are between 1 and  SCDS_MAX_DEBUG_LEVEL,
			   which  is  defined  as  9  by the DSDL. If the specified debugging level is greater than the debugging level set by the
			   calling program, the message is not written to the system log.

       format		   Message format string, as specified by printf(3C)

       ...		   Variables, indicated by the format parameter, as specified by printf(3C)

EXAMPLES
       Example 1 Display All Debugging Messages

       To see all debugging messages for resource type SUNW.iws, issue the following command on all nodes of your cluster

	 echo 9 > /var/cluster/rgm/rt/SUNW.iws/loglevel

       Example 2 Suppress Debugging Messages

       To suppress debugging messages for resource type SUNW.iws, issue the following command on all nodes of your cluster

	 echo 0 > /var/cluster/rgm/rt/SUNW.iws/loglevel

FILES
       /usr/cluster/include/rgm/libdsdev.h

	   Include file

       /usr/cluster/lib/libdsdev.so

	   Library

ATTRIBUTES
       See attributes(5) for descriptions of the following attributes:

       +-----------------------------+-----------------------------+
       |      ATTRIBUTE TYPE	     |	    ATTRIBUTE VALUE	   |
       +-----------------------------+-----------------------------+
       |Availability		     |SUNWscdev 		   |
       +-----------------------------+-----------------------------+
       |Interface Stability	     |Evolving			   |
       +-----------------------------+-----------------------------+

SEE ALSO
       printf(3C), scds_syslog(3HA), scha_cluster_getlogfacility(3HA), syslog(3C), syslog.conf(4), attributes(5)

Sun Cluster 3.2 						    7 Sep 2007						    scds_syslog_debug(3HA)