Add support for excluded_fields to Layout, and exclude rawMsg by default from LayotJson

Author: s-fleck

NEWS.md

@@ -14,8 +14,8 @@
 
 * Support transformers for `LoggerGlue` (see `?glue::glue`) (#51)
 
-* Add support for `excluded_properties` to LayoutJson (and exclude rawMsg by
-  default)
+* Add support for `excluded_fields` to `Layout`, and exclude rawMsg by
+  default from `LayotJson`
 
 * updated README
 

R/Layout.R

@@ -42,7 +42,29 @@ Layout <- R6::R6Class(
       toString(event)
     },
 
-    toString = function() fmt_class(class(self)[[1]])
+    toString = function() fmt_class(class(self)[[1]]),
+
+    # . . setters -----------------------------------------------------------------
+    set_excluded_fields = function(x){
+      assert(is.null(x) || is.character(x))
+      private$.excluded_fields <- x
+      invisible(self)
+    }
+  ),
+
+
+  # . . active --------------------------------------------------------------
+  active = list(
+    #' @field excluded_fields fields to exclude from the final log
+    excluded_fields = function() {
+      get(".excluded_fields", private)
+    }
+  ),
+
+
+  # . . private -------------------------------------------------------------
+  private = list(
+    .excluded_fields = NULL
   )
 )
 
@@ -86,12 +108,14 @@ LayoutFormat <- R6::R6Class(
       fmt = "%L [%t] %m %j",
       timestamp_fmt = "%Y-%m-%d %H:%M:%OS3",
       colors = NULL,
-      pad_levels = "right"
+      pad_levels = "right",
+      excluded_fields = NULL
     ){
       self$set_fmt(fmt)
       self$set_timestamp_fmt(timestamp_fmt)
       self$set_colors(colors)
       self$set_pad_levels(pad_levels)
+      self$set_excluded_fields(excluded_fields)
     },
 
     #' @description Format a LogEvent
@@ -104,7 +128,8 @@ LayoutFormat <- R6::R6Class(
         fmt = private$.fmt,
         timestamp_fmt = private$.timestamp_fmt,
         colors = private$.colors,
-        pad_levels = private$.pad_levels
+        pad_levels = private$.pad_levels,
+        excluded_fields = private$.excluded_fields
       )
     },
 
@@ -335,16 +360,16 @@ LayoutJson <- R6::R6Class(
     initialize = function(
       toJSON_args = list(auto_unbox = TRUE),
       timestamp_fmt = NULL,
-      excluded_properties = "rawMsg"
+      excluded_fields = "rawMsg"
     ){
       self$set_toJSON_args(toJSON_args)
       self$set_timestamp_fmt(timestamp_fmt)
-      self$set_excluded_properties(excluded_properties)
+      self$set_excluded_fields(excluded_fields)
     },
 
     format_event = function(event) {
       vals <- get("values", event)
-      vals <- vals[!names(vals) %in% self$excluded_properties]
+      vals <- vals[!names(vals) %in% self$excluded_fields]
       fmt  <- get("timestamp_fmt", self)
 
       if (!is.null(fmt)){
@@ -384,12 +409,6 @@ LayoutJson <- R6::R6Class(
       invisible(self)
     },
 
-    set_excluded_properties = function(x){
-      assert(is.null(x) || is.character(x))
-      private$.excluded_properties <- x
-      invisible(self)
-    },
-
     #  . . methods ----------------------------------------------------------------
 
     toString = function() {
@@ -435,20 +454,13 @@ LayoutJson <- R6::R6Class(
     #' @field timestamp_fmt Used by  `$format_event()` to format timestamps.
     timestamp_fmt = function() {
       get(".timestamp_fmt", private)
-    },
-
-    #' @field excluded_properties Used by  `$format_event()` to exclude selected
-    #' properties before serialization
-    excluded_properties = function() {
-      get(".excluded_properties", private)
     }
   ),
 
   # . . private --------------------------------------------------------------
   private = list(
     .toJSON_args = NULL,
-    .timestamp_fmt = NULL,
-    .excluded_properties = NULL
+    .timestamp_fmt = NULL
   )
 )
 

R/LogEvent.R

@@ -401,6 +401,7 @@ format.LogEvent <- function(
   colors = NULL,
   log_levels = getOption("lgr.log_levels"),
   pad_levels = "right",
+  excluded_fields = NULL,
   ...
 ){
   stopifnot(
@@ -454,8 +455,8 @@ format.LogEvent <- function(
       "%c" = get("caller", envir = x),
       "%g" = get("logger", envir = x),
       "%p" = Sys.getpid(),
-      "%f" = format_custom_fields(get_custom_fields(x), color = length(colors)),
-      "%j" = format_custom_fields_json(get_custom_fields(x)),
+      "%f" = format_custom_fields(get_custom_fields(x, excluded_fields), color = length(colors)),
+      "%j" = format_custom_fields_json(get_custom_fields(x, excluded_fields)),
       tokens[[i]]
     )
   }
@@ -515,8 +516,8 @@ do_box_if <- function(x, predicate, except, boxer = list){
 
 
 
-get_custom_fields <- function(x){
-  x$values[!names(x$values) %in% DEFAULT_FIELDS]
+get_custom_fields <- function(x, excluded_fields = NULL){
+  x$values[!names(x$values) %in% c(DEFAULT_FIELDS, excluded_fields)]
 }
 
 

tests/testthat/test_Layout.R

@@ -80,8 +80,8 @@ test_that("LayoutJson works as expected", {
 })
 
 
-test_that("LayoutJson `exclude_properties` works as expected", {
-  lo <- LayoutJson$new(excluded_properties = NULL)
+test_that("LayoutJson `excluded_fields` works as expected", {
+  lo <- LayoutJson$new(excluded_fields = NULL)
 
   x <- tevent$clone()
   x$foo <- "bar"

tests/testthat/test_read_json_log.R

@@ -20,7 +20,7 @@ test_that("read_json_lines() works as expected", {
 
   tres <- read_json_lines(tf)
 
-  expect_identical(names(tres), c("level", "timestamp", "logger", "caller", "msg", "rawMsg"))
+  expect_identical(names(tres), c("level", "timestamp", "logger", "caller", "msg"))
   expect_true(all(tres$level == seq(100, 600, by = 100)))
   file.remove(tf)
 })