69
static void quotify(const string &src, string &dst)
74
static unsigned char *quotify (const unsigned char *src, size_t srclen,
75
unsigned char *dst, size_t dstlen)
71
77
static const char hexit[]= { '0', '1', '2', '3', '4', '5', '6', '7',
72
78
'8', '9', 'a', 'b', 'c', 'd', 'e', 'f' };
73
string::const_iterator src_iter;
75
for (src_iter= src.begin(); src_iter < src.end(); ++src_iter)
79
size_t dst_ndx; /* ndx down the dst */
80
size_t src_ndx; /* ndx down the src */
85
for (dst_ndx= 0,src_ndx= 0; src_ndx < srclen; src_ndx++)
77
if (static_cast<unsigned char>(*src_iter) > 0x7f)
79
dst.push_back(*src_iter);
81
else if (*src_iter == 0x00) // null
83
dst.push_back(ESCAPE_CHAR); dst.push_back('0');
85
else if (*src_iter == 0x07) // bell
87
dst.push_back(ESCAPE_CHAR); dst.push_back('a');
89
else if (*src_iter == 0x08) // backspace
91
dst.push_back(ESCAPE_CHAR); dst.push_back('b');
93
else if (*src_iter == 0x09) // horiz tab
95
dst.push_back(ESCAPE_CHAR); dst.push_back('t');
97
else if (*src_iter == 0x0a) // line feed
99
dst.push_back(ESCAPE_CHAR); dst.push_back('n');
101
else if (*src_iter == 0x0b) // vert tab
103
dst.push_back(ESCAPE_CHAR); dst.push_back('v');
105
else if (*src_iter == 0x0c) // formfeed
107
dst.push_back(ESCAPE_CHAR); dst.push_back('f');
109
else if (*src_iter == 0x0d) // carrage return
111
dst.push_back(ESCAPE_CHAR); dst.push_back('r');
113
else if (*src_iter == 0x1b) // escape
115
dst.push_back(ESCAPE_CHAR); dst.push_back('e');
117
else if (*src_iter == 0x22) // quotation mark
119
dst.push_back(ESCAPE_CHAR); dst.push_back(0x22);
121
else if (*src_iter == SEPARATOR_CHAR)
123
dst.push_back(ESCAPE_CHAR); dst.push_back(SEPARATOR_CHAR);
125
else if (*src_iter == ESCAPE_CHAR)
127
dst.push_back(ESCAPE_CHAR); dst.push_back(ESCAPE_CHAR);
129
else if ((*src_iter < 0x20) || (*src_iter == 0x7F)) // other unprintable ASCII
131
dst.push_back(ESCAPE_CHAR);
133
dst.push_back(hexit[(*src_iter >> 4) & 0x0f]);
134
dst.push_back(hexit[*src_iter & 0x0f]);
88
/* Worst case, need 5 dst bytes for the next src byte.
89
backslash x hexit hexit null
90
so if not enough room, just terminate the string and return
92
if ((dstlen - dst_ndx) < 5)
94
dst[dst_ndx]= (unsigned char)0x00;
98
if (src[src_ndx] > 0x7f)
100
// pass thru high bit characters, they are non-ASCII UTF8 Unicode
101
dst[dst_ndx++]= src[src_ndx];
103
else if (src[src_ndx] == 0x00) // null
105
dst[dst_ndx++]= 0x5C; dst[dst_ndx++]= (unsigned char) '0';
107
else if (src[src_ndx] == 0x07) // bell
109
dst[dst_ndx++]= 0x5C; dst[dst_ndx++]= (unsigned char) 'a';
111
else if (src[src_ndx] == 0x08) // backspace
113
dst[dst_ndx++]= 0x5C; dst[dst_ndx++]= (unsigned char) 'b';
115
else if (src[src_ndx] == 0x09) // horiz tab
117
dst[dst_ndx++]= 0x5C; dst[dst_ndx++]= (unsigned char) 't';
119
else if (src[src_ndx] == 0x0a) // line feed
121
dst[dst_ndx++]= 0x5C; dst[dst_ndx++]= (unsigned char) 'n';
123
else if (src[src_ndx] == 0x0b) // vert tab
125
dst[dst_ndx++]= 0x5C; dst[dst_ndx++]= (unsigned char) 'v';
127
else if (src[src_ndx] == 0x0c) // formfeed
129
dst[dst_ndx++]= 0x5C; dst[dst_ndx++]= (unsigned char) 'f';
131
else if (src[src_ndx] == 0x0d) // carrage return
133
dst[dst_ndx++]= 0x5C; dst[dst_ndx++]= (unsigned char) 'r';
135
else if (src[src_ndx] == 0x1b) // escape
137
dst[dst_ndx++]= 0x5C; dst[dst_ndx++]= (unsigned char) 'e';
139
else if (src[src_ndx] == 0x22) // quotation mark
141
dst[dst_ndx++]= 0x5C; dst[dst_ndx++]= 0x22;
143
else if (src[src_ndx] == 0x2C) // comma
145
dst[dst_ndx++]= 0x5C; dst[dst_ndx++]= 0x2C;
147
else if (src[src_ndx] == 0x5C) // backslash
149
dst[dst_ndx++]= 0x5C; dst[dst_ndx++]= 0x5C;
151
else if ((src[src_ndx] < 0x20) || (src[src_ndx] == 0x7F)) // other unprintable ASCII
153
dst[dst_ndx++]= 0x5C;
154
dst[dst_ndx++]= (unsigned char) 'x';
155
dst[dst_ndx++]= hexit[(src[src_ndx] >> 4) & 0x0f];
156
dst[dst_ndx++]= hexit[src[src_ndx] & 0x0f];
136
158
else // everything else
138
dst.push_back(*src_iter);
144
class Logging_query: public drizzled::plugin::Logging
146
const std::string _filename;
147
const std::string _query_pcre;
152
/** Format of the output string */
153
boost::format formatter;
157
Logging_query(const std::string &filename,
158
const std::string &query_pcre) :
159
drizzled::plugin::Logging("Logging_query"),
161
_query_pcre(query_pcre),
162
fd(-1), re(NULL), pe(NULL),
163
formatter("%1%,%2%,%3%,\"%4%\",\"%5%\",\"%6%\",%7%,%8%,"
164
"%9%,%10%,%11%,%12%,%13%,%14%,\"%15%\"\n")
167
/* if there is no destination filename, dont bother doing anything */
168
if (_filename.empty())
171
fd= open(_filename.c_str(),
172
O_WRONLY | O_APPEND | O_CREAT,
177
sql_perror( _("fail open()"), _filename);
181
if (not _query_pcre.empty())
183
const char *this_pcre_error;
184
int this_pcre_erroffset;
185
re= pcre_compile(_query_pcre.c_str(), 0, &this_pcre_error,
186
&this_pcre_erroffset, NULL);
187
pe= pcre_study(re, 0, &this_pcre_error);
188
/* TODO emit error messages if there is a problem */
210
virtual bool post (Session *session)
214
assert(session != NULL);
219
/* Yes, we know that checking sysvar_logging_query_enable,
220
sysvar_logging_query_threshold_big_resultset, and
221
sysvar_logging_query_threshold_big_examined is not threadsafe,
222
because some other thread might change these sysvars. But we
223
don't care. We might start logging a little late as it spreads
224
to other threads. Big deal. */
226
// return if not enabled or query was too fast or resultset was too small
227
if (sysvar_logging_query_enable == false)
229
if (session->sent_row_count < sysvar_logging_query_threshold_big_resultset.get())
231
if (session->examined_row_count < sysvar_logging_query_threshold_big_examined.get())
235
TODO, the session object should have a "utime command completed"
236
inside itself, so be more accurate, and so this doesnt have to
237
keep calling current_utime, which can be slow.
239
uint64_t t_mark= session->getCurrentTimestamp(false);
241
if (session->getElapsedTime() < (sysvar_logging_query_threshold_slow.get()))
244
Session::QueryString query_string(session->getQueryString());
248
this_pcre_rc= pcre_exec(re, pe, query_string->c_str(), query_string->length(), 0, 0, NULL, 0);
249
if (this_pcre_rc < 0)
253
// buffer to quotify the query
256
// Since quotify() builds the quoted string incrementally, we can
257
// avoid some reallocating if we reserve some space up front.
258
qs.reserve(query_string->length());
260
quotify(*query_string, qs);
262
// to avoid trying to printf %s something that is potentially NULL
263
util::string::const_shared_ptr schema(session->schema());
264
const char *dbs= (schema and not schema->empty()) ? schema->c_str() : "";
268
% session->getQueryId()
271
% getCommandName(session->command)
272
% (t_mark - session->getConnectMicroseconds())
273
% session->getElapsedTime()
274
% (t_mark - session->utime_after_lock)
275
% session->sent_row_count
276
% session->examined_row_count
278
% session->total_warn_count
279
% session->getServerId()
280
% getServerHostname();
282
string msgbuf= formatter.str();
284
// a single write has a kernel thread lock, thus no need mutex guard this
285
wrv= write(fd, msgbuf.c_str(), msgbuf.length());
286
assert(wrv == msgbuf.length());
160
dst[dst_ndx++]= src[src_ndx];
168
/* we could just not have a pre entrypoint at all,
169
and have logging_pre == NULL
170
but we have this here for the sake of being an example */
171
bool logging_query_func_pre (Session *)
176
bool logging_query_func_post (Session *session)
178
char msgbuf[MAX_MSG_LEN];
182
assert(session != NULL);
187
/* Yes, we know that checking sysvar_logging_query_enable,
188
sysvar_logging_query_threshold_big_resultset, and
189
sysvar_logging_query_threshold_big_examined is not threadsafe,
190
because some other thread might change these sysvars. But we
191
don't care. We might start logging a little late as it spreads
192
to other threads. Big deal. */
194
// return if not enabled or query was too fast or resultset was too small
195
if (sysvar_logging_query_enable == false)
197
if (session->sent_row_count < sysvar_logging_query_threshold_big_resultset)
199
if (session->examined_row_count < sysvar_logging_query_threshold_big_examined)
202
// logging this is far too verbose
203
if (session->command == COM_FIELD_LIST)
206
/* TODO, looks like connect_utime isnt being set in the session
207
object. We could store the time this plugin was loaded, but that
208
would just be a dumb workaround. */
209
/* TODO, the session object should have a "utime command completed"
210
inside itself, so be more accurate, and so this doesnt have to
211
keep calling current_utime, which can be slow */
213
uint64_t t_mark= get_microtime();
215
if ((t_mark - session->start_utime) < (sysvar_logging_query_threshold_slow))
218
// buffer to quotify the query
219
unsigned char qs[255];
221
// to avoid trying to printf %s something that is potentially NULL
222
const char *dbs= (session->db) ? session->db : "";
225
dbl= session->db_length;
228
snprintf(msgbuf, MAX_MSG_LEN,
229
"%"PRIu64",%"PRIu64",%"PRIu64",\"%.*s\",\"%s\",\"%.*s\","
230
"%"PRIu64",%"PRIu64",%"PRIu64",%"PRIu64",%"PRIu64"\n",
234
// dont need to quote the db name, always CSV safe
236
// do need to quote the query
237
quotify((unsigned char *)session->query,
238
session->query_length, qs, sizeof(qs)),
239
// command_name is defined in drizzled/sql_parse.cc
240
// dont need to quote the command name, always CSV safe
241
(int)command_name[session->command].length,
242
command_name[session->command].str,
243
// counters are at end, to make it easier to add more
244
(t_mark - session->connect_utime),
245
(t_mark - session->start_utime),
246
(t_mark - session->utime_after_lock),
247
session->sent_row_count,
248
session->examined_row_count);
251
// a single write has a kernel thread lock, thus no need mutex guard this
252
wrv= write(fd, msgbuf, msgbuf_len);
253
assert(wrv == msgbuf_len);
258
static int logging_query_plugin_init(void *p)
260
logging_t *l= static_cast<logging_t *>(p);
262
if (sysvar_logging_query_filename == NULL)
264
/* no destination filename was specified via system variables
265
return now, dont set the callback pointers
270
fd= open(sysvar_logging_query_filename,
271
O_WRONLY | O_APPEND | O_CREAT,
275
errmsg_printf(ERRMSG_LVL_ERROR, _("fail open() fn=%s er=%s\n"),
276
sysvar_logging_query_filename,
280
we should return an error here, so the plugin doesnt load
281
but this causes Drizzle to crash
282
so until that is fixed,
283
just return a success,
284
but leave the function pointers as NULL and the fd as -1
289
l->logging_pre= logging_query_func_pre;
290
l->logging_post= logging_query_func_post;
295
static int logging_query_plugin_deinit(void *p)
297
logging_st *l= (logging_st *) p;
305
l->logging_pre= NULL;
306
l->logging_post= NULL;
311
static DRIZZLE_SYSVAR_BOOL(
313
sysvar_logging_query_enable,
315
N_("Enable logging to CSV file"),
316
NULL, /* check func */
317
NULL, /* update func */
318
false /* default */);
320
static DRIZZLE_SYSVAR_STR(
322
sysvar_logging_query_filename,
324
N_("File to log to"),
325
NULL, /* check func */
326
NULL, /* update func*/
329
static DRIZZLE_SYSVAR_ULONG(
331
sysvar_logging_query_threshold_slow,
333
N_("Threshold for logging slow queries, in microseconds"),
334
NULL, /* check func */
335
NULL, /* update func */
338
UINT32_MAX, /* max */
341
static DRIZZLE_SYSVAR_ULONG(
342
threshold_big_resultset,
343
sysvar_logging_query_threshold_big_resultset,
345
N_("Threshold for logging big queries, for rows returned"),
346
NULL, /* check func */
347
NULL, /* update func */
350
UINT32_MAX, /* max */
353
static DRIZZLE_SYSVAR_ULONG(
354
threshold_big_examined,
355
sysvar_logging_query_threshold_big_examined,
357
N_("Threshold for logging big queries, for rows examined"),
358
NULL, /* check func */
359
NULL, /* update func */
362
UINT32_MAX, /* max */
365
static struct st_mysql_sys_var* logging_query_system_variables[]= {
366
DRIZZLE_SYSVAR(enable),
367
DRIZZLE_SYSVAR(filename),
368
DRIZZLE_SYSVAR(threshold_slow),
369
DRIZZLE_SYSVAR(threshold_big_resultset),
370
DRIZZLE_SYSVAR(threshold_big_examined),
292
static int logging_query_plugin_init(drizzled::module::Context &context)
295
const module::option_map &vm= context.getOptions();
297
if (vm.count("filename") > 0)
299
context.add(new Logging_query(vm["filename"].as<string>(),
300
vm["pcre"].as<string>()));
301
context.registerVariable(new sys_var_bool_ptr("enable", &sysvar_logging_query_enable));
302
context.registerVariable(new sys_var_const_string_val("filename", vm["filename"].as<string>()));
303
context.registerVariable(new sys_var_const_string_val("pcre", vm["pcre"].as<string>()));
304
context.registerVariable(new sys_var_constrained_value<uint32_t>("threshold_slow", sysvar_logging_query_threshold_slow));
305
context.registerVariable(new sys_var_constrained_value<uint32_t>("threshold_big_resultset", sysvar_logging_query_threshold_big_resultset));
306
context.registerVariable(new sys_var_constrained_value<uint32_t>("threshold_big_examined", sysvar_logging_query_threshold_big_examined));
312
static void init_options(drizzled::module::option_context &context)
315
po::value<bool>(&sysvar_logging_query_enable)->default_value(false)->zero_tokens(),
316
_("Enable logging to CSV file"));
319
_("File to log to"));
321
po::value<string>()->default_value(""),
322
_("PCRE to match the query against"));
323
context("threshold-slow",
324
po::value<uint32_constraint>(&sysvar_logging_query_threshold_slow)->default_value(0),
325
_("Threshold for logging slow queries, in microseconds"));
326
context("threshold-big-resultset",
327
po::value<uint32_constraint>(&sysvar_logging_query_threshold_big_resultset)->default_value(0),
328
_("Threshold for logging big queries, for rows returned"));
329
context("threshold-big-examined",
330
po::value<uint32_constraint>(&sysvar_logging_query_threshold_big_examined)->default_value(0),
331
_("Threshold for logging big queries, for rows examined"));
334
} /* namespace drizzle_plugin */
336
DRIZZLE_DECLARE_PLUGIN
374
drizzle_declare_plugin(logging_query)
376
DRIZZLE_LOGGER_PLUGIN,
341
379
"Mark Atwood <mark@fallenpegasus.com>",
342
380
N_("Log queries to a CSV file"),
343
381
PLUGIN_LICENSE_GPL,
344
drizzle_plugin::logging_query_plugin_init,
346
drizzle_plugin::init_options
382
logging_query_plugin_init,
383
logging_query_plugin_deinit,
384
NULL, /* status variables */
385
logging_query_system_variables,
348
DRIZZLE_DECLARE_PLUGIN_END;
388
drizzle_declare_plugin_end;