mondemandlib.h

Go to the documentation of this file.

#ifndef __MONDEMAND_H__
#define __MONDEMAND_H__

#include "m_hash.h"
#include "mondemand_trace.h"
#include "mondemand_transport.h"

#include <stdarg.h>

#ifdef __cplusplus
#define HAVE_ISO_VARARGS HAVE_ISO_CXX_VARARGS
#define HAVE_GNUC_VARARGS HAVE_GNUC_CXX_VARARGS
#else
#define HAVE_ISO_VARARGS HAVE_ISO_C_VARARGS
#define HAVE_GNUC_VARARGS HAVE_GNUC_C_VARARGS
#endif

/*
 * priorities map to the syslog priorities.
 */
#define M_LOG_EMERG       0       /* system is unusable */
#define M_LOG_ALERT       1       /* action must be taken immediately */
#define M_LOG_CRIT        2       /* critical conditions */
#define M_LOG_ERR         3       /* error conditions */
#define M_LOG_WARNING     4       /* warning conditions */
#define M_LOG_NOTICE      5       /* normal but significant condition */
#define M_LOG_INFO        6       /* informational */
#define M_LOG_DEBUG       7       /* debug-level messages */
#define M_LOG_ALL         8       /* all messages, including traces */

/* convenience */
#define M_LOG_WARN M_LOG_WARNING
#define M_LOG_ERROR M_LOG_ERR

/* these are used to print human readable log levels */
static const char * const MonDemandLogLevelStrings[] = {
  "emerg",
  "alert",
  "crit",
  "error",
  "warning",
  "notice",
  "info",
  "debug",
  "all"
};


/* forward declaration of opaque structs */
struct mondemand_client;


struct mondemand_client *
mondemand_client_create(const char *program_identifier);


void mondemand_client_destroy(struct mondemand_client *client);


void
mondemand_set_immediate_send_level(struct mondemand_client *client,
                                   const int level);

void
mondemand_set_no_send_level(struct mondemand_client *client, const int level);


const char *
mondemand_get_context(struct mondemand_client *client, const char *key);


const char **
mondemand_get_context_keys(struct mondemand_client *client);


int
mondemand_set_context(struct mondemand_client *client,
                      const char *key, const char *value);


void
mondemand_remove_context(struct mondemand_client *client, const char *key);


void
mondemand_remove_all_contexts(struct mondemand_client *client);


int
mondemand_add_transport(struct mondemand_client *client,
                        struct mondemand_transport *transport);


/*\fn mondemand_level_is_enabled(struct mondemand_client *client,
 *                               const int log_level)
 * \brief this checks if a log level is enabled, which is useful to callers
 *        in case they want to check whether or not to bother to log.
 */
int
mondemand_level_is_enabled(struct mondemand_client *client,
                           const int log_level);

int mondemand_flush_logs(struct mondemand_client *client);

int mondemand_flush_stats(struct mondemand_client *client);

int mondemand_flush_stats_no_reset(struct mondemand_client *client);

int mondemand_flush(struct mondemand_client *client);


/*=====================================================================*/
/* Useful Macros                                                       */
/*=====================================================================*/

#if HAVE_ISO_VARARGS

/* macros for ISO style varargs */

#define mondemand_log(m, level, tid, ...) \
  mondemand_log_real(m, __FILE__, __LINE__, level, tid, __VA_ARGS__)

#define mondemand_emerg(m, tid, ...) \
  mondemand_log_real(m, __FILE__, __LINE__, M_LOG_EMERG, tid, __VA_ARGS__)

#define mondemand_alert(m, tid, ...) \
  mondemand_log_real(m, __FILE__, __LINE__, M_LOG_ALERT, tid, __VA_ARGS__)

#define mondemand_crit(m, tid, ...) \
  mondemand_log_real(m, __FILE__, __LINE__, M_LOG_CRIT, tid, __VA_ARGS__)

#define mondemand_error(m, tid, ...) \
  mondemand_log_real(m, __FILE__, __LINE__, M_LOG_ERR, tid, __VA_ARGS__)

#define mondemand_warning(m, tid, ...) \
  mondemand_log_real(m, __FILE__, __LINE__, M_LOG_WARNING, tid, __VA_ARGS__)

#define mondemand_notice(m, tid, ...) \
  mondemand_log_real(m, __FILE__, __LINE__, M_LOG_NOTICE, tid, __VA_ARGS__)

#define mondemand_info(m, tid, ...) \
  mondemand_log_real(m, __FILE__, __LINE__, M_LOG_INFO, tid, __VA_ARGS__)

#define mondemand_debug(m, tid, ...) \
  mondemand_log_real(m, __FILE__, __LINE__, M_LOG_DEBUG, tid, __VA_ARGS__)


#elif HAVE_GNUC_VARARGS

/* macros for gnuc style varargs */

#define mondemand_log(m, level, tid, format...) \
  mondemand_log_real(m, __FILE__, __LINE__, level, tid, format)

#define mondemand_emerg(m, tid, format...) \
  mondemand_log_real(m, __FILE__, __LINE__, M_LOG_EMERG, tid, format)

#define mondemand_alert(m, tid, format...) \
  mondemand_log_real(m, __FILE__, __LINE__, M_LOG_ALERT, tid, format)

#define mondemand_crit(m, tid, format...) \
  mondemand_log_real(m, __FILE__, __LINE__, M_LOG_CRIT, tid, format)

#define mondemand_error(m, tid, format...) \
  mondemand_log_real(m, __FILE__, __LINE__, M_LOG_ERR, tid, format)

#define mondemand_warning(m, tid, format...) \
  mondemand_log_real(m, __FILE__, __LINE__, M_LOG_WARNING, tid, format)

#define mondemand_notice(m, tid, format...) \
  mondemand_log_real(m, __FILE__, __LINE__, M_LOG_NOTICE, tid, format)

#define mondemand_info(m, tid, format...) \
  mondemand_log_real(m, __FILE__, __LINE__, M_LOG_INFO, tid, format)

#define mondemand_debug(m, tid, format...) \
  mondemand_log_real(m, __FILE__, __LINE__, M_LOG_DEBUG, tid, format)

#endif

/* increments a counter by 1 using the filename:line */
#define mondemand_increment(m) \
  mondemand_stats_inc(m, __FILE__, __LINE__, NULL, 1)

/* increments a counter by value using the filename:line */
#define mondemand_increment_value(m, v) \
  mondemand_stats_inc(m, __FILE__, __LINE__, NULL, v)

/* increments the specified key by 1 */
#define mondemand_increment_key(m, k) \
  mondemand_stats_inc(m, __FILE__, __LINE__, k, 1);

/* increments the specified key by value */
#define mondemand_increment_key_by_val(m, k, v) \
  mondemand_stats_inc(m, __FILE__, __LINE__, k, v)

/* decrements a counter by 1 using filename:line */
#define mondemand_decrement(m) \
  mondemand_stats_dec(m, __FILE__, __LINE__, NULL, 1)

/* decrements a counter by value using filename:line */
#define mondemand_decrement_value(m, v) \
  mondemand_stats_dec(m, __FILE__, __LINE__, NULL, v)

/* decrements the named key by 1 */
#define mondemand_decrement_key(m, k) \
  mondemand_stats_dec(m, __FILE__, __LINE__, k, 1);

/* decrements the named key by value */
#define mondemand_decrement_key_by_val(m, k, v) \
  mondemand_stats_dec(m, __FILE__, __LINE__, k, v)

/* sets a counter by value using filename:line */
#define mondemand_set_by_val(m, v) \
  mondemand_stats_set(m, __FILE__, __LINE__, NULL, v)

/* set the specified key to the value specified */
#define mondemand_set_key_by_val(m, k, v) \
  mondemand_stats_set(m, __FILE__, __LINE__, k, v)


/*=====================================================================*/
/* Semi-private functions                                              */
/*=====================================================================*/

int mondemand_log_real(struct mondemand_client *client,
                       const char *filename, const int line, const int level,
                       const struct mondemand_trace_id trace_id,
                       const char *format, ...);

int mondemand_log_real_va(struct mondemand_client *client,
                          const char *filename, const int line, 
                          const int level,
                          const struct mondemand_trace_id trace_id,
                          const char *format, va_list args);

int mondemand_stats_inc(struct mondemand_client *client,
                        const char *filename, const int line,
                        const char *key, const int value);

int mondemand_stats_dec(struct mondemand_client *client,
                        const char *filename, const int line,
                        const char *key, const int value);

int mondemand_stats_set(struct mondemand_client *client,
                        const char *filename, const int line,
                        const char *key, const int value);


#endif /* __MONDEMAND_H_ */

---