HALOG(1M)

NAME

halog - add messages to the engine log

SYNOPSIS

halog -addtags tag1 [tag2 tag3 ...] [-sys system]

halog -deltags tag1 [tag2 tag3 ...] [-sys system]

halog -add "quoted_string" -sev C|E|W|N|I [-sys system] [-msgid message-number [-encoding encoding] [-parameters parameter1 parameter2 ...]]

halog -add "quoted_string" -dbg 1-21 [-sys system] [-msgid message-number [-encoding encoding] [-parameters parameter1 parameter2 ...]]

halog -cache [number_of_messages_<=_1024]

halog -info

halog -help

AVAILABILITY

VRTSvcs

DESCRIPTION

The halog command adds messages to the engine log. The halog command is also used internally to log messages from agent entry points written in Perl or Shell script. Starting with VCS 4.0, it is no longer necessary to directly call halog to log messages from script-based entry points. It is recommended to use the wrapper functions VCSAG_SET_ENVS, VCSAG_LOG_MSG, and VCSAG_LOGDBG_MSG to call the halog command. The logging functions for script-based entry points are described in the Cluster Server Agent Developer’s Guide.

OPTIONS

-addtags tag1 [tag2 tag3 ...] [-sys system]
  Enable a debug tag. If the system is supplied, this tag is enabled only on that system. See Example 2.
-deltags tag1 [tag2 tag3 ...] [-sys system]
  Delete a debug tag that was previously enabled. See Example 3.
-add "quoted_string" -sev C|E|W|N|I [-sys system] [-msgid message-number
  [-encoding encoding] [-parameters parameter1 parameter2 ...]]
Add a message from the command line to the log file. See examples 6, 7, and 9. -msgid is the message number. The severity values C, E, W, N, and I have the following significance:
- C Critical
- E Error
- W Warning
- N Notice
- I Information
Maximum size of quoted_string is 4096 bytes; strings longer than 4096 bytes are truncated. Combined size of all arguments parameter1 parameter2 ... must not exceed 4096 bytes. If total exceeds 4096 bytes, then each argument is allowed an equal portion of 4096 bytes and truncated if it exceeds the allowed portion.
-add "quoted_string" -dbg 1-21 [-sys system] [-msgid
  message-number [-encoding encoding] [-parameters parameter1 parameter2> ...]]
Add a debug message from the command line to the log file. See Example 8. Before adding a debug message, you must enable the debug tag.
-cache [number_of_messages_<=_1024]
  Display the most recent messages sent to the log. The maximum is 1024. See Examples 4 and 5.
-info Display the maximum size of the log file and the enabled global and local tags. See Examples 1 and 2.
-help Display usage for halog command.

EXAMPLES

Example 1:

     # halog -info
     Log on mars17:
                                        path = /var/VRTSvcs/log/engine_A.log
     maxsize = 67108864 bytes
     tags =
     flushtags =

Example 2:

     # halog -addtags DBG_TRACE
     # halog -info
     Log on mars17:
                                        path = /var/VRTSvcs/log/engine_A.log
     maxsize = 67108864 bytes
     tags = DBG_TRACE
     flushtags = DBG_TRACE

Example 3:

     # halog -deltags DBG_TRACE
     # halog -info
     Log on mars17:
                                        path = /var/VRTSvcs/log/engine_A.log
     maxsize = 67108864 bytes
     tags =
     flushtags =

Example 4:

     # halog -cache
     Log Cache on mars17:

     VCS NOTICE V-16-1-10114 Opening GAB library
     VCS NOTICE V-16-1-10619 \(oqHAD\(cq starting on: mars17
     VCS INFO V-16-1-10125 GAB timeout set to 15000 ms
     VCS INFO V-16-1-10077 Received new cluster membership
     VCS NOTICE V-16-1-10080 System 
        (mars17) - Membership: 0x1, Jeopardy: 0x2
     .
     .

Example 5:

     # halog -cache 2
     Log Cache on mars17:

     VCS NOTICE V-16-1-10114 Opening GAB library
     VCS NOTICE V-16-1-10619 \(oqHAD\(cq starting on: mars17

Example 6:

     # halog -add "This is an application message" -sev N

         # halog -cache 1
         Log Cache on mars17:
         VCS NOTICE V-16-1-0 (mars17) This is an application message

Example 7:

      # halog -add "This is an application message" -sev N -sys mars17

Example 8:

      # halog -add "This is a debug message" -dbg 2 -sys mars17

Example 9:

      # halog -add "This is an application message for group1" \
     -sev N -sys mars17 -msgid 11057 -parameters group1

SEE ALSO

hamsg(1M)

COPYRIGHTS

Copyright (c) 2016 Veritas.

All rights reserved.


VCS 7.1 HALOG(1M)