Uploaded image for project: 'Qpid'
  1. Qpid
  2. QPID-5998

[Java Broker] HA operational logging messages should be consistent in use of tense and terse phrasing

    XMLWordPrintableJSON

    Details

    • Type: Bug
    • Status: Closed
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 0.30
    • Component/s: Broker-J
    • Labels:
      None

      Description

      HA operational logging needs to follow the existing operational logging format which is:

      [subject] [object] [message]
      
      • subject, is a principal of a user or entity performing operation or reporting the message
      • object, is an entity on which the operation is invoked or a source of a message
      • message, operational logging message

      Subjects

      For operations performed by operator an operator principal should be provided in a subject, for example

      [mng:admin(/127.0.0.1:49540)] 
      

      For operational log messages reported on a local node about remote node changes, a special Subject should be created identifying the local node in format

      [grp(/{0})vhn(/{1}))]
      
      • {0}, group name
      • {1}, node name

      For example

      [grp(/high_availability)vhn(/node1))] 
      

      where 'high_availability' is a group name and 'node1' is a node name

      Objects

      If operation is performed on a local node and it effects the local node, a local node object needs to be specified in format

      [grp(/{0})vhn(/{1})]
      
      • {0}, group name
      • {1}, node name

      If operation is performed/reported on a remote node or affects the entire group the group object should be provided in format

      [grp(/{0})]
      

      Messages

      Operational log for local node creation

      Subject: operator subject,  ex [mng:admin(/127.0.0.1:49540)]  
      Object: local node object, [grp(/{0})vhn(/{1})]
      Message: HA-1001 : Created
      

      Operational log for local node deletion

      Subject: operator subject,  ex [mng:admin(/127.0.0.1:49540)]  
      Object: local node object, [grp(/{0})vhn(/{1})]
      Message: HA-1002 : Deleted
      

      Operational log for a remote node added into a group for a first time

      Subject: local node subject,  [grp(/{0})vhn(/{1})]
      Object: group object, [grp(/{0}))]
      Message: HA-1003 : Added : Node : ''{0}'' ({1})
      
      • {0}, node name
      • {1}, node address

      Operational log for a remote node deleted from a group

      Subject: local node subject,  [grp(/{0})vhn(/{1})]
      Object: group object, [grp(/{0}))]
      Message: HA-1004 : Removed : Node : ''{0}'' ({1})
      
      • {0}, node name
      • {1}, node address

      Operational log for a remote node joining a group (attaching)

      Subject: local node subject,  [grp(/{0})vhn(/{1})]
      Object: group object, [grp(/{0}))]
      Message: HA-1005 : Joined : Node : ''{0}'' ({1})
      
      • {0}, node name
      • {1}, node address

      Operational log for a remote node leaving a group (detaching)

      Subject: local node subject,  [grp(/{0})vhn(/{1})]
      Object: group object, [grp(/{0}))]
      Message: HA-1006 : Left : Node : ''{0}'' ({1})
      
      • {0}, node name
      • {1}, node address

      Operational log for requesting a transfer master on a node

      Subject: operator subject,  ex [mng:admin(/127.0.0.1:49540)]  
      Object: group object, [grp(/\{0\})]
      Message: HA-1007 : Master transfer requested : to ''{0}'' ({1})
      
      • {0}, node name
      • {1}, node address

      Operational log for intruder node detected

      Subject: local node subject,  [grp(/{0})vhn(/{1})]
      Object: group object, [grp(/\{0\})]
      Message: HA-1008 : Intruder detected : Node ''{0}'' ({1})
      
      • {0}, node name
      • {1}, node address

      Operational log when master looses majority

      Subject: local node subject,  [grp(/{0})vhn(/{1})]
      Object: group object, [grp(/\{0\})]
      Message: HA-1009 : Insufficient replicas contactable
      

      Operational log for role being changed on local or remote node

      Subject: local node subject,  [grp(/{0})vhn(/{1})]
      Object: groupobject, [grp(/\{0\})]
      Message: HA-1010 : Role changed reported: Node ''{0}'' ({1}) from ''{2}'' to ''{3}''
      
      • {0}, node name
      • {1}, node address
      • {2}, previous role
      • {3}, new role

      Operational log for attribute change: quorumOverride

      Subject: operator subject,  ex [mng:admin(/127.0.0.1:49540)]  
      Object: local node object, [grp(/{0})vhn(/{1})]
      Message: HA-1011 : Minimum group  : {0}
      
      • {0}, new value

      Operational log for attribute change: priority

      Subject: operator subject,  ex [mng:admin(/127.0.0.1:49540)]  
      Object: local node object, [grp(/{0})vhn(/{1})]
      Message: HA-1012 : Priority  : {0}
      
      • {0}, new value

      Operational log for attribute change: designatedPrimary

      Subject: operator subject,  ex [mng:admin(/127.0.0.1:49540)]  
      Object: local node object, [grp(/{0})vhn(/{1})]
      Message: HA-1013 : Designated primary : {0}
      
      • {0}, new value

        Attachments

          Activity

            People

            • Assignee:
              kwall Keith Wall
              Reporter:
              orudyy Alex Rudyy
            • Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: