FEATURE: Add cmdlog optional filtering

Author: 6unYoung

cmdlog.c

@@ -25,6 +25,7 @@
 #include <fcntl.h>
 #include <assert.h>
 #include <errno.h>
+#include <ctype.h>
 
 #include "memcached/util.h"
 
@@ -38,6 +39,10 @@
 #define CMDLOG_FILENAME_LENGTH CMDLOG_DIRPATH_LENGTH + 128
 #define CMDLOG_FILENAME_FORMAT "%s/command_%d_%d_%d_%d.log"
 
+#define CMDLOG_FILTER_MAXNUM 10
+#define CMDLOG_FILTER_CMD_MAXLEN 15
+#define CMDLOG_FILTER_KEY_MAXLEN 16000
+
 /* cmdlog state */
 #define CMDLOG_NOT_STARTED   0  /* not started */
 #define CMDLOG_OVERFLOW_STOP 1  /* stop by command log overflow */
@@ -59,6 +64,12 @@ struct cmd_log_buffer {
     uint32_t last;
 };
 
+/* command log filter structure */
+struct cmd_log_filter {
+    char command[CMDLOG_FILTER_CMD_MAXLEN + 1];
+    char key[CMDLOG_FILTER_KEY_MAXLEN + 1];
+};
+
 /*command log flush structure */
 struct cmd_log_flush {
     pthread_t tid;        /* flush thread id */
@@ -85,6 +96,8 @@ struct cmd_log_global {
     struct cmd_log_buffer buffer;
     struct cmd_log_flush flush;
     struct cmd_log_stats stats;
+    struct cmd_log_filter filters[CMDLOG_FILTER_MAXNUM];
+    int nfilters;
     volatile bool reqstop;
 };
 struct cmd_log_global cmdlog;
@@ -397,25 +410,42 @@ char *cmdlog_stats(void)
     return str;
 }
 
-void cmdlog_write(char *client_ip, char *command)
+void cmdlog_write(char *client_ip, char *command, int cmdlen)
 {
     struct tm *ptm;
     struct timeval val;
     struct cmd_log_buffer *buffer = &cmdlog.buffer;
     char inputstr[CMDLOG_INPUT_SIZE];
+    char *ptr = command;
     int inputlen;
     int nwritten;
+    int seglen;
 
     gettimeofday(&val, NULL);
     ptm = localtime(&val.tv_sec);
 
-    nwritten = snprintf(inputstr, CMDLOG_INPUT_SIZE, "%02d:%02d:%02d.%06ld %s %s\n",
-                       ptm->tm_hour, ptm->tm_min, ptm->tm_sec, (long)val.tv_usec, client_ip, command);
+    nwritten = snprintf(inputstr, CMDLOG_INPUT_SIZE, "%02d:%02d:%02d.%06ld %s ",
+                       ptm->tm_hour, ptm->tm_min, ptm->tm_sec, (long)val.tv_usec, client_ip);
+
+    while (ptr < command + cmdlen && nwritten < CMDLOG_INPUT_SIZE) {
+        seglen = snprintf(inputstr + nwritten, CMDLOG_INPUT_SIZE - nwritten, "%s", ptr);
+        nwritten += seglen;
+        ptr += seglen;
+
+        if (ptr < command + cmdlen && nwritten < CMDLOG_INPUT_SIZE) {
+            inputstr[nwritten++] = ' ';
+            ptr++;
+        }
+    }
+
     /* truncated ? */
-    if (nwritten > CMDLOG_INPUT_SIZE) {
+    if (nwritten >= CMDLOG_INPUT_SIZE) {
         inputstr[CMDLOG_INPUT_SIZE-4] = '.';
         inputstr[CMDLOG_INPUT_SIZE-3] = '.';
         inputstr[CMDLOG_INPUT_SIZE-2] = '\n';
+    } else {
+        inputstr[nwritten++] = '\n';
+        inputstr[nwritten] = '\0';
     }
     inputlen = strlen(inputstr);
 
@@ -447,3 +477,151 @@ void cmdlog_write(char *client_ip, char *command)
     }
     pthread_mutex_unlock(&buffer->lock);
 }
+
+static int get_key_idx_by_command(const char *command)
+{
+    assert(command);
+    int cmdlen = strlen(command);
+    if (cmdlen < 3) {
+        return -1;
+    }
+
+    if ((command[0] == 'l' || command[0] == 's' || command[0] == 'm' || command[0] == 'b') &&
+        strcmp(command + 1, "op") == 0) {
+        if ((cmdlen == 8 && memcmp(command, "bop_mget", 8) == 0) ||
+            (cmdlen == 9 && memcmp(command, "bop_smget", 9) == 0)) {
+            return -1;
+        }
+        return 2;
+    } else if ((cmdlen == 3 && memcmp(command, "get", 3) == 0) ||
+               (cmdlen == 4 && memcmp(command, "gets", 4) == 0) ||
+               (cmdlen == 3 && memcmp(command, "gat", 3) == 0) ||
+               (cmdlen == 4 && memcmp(command, "gats", 4) == 0) ||
+               (cmdlen == 3 && memcmp(command, "add", 3) == 0) ||
+               (cmdlen == 3 && memcmp(command, "set", 3) == 0) ||
+               (cmdlen == 7 && memcmp(command, "replace", 7) == 0) ||
+               (cmdlen == 7 && memcmp(command, "prepend", 7) == 0) ||
+               (cmdlen == 6 && memcmp(command, "append", 6) == 0) ||
+               (cmdlen == 3 && memcmp(command, "cas", 3) == 0) ||
+               (cmdlen == 4 && memcmp(command, "incr", 4) == 0) ||
+               (cmdlen == 4 && memcmp(command, "decr", 4) == 0) ||
+               (cmdlen == 6 && memcmp(command, "delete", 6) == 0) ||
+               (cmdlen == 7 && memcmp(command, "getattr", 7) == 0) ||
+               (cmdlen == 7 && memcmp(command, "setattr", 7) == 0) ||
+               (cmdlen == 5 && memcmp(command, "touch", 5) == 0)) {
+        return 1;
+    }
+
+    return -1;
+}
+
+bool is_cmdlog_filter_match(token_t *tokens, size_t ntokens)
+{
+    char command[CMDLOG_FILTER_CMD_MAXLEN + 1] = "";
+    char *key = "";
+    int key_idx = -1;
+    bool matched = false;
+
+    if (cmdlog.nfilters == 0) {
+        return true;
+    }
+
+    if (ntokens < 2) {
+        return false;
+    }
+
+    if (ntokens >= 3 && strcmp(tokens[0].value + 1, "op") == 0) {
+        snprintf(command, CMDLOG_FILTER_CMD_MAXLEN + 1, "%3s_%s", tokens[0].value, tokens[1].value);
+    } else {
+        snprintf(command, CMDLOG_FILTER_CMD_MAXLEN + 1, "%s", tokens[0].value);
+    }
+
+    key_idx = get_key_idx_by_command(command);
+    if ((key_idx == 2 && ntokens >= 4) || (key_idx == 1 && ntokens >= 3)) {
+        key = tokens[key_idx].value;
+    }
+
+    pthread_mutex_lock(&cmdlog.lock);
+    for (int i = 0; i < cmdlog.nfilters; ++i) {
+        if (cmdlog.filters[i].command[0] == '\0' || strcmp(command, cmdlog.filters[i].command) == 0) {
+            if (cmdlog.filters[i].key[0] == '\0' || strcmp(key, cmdlog.filters[i].key) == 0) {
+                matched = true;
+                break;
+            }
+        }
+    }
+    pthread_mutex_unlock(&cmdlog.lock);
+    return matched;
+}
+
+int cmdlog_filter_add(const char *command, int command_len, const char *key, int key_len)
+{
+    int success;
+
+    if (command_len > CMDLOG_FILTER_CMD_MAXLEN || key_len > CMDLOG_FILTER_KEY_MAXLEN) {
+        return -1;
+    }
+
+    if (key_len > 0) {
+        for (int i = 0; key[i] != '\0' && i < CMDLOG_FILTER_KEY_MAXLEN; ++i) {
+            if (!isgraph(key[i])) {
+                return -1;
+            }
+        }
+    }
+
+    success = 0;
+    pthread_mutex_lock(&cmdlog.lock);
+    if (cmdlog.nfilters < CMDLOG_FILTER_MAXNUM) {
+        strcpy(cmdlog.filters[cmdlog.nfilters].command, command);
+        strcpy(cmdlog.filters[cmdlog.nfilters].key, key);
+        cmdlog.nfilters++;
+        success++;
+    }
+    pthread_mutex_unlock(&cmdlog.lock);
+    return success;
+}
+
+int cmdlog_filter_remove(int idx, bool remove_all)
+{
+    int nremove;
+
+    if (remove_all == false && (idx < 0 || idx >= cmdlog.nfilters)) {
+        return -1;
+    }
+
+    nremove = 0;
+    pthread_mutex_lock(&cmdlog.lock);
+    if (remove_all) {
+        nremove += cmdlog.nfilters;
+        cmdlog.nfilters = 0;
+    } else {
+        for (int i = idx; i < cmdlog.nfilters - 1; ++i) {
+            cmdlog.filters[i] = cmdlog.filters[i + 1];
+        }
+        cmdlog.nfilters--;
+        nremove++;
+    }
+    pthread_mutex_unlock(&cmdlog.lock);
+    return nremove;
+}
+
+char *cmdlog_filter_list(void)
+{
+    char *buf = (char *)malloc((cmdlog.nfilters + 1) * CMDLOG_INPUT_SIZE);
+    int nwritten;
+
+    if (!buf) {
+        return NULL;
+    }
+
+    nwritten = 0;
+    pthread_mutex_lock(&cmdlog.lock);
+    nwritten = snprintf(buf, CMDLOG_INPUT_SIZE, "\t(%d / %d)\n", cmdlog.nfilters, CMDLOG_FILTER_MAXNUM);
+    for (int i = 0; i < cmdlog.nfilters; ++i) {
+        nwritten += snprintf(buf + nwritten, CMDLOG_INPUT_SIZE, "\t%d. command = %s, key = %s\n",
+                             i, cmdlog.filters[i].command, cmdlog.filters[i].key);
+    }
+    pthread_mutex_unlock(&cmdlog.lock);
+    return buf;
+}

cmdlog.h

@@ -30,5 +30,9 @@ void cmdlog_final(void);
 int cmdlog_start(char *file_path, bool *already_started);
 void cmdlog_stop(bool *already_stopped);
 char *cmdlog_stats(void);
-void cmdlog_write(char *client_ip, char *command);
+void cmdlog_write(char *client_ip, char *command, int cmdlen);
+bool is_cmdlog_filter_match(token_t *tokens, size_t ntokens);
+int cmdlog_filter_add(const char *command, int command_len, const char *key, int key_len);
+int cmdlog_filter_remove(int idx, bool remove_all);
+char *cmdlog_filter_list(void);
 #endif

docs/ascii-protocol/ch13-command-administration.md

@@ -869,6 +869,9 @@ start 명령을 시작으로 logging이 종료될 때 까지의 모든 command
 cmdlog start [<log_file_path>]\r\n
 cmdlog stop\r\n
 cmdlog stats\r\n
+cmdlog filter add (command <cmd>|key <key>|command <cmd> key <key>)\r\n
+cmdlog filter remove (all|<idx>)\r\n
+cmdlog filter list\r\n
 ```
 
 \<log_file_path\>는 logging 정보를 저장할 file의 path이다.
@@ -910,6 +913,33 @@ The number of log files : 1                                          //file_coun
 The log file name: /Users/temp/command_11211_20160126_192729_{n}.log //path/file_name
 ```
 
+filter add 명령은 필터링할 명령어와 키 조합을 필터 목록에 추가한다.
+입력한 조합에 대해 exact matching 방식으로 필터링한다. response string은 아래와 같다.
+
+| Response String                  | 설명                                                                  |
+| -------------------------------- | --------------------------------------------------------------------- |
+| OK                               | 성공                                                                  |
+| SERVER_ERROR filter list is full | 존재하는 필터 수가 이미 최대치이므로 더 추가할 수 없음                |
+| CLIENT_ERROR invalid parameters  | 인자로 입력한 command나 key가 유효하지 않은 문자거나 최대 길이를 넘음 |
+
+filter remove 명령은 필터 리스트에서 특정 인덱스의 필터를 삭제한다.
+인덱스 대신 all을 입력하면 존재하던 모든 필터를 삭제한다. response string은 아래와 같다.
+
+| Response String                  | 설명                                                 |
+| -------------------------------- | ---------------------------------------------------- |
+| OK                               | 성공                                                 |
+| SERVER_ERROR filter list is empty | 존재하는 필터가 없음                                |
+| CLIENT_ERROR invalid parameters  | 인자로 입력한 인덱스가 유효하지 않거나 존재하지 않음 |
+
+filter list 명령은 존재하는 필터 목록을 출력한다.
+
+```
+(3 / 10)
+0. command = add, key = 123
+1. command = , key = kvkey:12
+2. command = bop_insert, key = 
+```
+
 <a id="long-query-detect"></a>
 ## Long Query Detect 명령