-#ifndef EVEL_INCLUDED
-#define EVEL_INCLUDED
/*************************************************************************//**
*
* Copyright © 2017 AT&T Intellectual Property. All rights reserved.
* be one of ::EVEL_ERR_CODES.
*****************************************************************************/
+#ifndef EVEL_INCLUDED
+#define EVEL_INCLUDED
+
#ifdef __cplusplus
extern "C" {
#endif
/* Maximum string lengths. */
/*****************************************************************************/
#define EVEL_MAX_STRING_LEN 4096
-#define EVEL_MAX_JSON_BODY 16000
+#define EVEL_MAX_JSON_BODY 160000
#define EVEL_MAX_ERROR_STRING_LEN 255
#define EVEL_MAX_URL_LEN 511
*****************************************************************************/
typedef enum {
EVEL_DOMAIN_INTERNAL, /** Internal event, not for external routing. */
+ EVEL_DOMAIN_BATCH, /** Batch event, composite event. */
EVEL_DOMAIN_HEARTBEAT, /** A Heartbeat event (event header only). */
EVEL_DOMAIN_FAULT, /** A Fault event. */
EVEL_DOMAIN_MEASUREMENT, /** A Measurement for VF Scaling event. */
/*****************************************************************************/
/* Supported Common Event Header version. */
/*****************************************************************************/
-#define EVEL_HEADER_MAJOR_VERSION 1
-#define EVEL_HEADER_MINOR_VERSION 2
+#define EVEL_HEADER_MAJOR_VERSION 3
+#define EVEL_HEADER_MINOR_VERSION 0
+#define EVEL_BATCH_MAJOR_VERSION 1
+#define EVEL_BATCH_MINOR_VERSION 0
/**************************************************************************//**
* Event header.
* JSON equivalent field: commonEventHeader
EVEL_OPTION_INTHEADER_FIELDS internal_field;
EVEL_OPTION_STRING nfcnaming_code;
EVEL_OPTION_STRING nfnaming_code;
+ DLIST batch_events;
} EVENT_HEADER;
+/**************************************************************************//**
+ * Initialize a newly created event header.
+ *
+ * @param header Pointer to the header being initialized.
+ * @param eventname Eventname string
+ * @param eventid Event id : unique id for classification and analysis
+ * @param header Pointer to the header being initialized.
+ *****************************************************************************/
+void evel_init_header_nameid(EVENT_HEADER * const header,const char *const eventname, const char *eventid);
+
+/**************************************************************************//**
+ * Create a new Batch event.
+ *
+ * @note The mandatory fields on the Batch must be supplied to this factory
+ * function and are immutable once set. Optional fields have explicit
+ * setter functions, but again values may only be set once so that the
+ * Batch has immutable properties. At this time evename and eventid
+ * for batch events are set but not used in json encoding
+ * @returns pointer to the newly manufactured ::EVENT_HEADER. If the event is
+ * not used (i.e. posted) it must be released using ::evel_free_batch.
+ * @retval NULL Failed to create the event.
+ *****************************************************************************/
+EVENT_HEADER * evel_new_batch(const char* ev_name, const char *ev_id);
+
+
+/**************************************************************************//**
+ * Add an Event into Batch Event
+ *
+ * The name and value are null delimited ASCII strings. The library takes
+ * a copy so the caller does not have to preserve values after the function
+ * returns.
+ *
+ * @param other Pointer to the Batch Event.
+ * @param jsonobj Pointer to additional Event
+ *****************************************************************************/
+void evel_batch_add_event(EVENT_HEADER * batchev, EVENT_HEADER *child);
+
+/**************************************************************************//**
+ * Free an Batch.
+ *
+ * Free off the Batch supplied. Will free all the contained allocated memory.
+ *
+ * @note It does not free the Batch itself, since that may be part of a
+ * larger structure.
+ *****************************************************************************/
+void evel_free_batch(EVENT_HEADER * event);
+
/*****************************************************************************/
/* Supported Fault version. */
/*****************************************************************************/
typedef struct measurement_fsys_use {
char * filesystem_name;
double block_configured;
- int block_iops;
+ double block_iops;
double block_used;
double ephemeral_configured;
- int ephemeral_iops;
+ double ephemeral_iops;
double ephemeral_used;
} MEASUREMENT_FSYS_USE;
/*****************************************************************************/
/* Supported Mobile Flow version. */
/*****************************************************************************/
-#define EVEL_MOBILE_FLOW_MAJOR_VERSION 1
-#define EVEL_MOBILE_FLOW_MINOR_VERSION 2
+#define EVEL_MOBILE_FLOW_MAJOR_VERSION 2
+#define EVEL_MOBILE_FLOW_MINOR_VERSION 0
/**************************************************************************//**
* Mobile Flow.
/*****************************************************************************/
/* Supported Signaling version. */
/*****************************************************************************/
-#define EVEL_SIGNALING_MAJOR_VERSION 2
-#define EVEL_SIGNALING_MINOR_VERSION 1
+#define EVEL_SIGNALING_MAJOR_VERSION 1
+#define EVEL_SIGNALING_MINOR_VERSION 0
/**************************************************************************//**
* Vendor VNF Name fields.
/*****************************************************************************/
/* Supported Syslog version. */
/*****************************************************************************/
-#define EVEL_SYSLOG_MAJOR_VERSION 1
-#define EVEL_SYSLOG_MINOR_VERSION 2
+#define EVEL_SYSLOG_MAJOR_VERSION 3
+#define EVEL_SYSLOG_MINOR_VERSION 0
/**************************************************************************//**
* Syslog.
* Encode the event as a JSON event object according to AT&T's schema.
*
* @param json Pointer to where to store the JSON encoded data.
+ * @param mode Event mode or Batch mode
* @param max_size Size of storage available in json_body.
* @param event Pointer to the ::EVENT_HEADER to encode.
* @returns Number of bytes actually written.
int evel_json_encode_event(char * json,
int max_size,
EVENT_HEADER * event);
-
+int evel_json_encode_batch_event(char * json,
+ int max_size,
+ EVENT_HEADER * event);
/**************************************************************************//**
* Initialize an event instance id.
*
*****************************************************************************/
EVENT_HEADER * evel_new_heartbeat(void);
+/**************************************************************************//**
+ * Create a new heartbeat event of given name and type.
+ *
+ * @note that the heartbeat is just a "naked" commonEventHeader!
+ *
+ * @param event_name Unique Event Name: {DomainAbbreviation}_{AsdcModel or ApplicationPlatform}_{DescriptionOfInfoBeingConveyed}
+ * @param event_id A universal identifier of the event for: troubleshooting, cross-referencing of alarms for alarm correlation, offline log analysis, etc
+ *
+ * @returns pointer to the newly manufactured ::EVENT_HEADER. If the event is
+ * not used it must be released using ::evel_free_event
+ * @retval NULL Failed to create the event.
+ *****************************************************************************/
+EVENT_HEADER * evel_new_heartbeat_nameid(const char* ev_name, const char *ev_id);
+
+
/**************************************************************************//**
* Free an event header.
*
void evel_reporting_entity_id_set(EVENT_HEADER * const header,
const char * const entity_id);
+/**************************************************************************//**
+ * Set the NFC Naming code property of the event header.
+ *
+ * @param header Pointer to the ::EVENT_HEADER.
+ * @param nfcnamingcode String
+ *****************************************************************************/
+void evel_nfcnamingcode_set(EVENT_HEADER * const header,
+ const char * const nfcnam);
+/**************************************************************************//**
+ * Set the NF Naming code property of the event header.
+ *
+ * @param header Pointer to the ::EVENT_HEADER.
+ * @param nfnamingcode String
+ *****************************************************************************/
+void evel_nfnamingcode_set(EVENT_HEADER * const header,
+ const char * const nfnam);
+
/*****************************************************************************/
/*****************************************************************************/
/* */
* function and are immutable once set. Optional fields have explicit
* setter functions, but again values may only be set once so that the
* Fault has immutable properties.
+ * @param event_name Unique Event Name
+ * @param event_id A universal identifier of the event for analysis etc
* @param condition The condition indicated by the Fault.
* @param specific_problem The specific problem triggering the fault.
* @param priority The priority of the event.
* not used (i.e. posted) it must be released using ::evel_free_fault.
* @retval NULL Failed to create the event.
*****************************************************************************/
-EVENT_FAULT * evel_new_fault(const char * const condition,
+EVENT_FAULT * evel_new_fault(const char* ev_name, const char *ev_id,
+ const char * const condition,
const char * const specific_problem,
EVEL_EVENT_PRIORITIES priority,
EVEL_SEVERITIES severity,
* that the Measurement has immutable properties.
*
* @param measurement_interval
+ * @param event_name Unique Event Name
+ * @param event_id A universal identifier of the event for analysis etc
*
* @returns pointer to the newly manufactured ::EVENT_MEASUREMENT. If the
* event is not used (i.e. posted) it must be released using
* ::evel_free_event.
* @retval NULL Failed to create the event.
*****************************************************************************/
-EVENT_MEASUREMENT * evel_new_measurement(double measurement_interval);
+EVENT_MEASUREMENT * evel_new_measurement(double measurement_interval,const char* ev_name, const char *ev_id);
/**************************************************************************//**
* Free a Measurement.
char * filesystem_name,
double block_configured,
double block_used,
- int block_iops,
+ double block_iops,
double ephemeral_configured,
double ephemeral_used,
- int ephemeral_iops);
+ double ephemeral_iops);
/**************************************************************************//**
* Add a Feature usage value name/value pair to the Measurement.
* that the Report has immutable properties.
*
* @param measurement_interval
+ * @param event_name Unique Event Name
+ * @param event_id A universal identifier of the event for analysis etc
*
* @returns pointer to the newly manufactured ::EVENT_REPORT. If the event is
* not used (i.e. posted) it must be released using
* ::evel_free_report.
* @retval NULL Failed to create the event.
*****************************************************************************/
-EVENT_REPORT * evel_new_report(double measurement_interval);
+EVENT_REPORT * evel_new_report(double measurement_interval,const char* ev_name, const char *ev_id);
/**************************************************************************//**
* Free a Report.
* explicit setter functions, but again values may only be set once so
* that the Mobile Flow has immutable properties.
*
+ * @param event_name Unique Event Name
+ * @param event_id A universal identifier of the event for analysis etc
* @param flow_direction
* @param gtp_per_flow_metrics
* @param ip_protocol_type
* @retval NULL Failed to create the event.
*****************************************************************************/
EVENT_MOBILE_FLOW * evel_new_mobile_flow(
+ const char* ev_name, const char *ev_id,
const char * const flow_direction,
MOBILE_GTP_PER_FLOW_METRICS * gtp_per_flow_metrics,
const char * const ip_protocol_type,
* this factory function and are immutable once set. Optional fields
* have explicit setter functions, but again values may only be set
* once so that the event has immutable properties.
+ * @param event_name Unique Event Name
+ * @param event_id A universal identifier of the event for analysis etc
* @param vendor_name The vendor id to encode in the event vnf field.
* @param module The module to encode in the event.
* @param vnfname The Virtual network function to encode in the event.
* ::evel_free_signaling.
* @retval NULL Failed to create the event.
*****************************************************************************/
-EVENT_SIGNALING * evel_new_signaling(const char * const vendor_name,
+EVENT_SIGNALING * evel_new_signaling(const char* ev_name, const char *ev_id,
+ const char * const vendor_name,
const char * const correlator,
const char * const local_ip_address,
const char * const local_port,
* setter functions, but again values may only be set once so that the
* Syslog has immutable properties.
*
+ * @param event_name Unique Event Name
+ * @param event_id A universal identifier of the event for analysis etc
* @param new_state The new state of the reporting entity.
* @param old_state The old state of the reporting entity.
* @param interface The card or port name of the reporting entity.
* ::evel_free_state_change
* @retval NULL Failed to create the event.
*****************************************************************************/
-EVENT_STATE_CHANGE * evel_new_state_change(const EVEL_ENTITY_STATE new_state,
+EVENT_STATE_CHANGE * evel_new_state_change(const char* ev_name, const char *ev_id,
+ const EVEL_ENTITY_STATE new_state,
const EVEL_ENTITY_STATE old_state,
const char * const interface);
* setter functions, but again values may only be set once so that the
* Syslog has immutable properties.
*
+ * @param event_name Unique Event Name
+ * @param event_id A universal identifier of the event for analysis etc
* @param event_source_type
* @param syslog_msg
* @param syslog_tag
* not used it must be released using ::evel_free_syslog
* @retval NULL Failed to create the event.
*****************************************************************************/
-EVENT_SYSLOG * evel_new_syslog(EVEL_SOURCE_TYPES event_source_type,
+EVENT_SYSLOG * evel_new_syslog(const char* ev_name, const char *ev_id,
+ EVEL_SOURCE_TYPES event_source_type,
const char * const syslog_msg,
const char * const syslog_tag);
/**************************************************************************//**
* Create a new other event.
*
+ * @param event_name Unique Event Name
+ * @param event_id A universal identifier of the event for analysis etc
*
* @returns pointer to the newly manufactured ::EVENT_OTHER. If the event is
* not used it must be released using ::evel_free_other.
* @retval NULL Failed to create the event.
*****************************************************************************/
-EVENT_OTHER * evel_new_other(void);
+EVENT_OTHER * evel_new_other(const char* ev_name, const char *ev_id);
/**************************************************************************//**
* Free an Other.
* factory function and are immutable once set. Optional fields have
* explicit setter functions, but again values may only be set once
* so that the Voice Quality has immutable properties.
+ * @param event_name Unique Event Name
+ * @param event_id A universal identifier of the event for analysis etc
* @param calleeSideCodec Callee codec for the call.
* @param callerSideCodec Caller codec for the call.
* @param correlator Constant across all events on this call.
::evel_free_voice_quality.
* @retval NULL Failed to create the event.
*****************************************************************************/
-EVENT_VOICE_QUALITY * evel_new_voice_quality(const char * const calleeSideCodec,
+EVENT_VOICE_QUALITY * evel_new_voice_quality(const char* ev_name, const char *ev_id,
+ const char * const calleeSideCodec,
const char * const callerSideCodec, const char * const correlator,
const char * const midCallRtcp, const char * const vendorVnfNameFields);
/*****************************************************************************/
/* Supported Threshold Crossing version. */
/*****************************************************************************/
-#define EVEL_THRESHOLD_CROSS_MAJOR_VERSION 1
-#define EVEL_THRESHOLD_CROSS_MINOR_VERSION 1
+#define EVEL_THRESHOLD_CROSS_MAJOR_VERSION 2
+#define EVEL_THRESHOLD_CROSS_MINOR_VERSION 0
/**************************************************************************//**
* Threshold Crossing.
* setter functions, but again values may only be set once so that the
* TCA has immutable properties.
*
+ * @param event_name Unique Event Name
+ * @param event_id A universal identifier of the event for analysis etc
* @param char* tcriticality Performance Counter Criticality MAJ MIN,
* @param char* tname Performance Counter Threshold name
* @param char* tthresholdCrossed Counter Threshold crossed value
* @retval NULL Failed to create the event.
*****************************************************************************/
EVENT_THRESHOLD_CROSS * evel_new_threshold_cross(
+ const char* ev_name, const char *ev_id,
char * tcriticality,
char * tname,
char * tthresholdCrossed,
Code Review / demo.git / blobdiff