Skip to content

out_syslog: Add nested key support. #2516

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

out_syslog: Add nested key support. #2516

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a414ac8
out_syslog: Add nested key support.
pascapascapascapasca Aug 26, 2020
6ad9d7f
Merge remote-tracking branch 'upstream/master' into out_syslog_nested…
pascapascapascapasca Sep 21, 2020
b4006b0
Merge remote-tracking branch 'upstream/master' into out_syslog_nested…
pascapascapascapasca Nov 11, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
142 changes: 133 additions & 9 deletions plugins/out_syslog/syslog.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,13 @@ static char rfc5424_sp_name[256] = {
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0
};

struct flb_nested_kv_list_entry {
flb_sds_t key_full_str;
msgpack_object *key;
msgpack_object *val;
struct mk_list _head;
};

static flb_sds_t syslog_rfc5424(flb_sds_t *s, struct flb_time *tms,
struct syslog_msg *msg)
{
Expand Down Expand Up @@ -356,6 +363,58 @@ static flb_sds_t syslog_rfc3164 (flb_sds_t *s, struct flb_time *tms,
return *s;
}

/* Recurses through the map objects in val and builds key sequences */
static int extract_nested_kv(struct flb_syslog *ctx, flb_sds_t key_str,
msgpack_object *key, msgpack_object *val, struct mk_list *kvs)
{
int i;
int loop_val;
struct flb_nested_kv_list_entry *e;
flb_sds_t tmp_key_str;

if (val == NULL) {
flb_plg_error(ctx->ins, "nested value empty");
return -1;
}

/* Add to list */
e = flb_malloc(sizeof(struct flb_nested_kv_list_entry));
if (!e) {
flb_errno();
return -1;
}

e->key_full_str = key_str;
e->key = key;
e->val = val;
mk_list_add(&e->_head, kvs);

if (val->type == MSGPACK_OBJECT_MAP){
/* Iterate thtough map value */
loop_val = val->via.map.size;
if (loop_val > 0) {
msgpack_object_kv *p = val->via.map.ptr;

for (i = 0; i < loop_val; i++) {
msgpack_object *k = &p[i].key;
msgpack_object *v = &p[i].val;

if (k->type == MSGPACK_OBJECT_STR){
/* Concatenate new key using separator */
tmp_key_str = flb_sds_create(key_str);
tmp_key_str = flb_sds_cat(tmp_key_str, ctx->nested_key_separator, flb_sds_len(ctx->nested_key_separator));
tmp_key_str = flb_sds_cat(tmp_key_str, k->via.str.ptr, k->via.str.size);

/* Recurse */
extract_nested_kv(ctx, tmp_key_str, k, v, kvs);
}
}
}
}

return 0;
}

static flb_sds_t msgpack_to_sd(flb_sds_t *s, const char *sd, int sd_len,
msgpack_object *o)
{
Expand Down Expand Up @@ -504,7 +563,20 @@ static int msgpack_to_syslog(struct flb_syslog *ctx, msgpack_object *o,
{
int i;
int loop;
int ret = 0;

char temp[48] = {0};
const char *key = NULL;
int key_len;
const char *val = NULL;
int val_len;

struct mk_list kvs;
struct mk_list *head;
struct mk_list *tmp;
struct flb_nested_kv_list_entry *e = NULL;

flb_sds_t key_str;
struct flb_config_map_val *mv;

if (o == NULL) {
Expand All @@ -515,23 +587,57 @@ static int msgpack_to_syslog(struct flb_syslog *ctx, msgpack_object *o,
if (loop != 0) {
msgpack_object_kv *p = o->via.map.ptr;

for (i = 0; i < loop; i++) {
char temp[48] = {0};
const char *key = NULL;
int key_len = 0;
const char *val = NULL;
int val_len = 0;
mk_list_init(&kvs);

for (i = 0; i < loop; i++) {
msgpack_object *k = &p[i].key;
msgpack_object *v = &p[i].val;

if (k->type != MSGPACK_OBJECT_BIN && k->type != MSGPACK_OBJECT_STR){
continue;
}

if (k->type == MSGPACK_OBJECT_STR && v->type == MSGPACK_OBJECT_MAP
&& flb_sds_is_empty(ctx->nested_key_separator) == FLB_FALSE) {
/* Expand nested key-values: add to a list of {key, value, expanded key} */
key_str = flb_sds_create_len(k->via.str.ptr, k->via.str.size);

if (extract_nested_kv(ctx, key_str, k, v, &kvs) == -1) {
flb_plg_error(ctx->ins, "error in nested key/value extraction");
ret = -1;
goto cleanup_kv_list;
}
}
else {
/* Not nested - simply add to list */
e = flb_malloc(sizeof(struct flb_nested_kv_list_entry));
if (!e) {
flb_errno();
ret = -1;
goto cleanup_kv_list;
}

if (k->type == MSGPACK_OBJECT_STR) {
e->key_full_str = flb_sds_create_len(k->via.str.ptr, k->via.str.size);
}
else{
e->key_full_str = flb_sds_create("");
}
e->key = k;
e->val = v;
mk_list_add(&e->_head, &kvs);
}
}

/* Iterate through expanded key-value list to find defined syslog keys */
mk_list_foreach_safe(head, tmp, &kvs) {
e = mk_list_entry(head, struct flb_nested_kv_list_entry, _head);
msgpack_object *k = e->key;
msgpack_object *v = e->val;

if (k->type == MSGPACK_OBJECT_STR) {
key = k->via.str.ptr;
key_len = k->via.str.size;
key = e->key_full_str;
key_len = flb_sds_len(e->key_full_str);
}
else {
key = k->via.bin.ptr;
Expand Down Expand Up @@ -669,9 +775,20 @@ static int msgpack_to_syslog(struct flb_syslog *ctx, msgpack_object *o,
}
}
}

cleanup_kv_list:
/* Cleanup key-value list */
mk_list_foreach_safe(head, tmp, &kvs) {
e = mk_list_entry(head, struct flb_nested_kv_list_entry, _head);
flb_sds_destroy(e->key_full_str);
e->key = NULL;
e->val = NULL;
mk_list_del(&e->_head);
flb_free(e);
}
}

return 0;
return ret;
}

static flb_sds_t syslog_format(struct flb_syslog *ctx, msgpack_object *o,
Expand Down Expand Up @@ -939,6 +1056,13 @@ static struct flb_config_map config_map[] = {
"the size to 2048 bytes."
},

{
FLB_CONFIG_MAP_STR, "syslog_nested_key_separator", NULL,
0, FLB_TRUE, offsetof(struct flb_syslog, nested_key_separator),
"Specify the the character(s) to be used as separator for Syslog nested keys. "
"This configuration is optional."
},

{
FLB_CONFIG_MAP_STR, "syslog_severity_key", NULL,
0, FLB_TRUE, offsetof(struct flb_syslog, severity_key),
Expand Down
1 change: 1 addition & 0 deletions plugins/out_syslog/syslog_conf.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ struct flb_syslog {
flb_sds_t mode;
int format;
size_t maxsize;
flb_sds_t nested_key_separator;
flb_sds_t severity_key;
flb_sds_t facility_key;
flb_sds_t timestamp_key;
Expand Down