Fix #6 add api_logger

Author: thomasp85

NAMESPACE

@@ -65,6 +65,7 @@ export(api_get)
 export(api_get_header)
 export(api_head)
 export(api_head_header)
+export(api_logger)
 export(api_message)
 export(api_off)
 export(api_on)
@@ -83,6 +84,8 @@ export(api_statics)
 export(api_stop)
 export(api_trace)
 export(api_trace_header)
+export(combined_log_format)
+export(common_log_format)
 export(create_server_yml)
 export(device_formatter)
 export(format_bmp)
@@ -106,6 +109,11 @@ export(format_yaml)
 export(get_parsers)
 export(get_serializers)
 export(is_plumber_api)
+export(logger_console)
+export(logger_file)
+export(logger_logger)
+export(logger_null)
+export(logger_switch)
 export(parse_csv)
 export(parse_feather)
 export(parse_geojson)
@@ -126,6 +134,13 @@ import(rlang)
 importFrom(R6,R6Class)
 importFrom(base64enc,base64decode)
 importFrom(fiery,Fire)
+importFrom(fiery,combined_log_format)
+importFrom(fiery,common_log_format)
+importFrom(fiery,logger_console)
+importFrom(fiery,logger_file)
+importFrom(fiery,logger_logger)
+importFrom(fiery,logger_null)
+importFrom(fiery,logger_switch)
 importFrom(jsonlite,write_json)
 importFrom(ragg,agg_jpeg)
 importFrom(ragg,agg_png)

R/Plumber.R

@@ -111,8 +111,6 @@ Plumber <- R6Class(
 
       check_environment(env)
       private$PARENT_ENV <- env
-
-      #self$set_logger(fiery::logger_console())
     },
     #' @description Human readable description of the api object
     #' @param ... ignored

R/api_logger.R

@@ -0,0 +1,62 @@
+#' Set logging function and access log format for the API
+#'
+#' Plumber has a build-in logging facility that takes care of logging any
+#' conditions that are caught, as well as access logs. Further it is possible to
+#' log custom messages using the `log()` method on the api object. However, the
+#' actual logging is handled by a customizable function that can be set. You can
+#' read more about the logging infrastructure in the
+#' [fiery documentation][fiery::loggers]. plumber2 reexports the loggers
+#' provided by fiery so they are immediately available to the user.
+#'
+#' @param api A plumber2 api object to set the logger on
+#' @param logger A logger function. If `NULL` then the current logger is kept
+#' @param access_log_format A glue string giving the format for the access logs.
+#' plumber2 (through fiery) provides the predefined `common_log_format` and
+#' `combined_log_format`, but you can easily create your own. See
+#' [fiery::loggers] for which variables the glue string has access to.
+#' @inheritParams fiery::loggers
+#'
+#' @export
+#'
+api_logger <- function(api, logger = NULL, access_log_format = NULL) {
+  if (!is.null(logger)) {
+    check_function(logger)
+    api$set_logger(logger)
+  }
+  if (!is.null(access_log_format)) {
+    check_string(access_log_format)
+    api$access_log_format <- access_log_format
+  }
+  api
+}
+
+#' @rdname api_logger
+#' @export
+#' @importFrom fiery logger_null
+fiery::logger_null
+#' @rdname api_logger
+#' @export
+#' @importFrom fiery logger_console
+fiery::logger_console
+#' @rdname api_logger
+#' @export
+#' @importFrom fiery logger_file
+fiery::logger_file
+#' @rdname api_logger
+#' @export
+#' @importFrom fiery logger_logger
+fiery::logger_logger
+#' @rdname api_logger
+#' @export
+#' @importFrom fiery logger_switch
+fiery::logger_switch
+#' @rdname api_logger
+#' @export
+#' @importFrom fiery common_log_format
+#' @format NULL
+fiery::common_log_format
+#' @rdname api_logger
+#' @export
+#' @importFrom fiery combined_log_format
+#' @format NULL
+fiery::combined_log_format

_pkgdown.yml

@@ -55,6 +55,7 @@ reference:
   - title: "Advanced"
     contents:
       - Plumber
+      - api_logger
       - api_doc_add
       - api_on
       - api_session_cookie