summaryrefslogtreecommitdiff
path: root/src/log.h
diff options
context:
space:
mode:
authorRobert James Kaes <rjkaes@users.sourceforge.net>2000-09-11 23:47:52 +0000
committerRobert James Kaes <rjkaes@users.sourceforge.net>2000-09-11 23:47:52 +0000
commit4f4f91f76ff33c65f2f0da2ce17bf8f52907dcf9 (patch)
tree59fe49b704666dafa6b2e9f18b353330cd8b69d1 /src/log.h
parent5d7063a79e79bf3ae3723e4fd751205cbd740c23 (diff)
downloadtinyproxy-4f4f91f76ff33c65f2f0da2ce17bf8f52907dcf9.tar.gz
tinyproxy-4f4f91f76ff33c65f2f0da2ce17bf8f52907dcf9.zip
Cleaned up the logging format, and also included logging levels (which are
similar to the syslogd format.)
Diffstat (limited to '')
-rw-r--r--src/log.h72
1 files changed, 68 insertions, 4 deletions
diff --git a/src/log.h b/src/log.h
index e928b4c..2be42e9 100644
--- a/src/log.h
+++ b/src/log.h
@@ -1,4 +1,4 @@
-/* $Id: log.h,v 1.1.1.1 2000-02-16 17:32:22 sdyoung Exp $
+/* $Id: log.h,v 1.2 2000-09-11 23:47:52 rjkaes Exp $
*
* See 'log.c' for a detailed description.
*
@@ -16,9 +16,73 @@
* General Public License for more details.
*/
-#ifndef _LOG_H_
-#define _LOG_H_ 1
+#ifndef _TINYPROXY_LOG_H_
+#define _TINYPROXY_LOG_H_
-extern void log(char *fmt, ...);
+#ifdef HAVE_CONFIG_H
+# include "../config.h"
+#endif
+
+/*
+ * Okay, I have modelled the levels for logging off the syslog() interface.
+ * However, I would really prefer if only five of the levels are used. You
+ * can see them below and I'll describe what each level should be for.
+ * Hopefully tinyproxy will remain consistent with these levels.
+ * -- rjkaes
+ *
+ * Level Description
+ * ----- -----------
+ * LOG_CRIT This is catastrophic. Basically, tinyproxy can not recover
+ * from this and will either close the thread (if we're lucky),
+ * or the entire daemon. I would relegate this to conditions
+ * like unable to create the listening socket, or unable to
+ * create a thread. If you're going to log at this level provide
+ * as much information as possible.
+ *
+ * LOG_ERR Okay, something bad happened. We can recover from this, but
+ * the connection will be terminated. This should be for things
+ * like when we cannot create a socket, or out of memory.
+ * Basically, the connection will not work, but it's not enough
+ * to bring the whole daemon down.
+ *
+ * LOG_WARNING There is condition which will change the behaviour of
+ * tinyproxy from what is expected. For example, somebody did
+ * not specify a port. tinyproxy will handle this (by using
+ * it's default port), but it's a _higher_ level situation
+ * which the admin should be aware of.
+ *
+ * LOG_INFO Everything else ends up here. Logging for incoming
+ * connections, denying due to filtering rules, unable to
+ * connect to remote server, etc.
+ *
+ * LOG_DEBUG Don't use this level. :) Use the two DEBUG?() macros
+ * instead since they can remain in the source if needed. (I
+ * don't advocate this, but it could be useful at times.)
+ */
+
+#ifdef HAVE_SYSLOG_H
+# include <syslog.h>
+#else
+# define LOG_CRIT 2
+# define LOG_ERR 3
+# define LOG_WARNING 4
+# define LOG_INFO 6
+# define LOG_DEBUG 7
+#endif
+
+/*
+ * Use this for debugging. The format is specific:
+ * DEBUG1("There was a major problem");
+ * DEBUG2("There was a big problem: %s in connptr %p", "hello", connptr);
+ */
+#ifndef NDEBUG
+# define DEBUG1(x) log(LOG_DEBUG, "[%s:%d] " x, __FILE__, __LINE__)
+# define DEBUG2(x, y...) log(LOG_DEBUG, "[%s:%d] " x, __FILE__, __LINE__, ## y)
+#else
+# define DEBUG1(x) do { } while(0)
+# define DEBUG2(x, y...) do { } while(0)
+#endif
+
+extern void log(short int level, char *fmt, ...);
#endif