1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
|
/* -*- mode: c++; c-basic-offset: 2; indent-tabs-mode: nil; -*-
* vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
*
* Copyright (C) 2008, 2009 Sun Microsystems, Inc.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; version 2 of the License.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
#include <config.h>
#include <boost/scoped_array.hpp>
#include <drizzled/plugin.h>
#include <drizzled/plugin/logging.h>
#include <drizzled/gettext.h>
#include <drizzled/session.h>
#include <drizzled/session/times.h>
#include <drizzled/sql_parse.h>
#include <drizzled/errmsg_print.h>
#include <boost/date_time.hpp>
#include <boost/program_options.hpp>
#include <drizzled/module/option_map.h>
#include <libgearman/gearman.h>
#include <limits.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <fcntl.h>
#include <cstdio>
#include <cerrno>
#include <memory>
namespace drizzle_plugin {
namespace po= boost::program_options;
/* TODO make this dynamic as needed */
static const int MAX_MSG_LEN= 32*1024;
/* quote a string to be safe to include in a CSV line
that means backslash quoting all commas, doublequotes, backslashes,
and all the ASCII unprintable characters
as long as we pass the high-bit bytes unchanged
this is safe to do to a UTF8 string
we dont allow overrunning the targetbuffer
to avoid having a very long query overwrite memory
TODO consider remapping the unprintables instead to "Printable
Representation", the Unicode characters from the area U+2400 to
U+2421 reserved for representing control characters when it is
necessary to print or display them rather than have them perform
their intended function.
*/
static unsigned char *quotify (const unsigned char *src, size_t srclen,
unsigned char *dst, size_t dstlen)
{
static const char hexit[]= { '0', '1', '2', '3', '4', '5', '6', '7',
'8', '9', 'a', 'b', 'c', 'd', 'e', 'f' };
size_t dst_ndx; /* ndx down the dst */
size_t src_ndx; /* ndx down the src */
assert(dst);
assert(dstlen > 0);
for (dst_ndx= 0,src_ndx= 0; src_ndx < srclen; src_ndx++)
{
/* Worst case, need 5 dst bytes for the next src byte.
backslash x hexit hexit null
so if not enough room, just terminate the string and return
*/
if ((dstlen - dst_ndx) < 5)
{
dst[dst_ndx]= (unsigned char)0x00;
return dst;
}
if (src[src_ndx] > 0x7f)
{
// pass thru high bit characters, they are non-ASCII UTF8 Unicode
dst[dst_ndx++]= src[src_ndx];
}
else if (src[src_ndx] == 0x00) // null
{
dst[dst_ndx++]= 0x5C; dst[dst_ndx++]= (unsigned char) '0';
}
else if (src[src_ndx] == 0x07) // bell
{
dst[dst_ndx++]= 0x5C; dst[dst_ndx++]= (unsigned char) 'a';
}
else if (src[src_ndx] == 0x08) // backspace
{
dst[dst_ndx++]= 0x5C; dst[dst_ndx++]= (unsigned char) 'b';
}
else if (src[src_ndx] == 0x09) // horiz tab
{
dst[dst_ndx++]= 0x5C; dst[dst_ndx++]= (unsigned char) 't';
}
else if (src[src_ndx] == 0x0a) // line feed
{
dst[dst_ndx++]= 0x5C; dst[dst_ndx++]= (unsigned char) 'n';
}
else if (src[src_ndx] == 0x0b) // vert tab
{
dst[dst_ndx++]= 0x5C; dst[dst_ndx++]= (unsigned char) 'v';
}
else if (src[src_ndx] == 0x0c) // formfeed
{
dst[dst_ndx++]= 0x5C; dst[dst_ndx++]= (unsigned char) 'f';
}
else if (src[src_ndx] == 0x0d) // carrage return
{
dst[dst_ndx++]= 0x5C; dst[dst_ndx++]= (unsigned char) 'r';
}
else if (src[src_ndx] == 0x1b) // escape
{
dst[dst_ndx++]= 0x5C; dst[dst_ndx++]= (unsigned char) 'e';
}
else if (src[src_ndx] == 0x22) // quotation mark
{
dst[dst_ndx++]= 0x5C; dst[dst_ndx++]= 0x22;
}
else if (src[src_ndx] == 0x2C) // comma
{
dst[dst_ndx++]= 0x5C; dst[dst_ndx++]= 0x2C;
}
else if (src[src_ndx] == 0x5C) // backslash
{
dst[dst_ndx++]= 0x5C; dst[dst_ndx++]= 0x5C;
}
else if ((src[src_ndx] < 0x20) || (src[src_ndx] == 0x7F)) // other unprintable ASCII
{
dst[dst_ndx++]= 0x5C;
dst[dst_ndx++]= (unsigned char) 'x';
dst[dst_ndx++]= hexit[(src[src_ndx] >> 4) & 0x0f];
dst[dst_ndx++]= hexit[src[src_ndx] & 0x0f];
}
else // everything else
{
dst[dst_ndx++]= src[src_ndx];
}
dst[dst_ndx]= '\0';
}
return dst;
}
class LoggingGearman :
public drizzled::plugin::Logging
{
const std::string _host;
const std::string _function;
int _gearman_client_ok;
gearman_client_st _gearman_client;
LoggingGearman();
LoggingGearman(const LoggingGearman&);
public:
LoggingGearman(const std::string &host,
const std::string &function) :
drizzled::plugin::Logging("LoggingGearman"),
_host(host),
_function(function),
_gearman_client_ok(0),
_gearman_client()
{
gearman_return_t ret;
if (gearman_client_create(&_gearman_client) == NULL)
{
drizzled::sql_perror(_("fail gearman_client_create()"));
return;
}
/* TODO, be able to override the port */
/* TODO, be able send to multiple servers */
ret= gearman_client_add_server(&_gearman_client,
host.c_str(), 0);
if (ret != GEARMAN_SUCCESS)
{
drizzled::errmsg_printf(drizzled::error::ERROR, _("fail gearman_client_add_server(): %s"),
gearman_client_error(&_gearman_client));
return;
}
_gearman_client_ok= 1;
}
~LoggingGearman()
{
if (_gearman_client_ok)
{
gearman_client_free(&_gearman_client);
}
}
virtual bool post(drizzled::Session *session)
{
boost::scoped_array<char> msgbuf(new char[MAX_MSG_LEN]);
int msgbuf_len= 0;
assert(session != NULL);
/* in theory, we should return "true", meaning that the plugin isn't happy,
but that crashes the server, so for now, we just lie a little bit
*/
if (not _gearman_client_ok)
return false;
/*
TODO, the session object should have a "utime command completed"
inside itself, so be more accurate, and so this doesnt have to
keep calling current_utime, which can be slow.
*/
uint64_t t_mark= session->times.getCurrentTimestamp(false);
// buffer to quotify the query
unsigned char qs[255];
// to avoid trying to printf %s something that is potentially NULL
drizzled::util::string::ptr dbs(session->schema());
msgbuf_len=
snprintf(msgbuf.get(), MAX_MSG_LEN,
"%"PRIu64",%"PRIu64",%"PRIu64",\"%.*s\",\"%s\",\"%.*s\","
"%"PRIu64",%"PRIu64",%"PRIu64",%"PRIu64",%"PRIu64","
"%"PRIu32",%"PRIu32",%"PRIu32",\"%s\"",
t_mark,
session->thread_id,
session->getQueryId(),
// dont need to quote the db name, always CSV safe
(int)dbs->size(), dbs->c_str(),
// do need to quote the query
quotify((const unsigned char *)session->getQueryString()->c_str(), session->getQueryString()->length(), qs, sizeof(qs)),
// getCommandName is defined in drizzled/sql_parse.h dont
// need to quote the command name, always CSV safe
(int)drizzled::getCommandName(session->command).size(),
drizzled::getCommandName(session->command).c_str(),
// counters are at end, to make it easier to add more
(t_mark - session->times.getConnectMicroseconds()),
(session->times.getElapsedTime()),
(t_mark - session->times.utime_after_lock),
session->sent_row_count,
session->examined_row_count,
session->tmp_table,
session->total_warn_count,
session->getServerId(),
drizzled::getServerHostname().c_str()
);
char job_handle[GEARMAN_JOB_HANDLE_SIZE];
(void) gearman_client_do_background(&_gearman_client,
_function.c_str(),
NULL,
(void *) msgbuf.get(),
(size_t) msgbuf_len,
job_handle);
return false;
}
};
static LoggingGearman *handler= NULL;
static int logging_gearman_plugin_init(drizzled::module::Context &context)
{
const drizzled::module::option_map &vm= context.getOptions();
handler= new LoggingGearman(vm["host"].as<std::string>(),
vm["function"].as<std::string>());
context.add(handler);
context.registerVariable(new drizzled::sys_var_const_string_val("host", vm["host"].as<std::string>()));
context.registerVariable(new drizzled::sys_var_const_string_val("function", vm["function"].as<std::string>()));
return 0;
}
static void init_options(drizzled::module::option_context &context)
{
context("host",
po::value<std::string>()->default_value("localhost"),
_("Hostname for logging to a Gearman server"));
context("function",
po::value<std::string>()->default_value("drizzlelog"),
_("Gearman Function to send logging to"));
}
} /* namespace drizzle_plugin */
DRIZZLE_DECLARE_PLUGIN
{
DRIZZLE_VERSION_ID,
"logging-gearman",
"0.1",
"Mark Atwood <mark@fallenpegasus.com>",
N_("Log queries to a Gearman server"),
drizzled::PLUGIN_LICENSE_GPL,
drizzle_plugin::logging_gearman_plugin_init,
NULL,
drizzle_plugin::init_options
}
DRIZZLE_DECLARE_PLUGIN_END;
|