src/syslog.c

   1 /**
   2  * collectd - src/syslog.c
   3  * Copyright (C) 2007       Florian Forster
   4  *
   5  * Permission is hereby granted, free of charge, to any person obtaining a
   6  * copy of this software and associated documentation files (the "Software"),
   7  * to deal in the Software without restriction, including without limitation
   8  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
   9  * and/or sell copies of the Software, and to permit persons to whom the
  10  * Software is furnished to do so, subject to the following conditions:
  11  *
  12  * The above copyright notice and this permission notice shall be included in
  13  * all copies or substantial portions of the Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  18  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  20  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  21  * DEALINGS IN THE SOFTWARE.
  22  *
  23  * Authors:
  24  *   Florian Forster <octo at collectd.org>
  25  **/
  26
  27 #include "collectd.h"
  28
  29 #include "plugin.h"
  30 #include "utils/common/common.h"
  31
  32 #if HAVE_SYSLOG_H
  33 #include <syslog.h>
  34 #endif
  35
  36 #if COLLECT_DEBUG
  37 static int log_level = LOG_DEBUG;
  38 #else
  39 static int log_level = LOG_INFO;
  40 #endif /* COLLECT_DEBUG */
  41 static int notif_severity;
  42
  43 static const char *config_keys[] = {
  44     "LogLevel",
  45     "NotifyLevel",
  46 };
  47 static int config_keys_num = STATIC_ARRAY_SIZE(config_keys);
  48
  49 static int sl_config(const char *key, const char *value) {
  50   if (strcasecmp(key, "LogLevel") == 0) {
  51     log_level = parse_log_severity(value);
  52     if (log_level < 0) {
  53       log_level = LOG_INFO;
  54       WARNING("syslog: invalid loglevel [%s] defaulting to 'info'", value);
  55     }
  56   } else if (strcasecmp(key, "NotifyLevel") == 0) {
  57     notif_severity = parse_notif_severity(value);
  58     if (notif_severity < 0) {
  59       ERROR("syslog: invalid notification severity [%s]", value);
  60       return 1;
  61     }
  62   }
  63
  64   return 0;
  65 } /* int sl_config */
  66
  67 static void sl_log(int severity, const char *msg,
  68                    user_data_t __attribute__((unused)) * user_data) {
  69   if (severity > log_level)
  70     return;
  71
  72   syslog(severity, "%s", msg);
  73 } /* void sl_log */
  74
  75 static int sl_shutdown(void) {
  76   closelog();
  77
  78   return 0;
  79 }
  80
  81 static int sl_notification(const notification_t *n,
  82                            user_data_t __attribute__((unused)) * user_data) {
  83   char buf[1024] = "";
  84   size_t offset = 0;
  85   int log_severity;
  86   const char *severity_string;
  87   int status;
  88
  89   if (n->severity > notif_severity)
  90     return 0;
  91
  92   switch (n->severity) {
  93   case NOTIF_FAILURE:
  94     severity_string = "FAILURE";
  95     log_severity = LOG_ERR;
  96     break;
  97   case NOTIF_WARNING:
  98     severity_string = "WARNING";
  99     log_severity = LOG_WARNING;
 100     break;
 101   case NOTIF_OKAY:
 102     severity_string = "OKAY";
 103     log_severity = LOG_NOTICE;
 104     break;
 105   default:
 106     severity_string = "UNKNOWN";
 107     log_severity = LOG_ERR;
 108   }
 109
 110 #define BUFFER_ADD(...)                                                        \
 111   do {                                                                         \
 112     status = snprintf(&buf[offset], sizeof(buf) - offset, __VA_ARGS__);        \
 113     if (status < 1)                                                            \
 114       return -1;                                                               \
 115     else if (((size_t)status) >= (sizeof(buf) - offset))                       \
 116       return -ENOMEM;                                                          \
 117     else                                                                       \
 118       offset += ((size_t)status);                                              \
 119   } while (0)
 120
 121 #define BUFFER_ADD_FIELD(field)                                                \
 122   do {                                                                         \
 123     if (n->field[0])                                                           \
 124       BUFFER_ADD(", " #field " = %s", n->field);                               \
 125   } while (0)
 126
 127   BUFFER_ADD("Notification: severity = %s", severity_string);
 128   BUFFER_ADD_FIELD(host);
 129   BUFFER_ADD_FIELD(plugin);
 130   BUFFER_ADD_FIELD(plugin_instance);
 131   BUFFER_ADD_FIELD(type);
 132   BUFFER_ADD_FIELD(type_instance);
 133   BUFFER_ADD_FIELD(message);
 134
 135 #undef BUFFER_ADD_FIELD
 136 #undef BUFFER_ADD
 137
 138   buf[sizeof(buf) - 1] = '\0';
 139
 140   sl_log(log_severity, buf, NULL);
 141
 142   return 0;
 143 } /* int sl_notification */
 144
 145 void module_register(void) {
 146   openlog("collectd", LOG_CONS | LOG_PID, LOG_DAEMON);
 147
 148   plugin_register_config("syslog", sl_config, config_keys, config_keys_num);
 149   plugin_register_log("syslog", sl_log, /* user_data = */ NULL);
 150   plugin_register_notification("syslog", sl_notification, NULL);
 151   plugin_register_shutdown("syslog", sl_shutdown);
 152 } /* void module_register(void) */