1 /**
2 * collectd - src/logfile.c
3 * Copyright (C) 2007 Sebastian Harl
4 * Copyright (C) 2007,2008 Florian Forster
5 *
6 * Permission is hereby granted, free of charge, to any person obtaining a
7 * copy of this software and associated documentation files (the "Software"),
8 * to deal in the Software without restriction, including without limitation
9 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
10 * and/or sell copies of the Software, and to permit persons to whom the
11 * Software is furnished to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22 * DEALINGS IN THE SOFTWARE.
23 *
24 * Authors:
25 * Sebastian Harl <sh at tokkee.org>
26 * Florian Forster <octo at collectd.org>
27 **/
29 #include "collectd.h"
31 #include "common.h"
32 #include "plugin.h"
34 #define DEFAULT_LOGFILE LOCALSTATEDIR "/log/collectd.log"
36 #if COLLECT_DEBUG
37 static int log_level = LOG_DEBUG;
38 #else
39 static int log_level = LOG_INFO;
40 #endif /* COLLECT_DEBUG */
42 static pthread_mutex_t file_lock = PTHREAD_MUTEX_INITIALIZER;
44 static char *log_file = NULL;
45 static int print_timestamp = 1;
46 static int print_severity = 0;
48 static const char *config_keys[] = {"LogLevel", "File", "Timestamp",
49 "PrintSeverity"};
50 static int config_keys_num = STATIC_ARRAY_SIZE(config_keys);
52 static int logfile_config(const char *key, const char *value) {
53 if (0 == strcasecmp(key, "LogLevel")) {
54 log_level = parse_log_severity(value);
55 if (log_level < 0) {
56 log_level = LOG_INFO;
57 ERROR("logfile: invalid loglevel [%s] defaulting to 'info'", value);
58 return (1);
59 }
60 } else if (0 == strcasecmp(key, "File")) {
61 sfree(log_file);
62 log_file = strdup(value);
63 } else if (0 == strcasecmp(key, "Timestamp")) {
64 if (IS_FALSE(value))
65 print_timestamp = 0;
66 else
67 print_timestamp = 1;
68 } else if (0 == strcasecmp(key, "PrintSeverity")) {
69 if (IS_FALSE(value))
70 print_severity = 0;
71 else
72 print_severity = 1;
73 } else {
74 return -1;
75 }
76 return 0;
77 } /* int logfile_config (const char *, const char *) */
79 static void logfile_print(const char *msg, int severity,
80 cdtime_t timestamp_time) {
81 FILE *fh;
82 _Bool do_close = 0;
83 char timestamp_str[64];
84 char level_str[16] = "";
86 if (print_severity) {
87 switch (severity) {
88 case LOG_ERR:
89 snprintf(level_str, sizeof(level_str), "[error] ");
90 break;
91 case LOG_WARNING:
92 snprintf(level_str, sizeof(level_str), "[warning] ");
93 break;
94 case LOG_NOTICE:
95 snprintf(level_str, sizeof(level_str), "[notice] ");
96 break;
97 case LOG_INFO:
98 snprintf(level_str, sizeof(level_str), "[info] ");
99 break;
100 case LOG_DEBUG:
101 snprintf(level_str, sizeof(level_str), "[debug] ");
102 break;
103 default:
104 break;
105 }
106 }
108 if (print_timestamp) {
109 struct tm timestamp_tm;
110 localtime_r(&CDTIME_T_TO_TIME_T(timestamp_time), ×tamp_tm);
112 strftime(timestamp_str, sizeof(timestamp_str), "%Y-%m-%d %H:%M:%S",
113 ×tamp_tm);
114 timestamp_str[sizeof(timestamp_str) - 1] = '\0';
115 }
117 pthread_mutex_lock(&file_lock);
119 if (log_file == NULL) {
120 fh = fopen(DEFAULT_LOGFILE, "a");
121 do_close = 1;
122 } else if (strcasecmp(log_file, "stderr") == 0)
123 fh = stderr;
124 else if (strcasecmp(log_file, "stdout") == 0)
125 fh = stdout;
126 else {
127 fh = fopen(log_file, "a");
128 do_close = 1;
129 }
131 if (fh == NULL) {
132 char errbuf[1024];
133 fprintf(stderr, "logfile plugin: fopen (%s) failed: %s\n",
134 (log_file == NULL) ? DEFAULT_LOGFILE : log_file,
135 sstrerror(errno, errbuf, sizeof(errbuf)));
136 } else {
137 if (print_timestamp)
138 fprintf(fh, "[%s] %s%s\n", timestamp_str, level_str, msg);
139 else
140 fprintf(fh, "%s%s\n", level_str, msg);
142 if (do_close) {
143 fclose(fh);
144 } else {
145 fflush(fh);
146 }
147 }
149 pthread_mutex_unlock(&file_lock);
151 return;
152 } /* void logfile_print */
154 static void logfile_log(int severity, const char *msg,
155 user_data_t __attribute__((unused)) * user_data) {
156 if (severity > log_level)
157 return;
159 logfile_print(msg, severity, cdtime());
160 } /* void logfile_log (int, const char *) */
162 static int logfile_notification(const notification_t *n,
163 user_data_t __attribute__((unused)) *
164 user_data) {
165 char buf[1024] = "";
166 char *buf_ptr = buf;
167 int buf_len = sizeof(buf);
168 int status;
170 status = ssnprintf(
171 buf_ptr, buf_len, "Notification: severity = %s",
172 (n->severity == NOTIF_FAILURE)
173 ? "FAILURE"
174 : ((n->severity == NOTIF_WARNING)
175 ? "WARNING"
176 : ((n->severity == NOTIF_OKAY) ? "OKAY" : "UNKNOWN")));
177 if (status > 0) {
178 buf_ptr += status;
179 buf_len -= status;
180 }
182 #define APPEND(bufptr, buflen, key, value) \
183 if ((buflen > 0) && (strlen(value) > 0)) { \
184 status = ssnprintf(bufptr, buflen, ", %s = %s", key, value); \
185 if (status > 0) { \
186 bufptr += status; \
187 buflen -= status; \
188 } \
189 }
190 APPEND(buf_ptr, buf_len, "host", n->host);
191 APPEND(buf_ptr, buf_len, "plugin", n->plugin);
192 APPEND(buf_ptr, buf_len, "plugin_instance", n->plugin_instance);
193 APPEND(buf_ptr, buf_len, "type", n->type);
194 APPEND(buf_ptr, buf_len, "type_instance", n->type_instance);
195 APPEND(buf_ptr, buf_len, "message", n->message);
197 buf[sizeof(buf) - 1] = '\0';
199 logfile_print(buf, LOG_INFO, (n->time != 0) ? n->time : cdtime());
201 return (0);
202 } /* int logfile_notification */
204 void module_register(void) {
205 plugin_register_config("logfile", logfile_config, config_keys,
206 config_keys_num);
207 plugin_register_log("logfile", logfile_log, /* user_data = */ NULL);
208 plugin_register_notification("logfile", logfile_notification,
209 /* user_data = */ NULL);
210 } /* void module_register (void) */
212 /* vim: set sw=4 ts=4 tw=78 noexpandtab : */