Merge pull request #2 from tanmaykm/tan/misc

add connector for LogRoler.RollingFileWriterTee

Author: tanmaykm

LICENSE.md

@@ -1,6 +1,6 @@
 The LogCompose.jl package is licensed under the MIT "Expat" License:
 
-> Copyright (c) 2019-2020: Tanmay Mohapatra, Julia Computing
+> Copyright (c) 2020-2021: Tanmay Mohapatra, Julia Computing
 >
 > Permission is hereby granted, free of charge, to any person obtaining
 > a copy of this software and associated documentation files (the

Project.toml

@@ -4,7 +4,7 @@ keywords = ["configure", "compose", "logging", "logger"]
 authors = ["tan <[email protected]>"]
 license = "MIT"
 desc = "Compose loggers and logger ensembles declaratively using configuration files"
-version = "0.1.0"
+version = "0.1.1"
 
 [deps]
 Pkg = "44cfe95a-1eb2-52ea-b672-e2afdf69b78f"
@@ -18,7 +18,7 @@ LoggingExtras = "e6f89c97-d47a-5376-807f-9c37f3926c36"
 julia = "1"
 SyslogLogging = "0.1"
 LoggingExtras = "0.4"
-LogRoller = "0.2"
+LogRoller = "0.3"
 
 [extras]
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"

README.md

@@ -95,6 +95,7 @@ LogCompose supports the following types of loggers at the moment:
 - Logging.SimpleLogger
 - LoggingExtras.TeeLogger
 - LogRoller.RollingLogger
+- LogRoler.RollingFileWriterTee
 - SyslogLogging.SyslogLogger
 
 ### Plugging in other Loggers

src/compose.jl

@@ -54,3 +54,4 @@ end
 logcompose(::Type{T}, config::Dict{String,Any}, logger_config::Dict{String,Any}) where {T} = @error("logcompose not implemented for type $T")
 
 log_min_level(logger_config::Dict{String,Any}, default::String="Info") = getproperty(Logging, Symbol(get(logger_config, "min_level", default)))
+log_assumed_level(logger_config::Dict{String,Any}, default::String="Info") = getproperty(Logging, Symbol(get(logger_config, "assumed_level", default)))

src/connectors.jl

@@ -1,7 +1,7 @@
 module Connectors
 
 using ..LogCompose
-import ..LogCompose: logcompose, log_min_level
+import ..LogCompose: logcompose, log_min_level, log_assumed_level
 
 using Logging, LogRoller, SyslogLogging, LoggingExtras, Sockets
 
@@ -40,10 +40,10 @@ function logcompose(::Type{SyslogLogging.SyslogLogger}, config::Dict{String,Any}
     if (server_type == "tcp") || (server_type == "udp")
         kwargs[:tcp] = (server_type == "tcp")
         if haskey(logger_config, "server_host")
-            kwargs[:host] = Sockets.IPv4(logger_config["server_host"])
+            kwargs[:host] = logger_config["server_host"]
         end
         if haskey(logger_config, "server_port")
-            kwargs[:port] = parse(Int, logger_config["server_port"])
+            kwargs[:port] = logger_config["server_port"]
         end
     end
     SyslogLogging.SyslogLogger(ident, level; kwargs...)
@@ -61,6 +61,18 @@ function logcompose(::Type{LogRoller.RollingLogger}, config::Dict{String,Any}, l
     LogRoller.RollingLogger(filename, sizelimit, nfiles, level; timestamp_identifier=timestamp_identifier)
 end
 
+function logcompose(::typeof(LogRoller.RollingFileWriterTee), config::Dict{String,Any}, logger_config::Dict{String,Any})
+    filename = String(strip(logger_config["filename"]))
+    @assert !isempty(filename)
+
+    level = log_assumed_level(logger_config, "Info")
+    sizelimit = get(logger_config, "sizelimit", 10240000)
+    nfiles = get(logger_config, "nfiles", 5)
+    destination_name = logger_config["destination"]
+    destination = LogCompose.logger(config, destination_name)
+    LogRoller.RollingFileWriterTee(filename, sizelimit, nfiles, destination, level)
+end
+
 function logcompose(::Type{LoggingExtras.TeeLogger}, config::Dict{String,Any}, logger_config::Dict{String,Any})
     destinations = [LogCompose.logger(config, dest) for dest in logger_config["destinations"]]
     LoggingExtras.TeeLogger(destinations...)

test/runtests.jl

@@ -4,7 +4,9 @@ function test()
     config = joinpath(@__DIR__, "testapp.toml")
     default_logfile = "/tmp/default.log"
     rotated_logfile = "/tmp/testapp.log"
+    rotated_tee_logfile = "/tmp/testapptee.log"
     rm(rotated_logfile; force=true)
+    rm(rotated_tee_logfile; force=true)
     rm(default_logfile; force=true)
 
     let logger = LogCompose.logger(config, "default"; section="loggers")
@@ -34,12 +36,22 @@ function test()
         end
     end
 
+    let logger = LogCompose.logger(config, "testapptee"; section="loggers")
+        julia = joinpath(Sys.BINDIR, "julia")
+        cmd = pipeline(`$julia -e 'println("testteefilewriter"); flush(stdout)'`; stdout=logger, stderr=logger)
+        run(cmd)
+    end
+
     log_file_contents = readlines(default_logfile)
     @test findfirst("testdefault", log_file_contents[1]) !== nothing
 
     log_file_contents = readlines(rotated_logfile)
     @test findfirst("testroller", log_file_contents[1]) !== nothing
     @test findfirst("testtee", log_file_contents[3]) !== nothing
+    @test findfirst("testteefilewriter", log_file_contents[5]) !== nothing
+
+    log_file_contents = readlines(rotated_tee_logfile)
+    @test "testteefilewriter" == log_file_contents[1]
 end
 
 test()

test/testapp.toml

@@ -39,3 +39,11 @@ log_name = "testapp"
 [loggers.testapp]
 type = "LoggingExtras.TeeLogger"
 destinations = ["file.testapp", "syslog.testapp"]
+
+[loggers.testapptee]
+type = "LogRoller.RollingFileWriterTee"
+destination = "file.testapp"
+filename = "/tmp/testapptee.log"
+# sizelimit = 10240000
+# nfiles = 5
+# assumed_level = "Debug"                 # Debug, Info (default) or Error