From: git@jeffhostetler.com
To: git@vger.kernel.org
Cc: gitster@pobox.com, peff@peff.net,
Jeff Hostetler <jeffhost@microsoft.com>
Subject: [PATCH v1 25/25] structured-logging: add config data facility
Date: Fri, 13 Jul 2018 16:56:21 +0000 [thread overview]
Message-ID: <20180713165621.52017-26-git@jeffhostetler.com> (raw)
In-Reply-To: <20180713165621.52017-1-git@jeffhostetler.com>
From: Jeff Hostetler <jeffhost@microsoft.com>
Add "config" section to "cmd_exit" event to record important
configuration settings in the log.
Add the value of "slog.detail", "slog.timers", and "slog.aux" config
settings to the log. These values control the filtering of the log.
Knowing the filter settings can help post-processors reason about
the contents of the log.
Signed-off-by: Jeff Hostetler <jeffhost@microsoft.com>
---
structured-logging.c | 132 +++++++++++++++++++++++++++++++++++++++++++++++++++
structured-logging.h | 13 +++++
2 files changed, 145 insertions(+)
diff --git a/structured-logging.c b/structured-logging.c
index 2571e79..0e3f79e 100644
--- a/structured-logging.c
+++ b/structured-logging.c
@@ -83,6 +83,20 @@ struct child_data_array {
static struct child_data_array my__child_data;
static void free_children(void);
+struct config_data {
+ char *group;
+ struct json_writer jw;
+};
+
+struct config_data_array {
+ struct config_data **array;
+ size_t nr, alloc;
+};
+
+static struct config_data_array my__config_data;
+static void format_config_data(struct json_writer *jw);
+static void free_config_data(void);
+
static uint64_t my__start_time;
static uint64_t my__exit_time;
static int my__is_config_loaded;
@@ -132,6 +146,15 @@ static int want_category(const struct category_filter *cf, const char *category)
return !!strstr(cf->categories, category);
}
+static void set_config_data_from_category(const struct category_filter *cf,
+ const char *key)
+{
+ if (cf->want == 0 || cf->want == 1)
+ slog_set_config_data_intmax(key, cf->want);
+ else
+ slog_set_config_data_string(key, cf->categories);
+}
+
/*
* Compute a new session id for the current process. Build string
* with the start time and PID of the current process and append
@@ -249,6 +272,18 @@ static void emit_exit_event(void)
struct json_writer jw = JSON_WRITER_INIT;
uint64_t atexit_time = getnanotime() / 1000;
+ /*
+ * Copy important (and non-obvious) config settings into the
+ * "config" section of the "cmd_exit" event. The values of
+ * "slog.detail", "slog.timers", and "slog.aux" are used in
+ * category want filtering, so post-processors should know the
+ * filter settings so that they can tell if an event is missing
+ * because of filtering or an error.
+ */
+ set_config_data_from_category(&my__detail_categories, "slog.detail");
+ set_config_data_from_category(&my__timer_categories, "slog.timers");
+ set_config_data_from_category(&my__aux_categories, "slog.aux");
+
/* close unterminated forms */
if (my__errors.json.len)
jw_end(&my__errors);
@@ -299,6 +334,12 @@ static void emit_exit_event(void)
}
jw_end(&jw);
+ if (my__config_data.nr) {
+ jw_object_inline_begin_object(&jw, "config");
+ format_config_data(&jw);
+ jw_end(&jw);
+ }
+
if (my__timers.nr) {
jw_object_inline_begin_object(&jw, "timers");
format_timers(&jw);
@@ -479,6 +520,7 @@ static void do_final_steps(int in_signal)
free_child_summary_data();
free_timers();
free_children();
+ free_config_data();
}
static void slog_atexit(void)
@@ -1084,4 +1126,94 @@ static void free_children(void)
my__child_data.alloc = 0;
}
+/*
+ * Split <key> into <group>.<sub_key> (for example "slog.path" into "slog" and "path")
+ * Find or insert <group> in config_data_array[].
+ *
+ * Return config_data_arary[<group>].
+ */
+static struct config_data *find_config_data(const char *key, const char **sub_key)
+{
+ struct config_data *cd;
+ char *dot;
+ size_t group_len;
+ int k;
+
+ dot = strchr(key, '.');
+ if (!dot)
+ return NULL;
+
+ *sub_key = dot + 1;
+
+ group_len = dot - key;
+
+ for (k = 0; k < my__config_data.nr; k++) {
+ cd = my__config_data.array[k];
+ if (!strncmp(key, cd->group, group_len))
+ return cd;
+ }
+
+ cd = xcalloc(1, sizeof(struct config_data));
+ cd->group = xstrndup(key, group_len);
+
+ jw_object_begin(&cd->jw, my__is_pretty);
+ /* leave per-group object unterminated for now */
+
+ ALLOC_GROW(my__config_data.array, my__config_data.nr + 1,
+ my__config_data.alloc);
+ my__config_data.array[my__config_data.nr++] = cd;
+
+ return cd;
+}
+
+void slog_set_config_data_string(const char *key, const char *value)
+{
+ const char *sub_key;
+ struct config_data *cd = find_config_data(key, &sub_key);
+
+ if (cd)
+ jw_object_string(&cd->jw, sub_key, value);
+}
+
+void slog_set_config_data_intmax(const char *key, intmax_t value)
+{
+ const char *sub_key;
+ struct config_data *cd = find_config_data(key, &sub_key);
+
+ if (cd)
+ jw_object_intmax(&cd->jw, sub_key, value);
+}
+
+static void format_config_data(struct json_writer *jw)
+{
+ int k;
+
+ for (k = 0; k < my__config_data.nr; k++) {
+ struct config_data *cd = my__config_data.array[k];
+
+ /* termminate per-group form */
+ jw_end(&cd->jw);
+
+ /* insert per-category form into containing "config" form */
+ jw_object_sub_jw(jw, cd->group, &cd->jw);
+ }
+}
+
+static void free_config_data(void)
+{
+ int k;
+
+ for (k = 0; k < my__config_data.nr; k++) {
+ struct config_data *cd = my__config_data.array[k];
+
+ jw_release(&cd->jw);
+ free(cd->group);
+ free(cd);
+ }
+
+ FREE_AND_NULL(my__config_data.array);
+ my__config_data.nr = 0;
+ my__config_data.alloc = 0;
+}
+
#endif
diff --git a/structured-logging.h b/structured-logging.h
index 7c98d33..2c90267 100644
--- a/structured-logging.h
+++ b/structured-logging.h
@@ -34,6 +34,8 @@ static inline void slog_stop_timer(int tid) { };
#define slog_aux_jw(c, k, v) do { } while (0)
#define slog_child_starting(cmd) (SLOG_UNDEFINED_CHILD_ID)
#define slog_child_ended(i, p, ec) do { } while (0)
+#define slog_set_config_data_string(k, v) do { } while (0)
+#define slog_set_config_data_intmax(k, v) do { } while (0)
#else
@@ -162,5 +164,16 @@ void slog_aux_jw(const char *category, const char *key,
int slog_child_starting(const struct child_process *cmd);
void slog_child_ended(int child_id, int child_pid, int child_exit_code);
+/*
+ * Add an important config key/value pair to the "cmd_event". Keys
+ * are assumed to be of the form <group>.<name>, such as "slog.path".
+ * The pair will appear under the "config" object in the resulting JSON
+ * as "config.<group>.<name>:<value>".
+ *
+ * This should only be used for important config settings.
+ */
+void slog_set_config_data_string(const char *key, const char *value);
+void slog_set_config_data_intmax(const char *key, intmax_t value);
+
#endif /* STRUCTURED_LOGGING */
#endif /* STRUCTURED_LOGGING_H */
--
2.9.3
next prev parent reply other threads:[~2018-07-13 16:56 UTC|newest]
Thread overview: 38+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-07-13 16:55 [PATCH v1 00/25] RFC: structured logging git
2018-07-13 16:55 ` [PATCH v1 01/25] structured-logging: design document git
2018-07-14 8:34 ` Simon Ruderich
2018-08-03 15:26 ` Ben Peart
2018-08-09 14:30 ` Jeff Hostetler
2018-08-21 4:47 ` Jonathan Nieder
2018-07-13 16:55 ` [PATCH v1 02/25] structured-logging: add STRUCTURED_LOGGING=1 to Makefile git
2018-08-21 4:49 ` Jonathan Nieder
2018-07-13 16:55 ` [PATCH v1 03/25] structured-logging: add structured logging framework git
2018-07-26 9:09 ` SZEDER Gábor
2018-07-27 12:45 ` Jeff Hostetler
2018-08-21 5:05 ` Jonathan Nieder
2018-07-13 16:56 ` [PATCH v1 04/25] structured-logging: add session-id to log events git
2018-07-13 16:56 ` [PATCH v1 05/25] structured-logging: set sub_command field for branch command git
2018-07-13 16:56 ` [PATCH v1 06/25] structured-logging: set sub_command field for checkout command git
2018-07-13 16:56 ` [PATCH v1 07/25] structured-logging: t0420 basic tests git
2018-07-13 16:56 ` [PATCH v1 08/25] structured-logging: add detail-event facility git
2018-07-13 16:56 ` [PATCH v1 09/25] structured-logging: add detail-event for lazy_init_name_hash git
2018-07-13 16:56 ` [PATCH v1 10/25] structured-logging: add timer facility git
2018-07-13 16:56 ` [PATCH v1 11/25] structured-logging: add timer around do_read_index git
2018-07-13 16:56 ` [PATCH v1 12/25] structured-logging: add timer around do_write_index git
2018-07-13 16:56 ` [PATCH v1 13/25] structured-logging: add timer around wt-status functions git
2018-07-13 16:56 ` [PATCH v1 14/25] structured-logging: add timer around preload_index git
2018-07-13 16:56 ` [PATCH v1 15/25] structured-logging: t0420 tests for timers git
2018-07-13 16:56 ` [PATCH v1 16/25] structured-logging: add aux-data facility git
2018-07-13 16:56 ` [PATCH v1 17/25] structured-logging: add aux-data for index size git
2018-07-13 16:56 ` [PATCH v1 18/25] structured-logging: add aux-data for size of sparse-checkout file git
2018-07-13 16:56 ` [PATCH v1 19/25] structured-logging: t0420 tests for aux-data git
2018-07-13 16:56 ` [PATCH v1 20/25] structured-logging: add structured logging to remote-curl git
2018-07-13 16:56 ` [PATCH v1 21/25] structured-logging: add detail-events for child processes git
2018-07-13 16:56 ` [PATCH v1 22/25] structured-logging: add child process classification git
2018-07-13 16:56 ` [PATCH v1 23/25] structured-logging: t0420 tests for child process detail events git
2018-07-13 16:56 ` [PATCH v1 24/25] structured-logging: t0420 tests for interacitve child_summary git
2018-07-13 16:56 ` git [this message]
2018-07-13 18:51 ` [PATCH v1 00/25] RFC: structured logging David Lang
2018-07-16 13:29 ` Jeff Hostetler
2018-08-28 17:38 ` Junio C Hamano
2018-08-28 18:47 ` Jeff Hostetler
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20180713165621.52017-26-git@jeffhostetler.com \
--to=git@jeffhostetler.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=jeffhost@microsoft.com \
--cc=peff@peff.net \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).