define example logging hooks in R

nfultz · Aug 22, 2018 · 4409da0 · 4409da0
1 parent 5ae9a7f
commit 4409da0
Show file tree

Hide file tree

Showing 7 changed files with 32 additions and 9 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -10,7 +10,8 @@ Encoding: UTF-8
 LazyData: true
 Imports:
     Rcpp (>= 0.12.5),
-    RProtoBuf
+    RProtoBuf,
+    futile.logger
 Suggests:
     testthat,
     processx

diff --git a/NAMESPACE b/NAMESPACE
@@ -2,6 +2,7 @@
 
 export(grpc_client)
 export(grpc_debug)
+export(grpc_default_hooks)
 export(grpc_version)
 export(newResponse)
 export(read_services)
@@ -11,6 +12,9 @@ importFrom(RProtoBuf,new)
 importFrom(RProtoBuf,read)
 importFrom(RProtoBuf,readProtoFiles)
 importFrom(RProtoBuf,serialize)
+importFrom(futile.logger,flog.debug)
+importFrom(futile.logger,flog.info)
+importFrom(futile.logger,flog.trace)
 importFrom(methods,selectMethod)
 importFrom(utils,assignInMyNamespace)
 useDynLib(grpc)
diff --git a/R/server.R b/R/server.R
@@ -8,9 +8,8 @@
 #' @importFrom RProtoBuf P serialize read
 #' @useDynLib grpc
 #' @export
-start_server <- function(impl, channel, hooks = list(
-  bind = function(params) cat('gRPC service will listen on port', params$port, '\n'),
-  run = function(params) cat('gRPC service started on port', params$port, '\n'))) {
+#' @seealso \code{\link{grpc_default_hooks}}
+start_server <- function(impl, channel, hooks = grpc_default_hooks()) {
 
   server_functions <- lapply(impl, function(fn){
     descriptor <- P(fn[["RequestType"]]$proto)

diff --git a/README.md b/README.md
@@ -25,7 +25,11 @@ There are runnable examples in the `demo/` folder.
 To start a HelloWorld server:
 
     R -e 'demo("helloserver", "grpc")'
-
+
+Or with much more detailed logging:
+
+    R -e 'library(futile.logger); flog.threshold(TRACE); demo("helloserver", "grpc")'
+
 To run a client against a running HelloWorld server:
 
     R -e 'demo("helloclient", "grpc")'

diff --git a/man/grpc_default_hooks.Rd b/man/grpc_default_hooks.Rd
diff --git a/man/start_server.Rd b/man/start_server.Rd
diff --git a/src/server.cpp b/src/server.cpp
@@ -296,7 +296,7 @@ List run(List target, CharacterVector hoststring, List hooks) {
 
   //shutdown
   RGRPC_LOG("Shutting down\n");
-  runFunctionIfProvided(hooks, "preshutdown", params);
+  runFunctionIfProvided(hooks, "shutdown", params);
   grpc_server_shutdown_and_notify(server, queue, 0 /* tag */);
   grpc_server_cancel_all_calls(server);
   grpc_completion_queue_next(queue, gpr_inf_future(GPR_CLOCK_REALTIME), NULL);