---

/root/resourcemonitord/resourcemonitord/MonitoringEventSchema.h

Go to the documentation of this file.

/***************************************************************************
                          MonitoringEventSchema.h  -  description
                             -------------------
    begin                : Wed Sep 19 2001
    copyright            : (C) 2001 by Todd C. Davis
    email                : todd.c.davis@intel.com
 ***************************************************************************/


/*M*
BSD License

Copyright (c) 2002, Intel Corporation
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

  a.. Redistributions of source code must retain the above copyright notice,
      this list of conditions and the following disclaimer.
  b.. Redistributions in binary form must reproduce the above copyright notice,
      this list of conditions and the following disclaimer in the documentation
      and/or other materials provided with the distribution.
  c.. Neither the name of Intel Corporation nor the names of its contributors
      may be used to endorse or promote products derived from this software
      without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

 *M*/

/*
 * MonitoringEventSchema.h
 *
 * This header file defines an event log entry convention for events
 * written to an event logging facility that are related to monitoring 
 * a statistic of a system resource.
 * 
 * This convention can be adopted by any software subsystem (application, 
 * driver, kernel module, etc.) that writes messages into a system event log
 * that are related to monitoring of statistics .  Any event message that 
 * conforms to the event schema must contain data identifying the message 
 * as compliant (See Monitoring Event Schema comments below).
 * 
 * Applications that wish to query or filter event log data for statistic
 * monitoring events can develop queries using this schema.  
 *
 */
#ifndef __MonitoringEventSchema_h__
#define __MonitoringEventSchema_h__


/*
 * Monitoring Event Schema
 *
 * Monitoring Events that comply with this schema must include a set of event 
 * attributes that are implemented in the message data.  For inclusion of
 * attributes and values in text string message data, the following format 
 * must be used:
 * 
 *  "<free form message>|attr=val|attr=val|...|attr=val|"
 *
 * There can be any number of attribute=value pairs and they can be 
 * specified in any order, with a separator character appearing before 
 * and after each attribute=value pair.   This means that the final 
 * attribute=value pair will also have a separator character following it.  
 * When two attribute=value pairs are adjacent, only one separator character 
 * is required; however, specifying two sequential separator characters 
 * is valid.  
 *
 * Examples:
 * The following are valid event messages:
 *
 *    "Text goes here|facility_id=GUID|Threshold_Value=12|”
 *    “Text goes here|facility_id=GUID||Observed_Value=55|"
 *
 * Applications building queries for specific attributes and values must 
 * include the separator char on both sides of the attribute=value pair 
 * in a query expression.   For example, for the first event message 
 * above, a query for the string "|Threshold_Value=1|" would fail,
 * a query for "|Threshold_Value=12|" would succeed.
 *
 * For subsystems that are fully-compliant with this event schema, each of 
 * the attributes noted "R" below will be included in the event message.

 *
 * For certain monitoring events, the attributes marked "O" (optional) may
 * be included.
 *
 * For subsystems that are not fully-compliant, a subset of these 
 * attributes may be included.  Please refer to documentation provided 
 * with the subsystem for the resource to determine what attributes are 
 * supported by that subsystem.
 *
 * In some cases, a universally-unique identifier (UUID) is used to ensure that the
 * component is identified in a manner that is reasonably guaranteed to be unique
 * across systems, versions or implementations.  A UUID is a 32 character string
 * that is subdivided into five components using dashes ("-").  With the addition
 * of a terminating null character, the resulting string is 37 characters long.
 *
 * 
 * The Monitoring Event Schema contains the following attributes:
 *
 * R facility_id=<ME_UIDstring> Monitoring Event Schema UUID            37byte char string
 *  R event_type=<integer>      An integer code identifying the type of     integer
 *                      resource/statistic monitoring message
 *  R severity=<integer>        An integer code identifying the severity of integer
 *                      the event
 *
 *  R Subsystem_ID=<UUID>       A UUID identifying the source of the event  37byte char string
 *  R Resource_ID=<integer>     An integer identifier of a resource;        integer
 *                      unique within the scope of a Subsystem_ID
 *  R Statistic_ID=<integer>        Identifier of a statistic; unique in Subsystem  integer
 *
 *  O Observed_Value=<integer>  Observed value of the statistic         integer
 *  O Threshold_Value=<integer>     Current value of threshold for statistic        integer
 *  O inlinemon_id=<char>       Identifier for subsystem-based monitor which    Up to 64byte char string
 *                      caused the event to be logged   
 *
 *  O Subsystem_Name=<char>     Human-readable name of subsystem            char string
 *  O Resource_Name=<char>      Human-readable name of resource         char string
 *  O Statistic_Name=<char>     Human-readable name of statistic            char string
 *  O inlinemon_name=<char>     Human-readable name of subsys-based monitor char string
 *  
 *  O Monitor_ID=<UUID>     Identifier for the application session      37byte char string
 *                      that is controlling the monitor/statistic
 *                      which caused the event to be logged;
 *                      This identifier is created by the application
 *                      and learned by the subsystem
 *  
 *
 *    (R=required, O=optional)
 */


#define ME_UID_STRING           "2f737514-1d1b-4edb-9cd4-adffc433d56e"


#define ME_EVENT_TYPE_BASE      500

#define ME_EVENT_CANCELED           (ME_EVENT_TYPE_BASE+0)

#define ME_EVENT_VALUE_ABOVE        (ME_EVENT_TYPE_BASE+1)

#define ME_EVENT_VALUE_AT_OR_ABOVE  (ME_EVENT_TYPE_BASE+2)

#define ME_EVENT_VALUE_AT           (ME_EVENT_TYPE_BASE+3)

#define ME_EVENT_VALUE_AT_OR_BELOW  (ME_EVENT_TYPE_BASE+4)

#define ME_EVENT_VALUE_BELOW        (ME_EVENT_TYPE_BASE+5)

#define ME_EVENT_VALUE_NOT_AT_BELOW (ME_EVENT_TYPE_BASE+6)

#define ME_EVENT_VALUE_NOT_AT_ABOVE (ME_EVENT_TYPE_BASE+7)

#define ME_EVENT_COUNTER_RATE_EXCEEDED  (ME_EVENT_TYPE_BASE+8)

#define ME_EVENT_SUBSYSTEM_CONFIGURATION_CHANGE (ME_EVENT_TYPE_BASE+9)

#define ME_EVENT_RESOURCE_CONFIGURATION_CHANGE  (ME_EVENT_TYPE_BASE+10)


#define ME_LOG_EMERG   0

#define ME_LOG_ALERT   1

#define ME_LOG_CRIT    2

#define ME_LOG_ERR     3

#define ME_LOG_WARNING 4

#define ME_LOG_NOTICE  5

#define ME_LOG_INFO    6

#define ME_LOG_DEBUG   7 


#define ME_ThresholdEventLogMessageFormat       "%s\
|facility_id=2f737514-1d1b-4edb-9cd4-adffc433d56e\
|Monitor_ID=%s|Subsystem_ID=%s\
|Resource_ID=%u|Statistic_ID=%u\
|Observed_Value=%u|Threshold_Value=%u|\n"

#define ME_ThresholdEventLogMessageFormatWithNames      "%s\
|facility_id=2f737514-1d1b-4edb-9cd4-adffc433d56e\
|Monitor_ID=%s|Subsystem_ID=%s|Subsystem_Name=%s\
|Resource_ID=%u|Resource_Name=%s|Statistic_ID=%u|Statistic_Name=%s\
|Observed_Value=%u|Threshold_Value=%u|\n"

#define ME_ThresholdEventLogMessageSignedFormat     "%s\
|facility_id=2f737514-1d1b-4edb-9cd4-adffc433d56e\
|Monitor_ID=%s|Subsystem_ID=%s\
|Resource_ID=%u|Statistic_ID=%u\
|Observed_Value=%u|Threshold_Value=%u|\n"

#define ME_ThresholdEventLogMessageSignedFormatWithNames        "%s\
|facility_id=2f737514-1d1b-4edb-9cd4-adffc433d56e\
|Monitor_ID=%s|Subsystem_ID=%s|Subsystem_Name=%s\
|Resource_ID=%u|Resource_Name=%s|Statistic_ID=%u|Statistic_Name=%s\
|Observed_Value=%d|Threshold_Value=%d|\n"

#define ME_ThresholdEventLogMessageFormat64     "%s\
|facility_id=2f737514-1d1b-4edb-9cd4-adffc433d56e\
|Monitor_ID=%s|Subsystem_ID=%s\
|Resource_ID=%u|Statistic_ID=%u\
|Observed_Value=%llu|Threshold_Value=%llu|\n"

#define ME_ThresholdEventLogMessageFormat64WithNames        "%s\
|facility_id=2f737514-1d1b-4edb-9cd4-adffc433d56e\
|Monitor_ID=%s|Subsystem_ID=%s|Subsystem_Name=%s\
|Resource_ID=%u|Resource_Name=%s|Statistic_ID=%u|Statistic_Name=%s\
|Observed_Value=%llu|Threshold_Value=%llu|\n"

#define ME_ThresholdEventLogMessageSignedFormat64       "%s\
|facility_id=2f737514-1d1b-4edb-9cd4-adffc433d56e\
|Monitor_ID=%s|Subsystem_ID=%s\
|Resource_ID=%u|Statistic_ID=%u\
|Observed_Value=%lld|Threshold_Value=%lld|\n"

#define ME_ThresholdEventLogMessageSignedFormat64WithNames      "%s\
|facility_id=2f737514-1d1b-4edb-9cd4-adffc433d56e\
|Monitor_ID=%s|Subsystem_ID=%s|Subsystem_Name=%s\
|Resource_ID=%u|Resource_Name=%s|Statistic_ID=%u|Statistic_Name=%s\
|Observed_Value=%lld|Threshold_Value=%lld|\n"

#define ME_LeakyBuckeEventLogMessageFormat      "%s\
|facility_id=2f737514-1d1b-4edb-9cd4-adffc433d56e\
|Monitor_ID=%s|Subsystem_ID=%s\
|Resource_ID=%u|Statistic_ID=%u\
|Bucket_Size=%u|Fill_Value=%u|Fill_Interval=%u seconds\
|Bucket_Level(%u) <= Observed_Value(%u) - Last_Value(%u)|\n"

#define ME_LeakyBucketEventLogMessageFormatWithNames        "%s\
|facility_id=2f737514-1d1b-4edb-9cd4-adffc433d56e\
|Monitor_ID=%s|Subsystem_ID=%s|Subsystem_Name=%s\
|Resource_ID=%u|Resource_Name=%s|Statistic_ID=%u|Statistic_Name=%s\
|Bucket_Size=%u|Fill_Value=%u|Fill_Interval=%u seconds\
|Bucket_Level(%u) <= Observed_Value(%u) - Last_Value(%u)|\n"

#define ME_LeakyBuckeEventLogMessageSignedFormat        "%s\
|facility_id=2f737514-1d1b-4edb-9cd4-adffc433d56e\
|Monitor_ID=%s|Subsystem_ID=%s\
|Resource_ID=%u|Statistic_ID=%u\
|Bucket_Size=%u|Fill_Value=%u|Fill_Interval=%u seconds\
|Bucket_Level(%u) <= Observed_Value(%u) - Last_Value(%u)|\n"

#define ME_LeakyBucketEventLogMessageSignedFormatWithNames      "%s\
|facility_id=2f737514-1d1b-4edb-9cd4-adffc433d56e\
|Monitor_ID=%s|Subsystem_ID=%s|Subsystem_Name=%s\
|Resource_ID=%u|Resource_Name=%s|Statistic_ID=%u|Statistic_Name=%s\
|Bucket_Size=%d|Fill_Value=%d|Fill_Interval=%u seconds\
|Bucket_Level(%d) <= Observed_Value(%d) - Last_Value(%d)|\n"

#define ME_LeakyBucketEventLogMessageFormat64       "%s\
|facility_id=2f737514-1d1b-4edb-9cd4-adffc433d56e\
|Monitor_ID=%s|Subsystem_ID=%s\
|Resource_ID=%u|Statistic_ID=%u\
|Bucket_Size=%llu|Fill_Value=%llu|Fill_Interval=%u seconds\
|Bucket_Level(%llu) <= Observed_Value(%llu) - Last_Value(%llu)|\n"

#define ME_LeakyBucketEventLogMessageFormat64WithNames      "%s\
|facility_id=2f737514-1d1b-4edb-9cd4-adffc433d56e\
|Monitor_ID=%s|Subsystem_ID=%s|Subsystem_Name=%s\
|Resource_ID=%u|Resource_Name=%s|Statistic_ID=%u|Statistic_Name=%s\
|Bucket_Size=%llu|Fill_Value=%llu|Fill_Interval=%u seconds\
|Bucket_Level(%llu) <= Observed_Value(%llu) - Last_Value(%llu)|\n"

#define ME_LeakyBucketEventLogMessageSignedFormat64     "%s\
|facility_id=2f737514-1d1b-4edb-9cd4-adffc433d56e\
|Monitor_ID=%s|Subsystem_ID=%s\
|Resource_ID=%u|Statistic_ID=%u\
|Bucket_Size=%lld|Fill_Value=%lld|Fill_Interval=%u seconds\
|Bucket_Level(%lld) <= Observed_Value(%lld) - Last_Value(%lld)|\n"

#define ME_LeakyBucketEventLogMessageSignedFormat64WithNames        "%s\
|facility_id=2f737514-1d1b-4edb-9cd4-adffc433d56e\
|Monitor_ID=%s|Subsystem_ID=%s|Subsystem_Name=%s\
|Resource_ID=%u|Resource_Name=%s|Statistic_ID=%u|Statistic_Name=%s\
|Bucket_Size=%lld|Fill_Value=%lld|Fill_Interval=%u seconds\
|Bucket_Level(%lld) <= Observed_Value(%lld) - Last_Value(%lld)|\n"

#define ME_ResourceChangeEventLogMessageFormat      "%s\
|facility_id=2f737514-1d1b-4edb-9cd4-adffc433d56e\
|Subsystem_ID=%s|Resource_ID=%u\n"

#define ME_ResourceChangeLogMessageFormatWithNames      "%s\
|facility_id=2f737514-1d1b-4edb-9cd4-adffc433d56e\
|Subsystem_ID=%s|Subsystem_Name=%s\
|Resource_ID=%u|Resource_Name=%s\n"

#define ME_RM_CancelEvent   "Cancel threshold exception"
#define ME_RM_ThresholdEvent    "Threshold exception"
#define ME_RM_LeakyBucketEvent  "Leaky Bucket exception"
#define ME_RM_SubsystemAdded    "Subsystem Added"
#define ME_RM_ResourceAdded "Resource Added"
#define ME_RM_DataCaptureAdded  "Data Capture Library Added"
#define ME_RM_SubsystemRemoved  "Subsystem Removed"
#define ME_RM_ResourceRemoved   "Resource Removed"
#define ME_RM_DataCaptureRemoved    "Data Capture Library Removed"

#define PL_ME_Facility  LOG_LOCAL5

/*
 * When the POSIX log header is included,
 * map the ME severity codes onto the POSIX-compliant range
 * (Using assumption that if LOG_KERN is defined, the POSIX header has been included)
 */
#ifdef LOG_KERN
#define ME_LOG_EMERG   LOG_EMERG   /* system is unusable */
#define ME_LOG_ALERT   LOG_ALERT   /* action must be taken immediately*/
#define ME_LOG_CRIT    LOG_CRIT    /* critical conditions */
#define ME_LOG_ERR     LOG_ERR     /* error conditions */
#define ME_LOG_WARNING LOG_WARNING /* warning conditions */
#define ME_LOG_NOTICE  LOG_NOTICE  /* normal but significant condition*/
#define ME_LOG_INFO    LOG_INFO    /* informational */
#define ME_LOG_DEBUG   LOG_DEBUG   /* debug-level messages */
#endif

/*
 * Tentative additions for CSM/CSL events
 * to be replaced by "official" include file
 */
#define CSM_UID_STRING          "c581b242-600e-4444-8378-584e7a251f0c"

/*
 * Resource Management Event Type codes
 */
#define RMGT_EVENT_TYPE_BASE        12500
#define RMGT_SubsystemAdded (RMGT_EVENT_TYPE_BASE+0)
#define RMGT_ResourceAdded  (RMGT_EVENT_TYPE_BASE+1)
#define RMGT_SubsystemRemoved       (RMGT_EVENT_TYPE_BASE+2)
#define RMGT_ResourceRemoved    (RMGT_EVENT_TYPE_BASE+3)

/*
 * These data strings should match the Resource Management Event Type code
 * used in the event log record
 */
#define CSM_SubsystemAdded  "New Subsystem Registered"
#define CSM_ResourceAdded   "New Resource Registered"
#define CSM_SubsystemRemoved    "Subsystem Removed"
#define CSM_ResourceRemoved "Resource Removed"

#define CSM_SubsystemChangeEventLogMessageFormat        "%s\
|facility_id=2f737514-1d1b-4edb-9cd4-adffc433d56e\
|Subsystem_ID=%s\
|Management_Module_ID=c581b242-600e-4444-8378-584e7a251f0c\n"

#define CSM_SubsystemChangeLogMessageFormatWithNames        "%s\
|facility_id=2f737514-1d1b-4edb-9cd4-adffc433d56e\
|Subsystem_ID=%s|Subsystem_Name=%s\
|Management_Module_ID=c581b242-600e-4444-8378-584e7a251f0c\
|Management_Module_Name=Common Statistics Management Module\n"

#define CSM_ResourceChangeEventLogMessageFormat     "%s\
|facility_id=2f737514-1d1b-4edb-9cd4-adffc433d56e\
|Subsystem_ID=%s|Resource_ID=%s\
|Management_Module_ID=c581b242-600e-4444-8378-584e7a251f0c\n"

#define CSM_ResourceChangeLogMessageFormatWithNames     "%s\
|facility_id=2f737514-1d1b-4edb-9cd4-adffc433d56e\
|Subsystem_ID=%s|Subsystem_Name=%s\
|Resource_ID=%s\
|Management_Module_ID=c581b242-600e-4444-8378-584e7a251f0c\
|Management_Module_Name=Common Statistics Management Module\n"


#endif  //  __MonitoringEventSchema_h__

---