Switch to Common.Logging

Author: ethanhann

docs-src/commands.md

@@ -235,22 +235,3 @@ Copyright © 2017 Ethan Hann
                       queue.
 ```
 
-## Logging
-
-Any exceptions thrown by a command will be logged provided NLog is configured to record errors. 
-The [NLog configuration](https://github.com/NLog/NLog/wiki/Tutorial#configuration) file needs to be setup with something like this: 
-
-```xml
-<?xml version="1.0" encoding="utf-8" ?>
-<nlog xmlns="http://www.nlog-project.org/schemas/NLog.xsd"
-      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
-
-    <targets>
-        <target name="logfile" xsi:type="File" fileName="inengine.log" />
-    </targets>
-
-    <rules>
-        <logger name="*" minlevel="Error" writeTo="logfile" />
-    </rules>
-</nlog>
-```

docs-src/configuration.md

@@ -1,5 +1,6 @@
 # Configuration 
 
+## InEngine Settings
 Configuration is accomplished by modifying the appsettings.json file that comes with the InEngine.NET binary distribution.
 The **-c, --configuration** argument can also be used to specify an alternate configuration file.
 
@@ -65,3 +66,30 @@ The **-c, --configuration** argument can also be used to specify an alternate co
 | RedisPort                 | integer   | Redis's port.                                                         |
 | RedisDb                   | integer   | The Redis database - 0-15                                             |
 | RedisPassword             | string    | The Redis auth password                                               |
+
+
+## Logging Settings
+
+Any exceptions thrown by a command will be logged, provided NLog is configured to log exceptions. 
+The [NLog configuration](https://github.com/NLog/NLog/wiki/Tutorial#configuration) file needs to be setup with something like this: 
+
+```xml
+<?xml version="1.0" encoding="utf-8" ?>
+<nlog xmlns="http://www.nlog-project.org/schemas/NLog.xsd"
+      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+
+    <targets>
+        <target name="logfile" xsi:type="File" fileName="inengine.log" />
+    </targets>
+
+    <rules>
+        <logger name="*" minlevel="Error" writeTo="logfile" />
+    </rules>
+</nlog>
+```
+
+InEngine.Core does not depend explicitly on NLog, but rather [Common.Logging](http://net-commons.github.io/common-logging/).
+This means that any logging framework that Common.Logging supports can be used.
+Configuring Common.Logging to use a different logging framework is out of the scope of this documentation.
+
+

docs-src/scheduling.md

@@ -235,7 +235,7 @@ namespace MyCommandPlugin
 
 ## Running the Scheduler
 
-### Manually from the CLI
+There are a [variety of ways](server) to run the scheduler. The simplest way is from the command line. 
 
 Running the scheduler from the CommandLine is useful for debugging or local development:
 
@@ -248,78 +248,3 @@ It can also be run on Mac and Linux with Mono via a shell wrapper script:
 ```bash
 ./inengine -s
 ``` 
-
-### On Windows as a Service
-
-Run the **Install.ps1** PowerShell script in the scheduler directory to install the scheduler in place. 
-The script needs to be run as an administrator. 
-The script will register the service at the location where the script is run.
-
-```bash
-ps Install.ps1
-```
-
-Simply run the **Uninstall.ps1** script with elevated permissions to remove the service.
-
-```bash
-ps Uninstall.ps1
-```
-
-### On Linux with Supervisor
-
-Supervisor is a process control system for Linux. 
-It has extensive [documentation](http://supervisord.org/index.html), but the following should be enough to get started.
-
-#### Installing Supervisor
-
-This command installs Supervisor on Ubuntu:
-
-```bash
-sudo apt-get install supervisor
-```
-
-#### Configuring Supervisor
-
-Supervisor configuration files are stored in the **/etc/supervisor/conf.d** directory. Multiple files can be created in this directory to specify different programs, or multiple instances of the same program, for Supervisor to monitor. Copy this sample config into a file called **/etc/supervisor/conf.d/inengine-scheduler.conf**. 
-
-```ini
-[program:inengine]
-process_name=%(program_name)s_%(process_num)02d
-directory=/path/to/inengine
-command=mono inengine.exe -s
-autostart=true
-autorestart=true
-user=InEngine
-numprocs=1
-redirect_stderr=true
-stdout_logfile=./scheduler.log
-```
-
-#### Starting Supervisor
-
-Whenever a configuration change happens to files in the Supervisor config files, Supervisor needs to be instructed to reload its configuration.
-
-```bash
-sudo supervisorctl reread
-sudo supervisorctl update
-```
-
-Now, simply start the scheduler workers with the **supervisorctl** program:
-
-```bash
-sudo supervisorctl start inengine:*
-```
-
-### In a Container with Docker
-
-Install [Docker](https://www.docker.com/what-docker) first, then pull the **ethanhann/inengine** image:
-
-```bash
-docker pull ethanhann/inengine:latest
-```
-
-Now run the scheduler:
-
-```bash
-docker run --rm inengine -s
-``` 

docs-src/server.md

@@ -0,0 +1,93 @@
+# The InEngine Server
+
+When run as a service, InEngine runs scheduled commands in the background and actively listens for commands to be queued.
+
+## Running the Server
+
+### In the Foreground
+
+Running the server from the CommandLine is useful for debugging or local development:
+
+```bash
+inengine.exe -s
+```
+
+It can also be run on Mac and Linux with Mono via a shell wrapper script:
+
+```bash
+./inengine -s
+``` 
+
+### On Windows as a Service
+
+Run the **Install.ps1** PowerShell script in the InEngine directory to install the InEngine as a service. 
+The script needs to be run as an administrator. 
+The script will register the service at the location where the script is run - i.e. put the files where you want them installed before running the installation script.
+
+```bash
+ps Install.ps1
+```
+
+Simply run the **Uninstall.ps1** script with elevated permissions to remove the service.
+
+```bash
+ps Uninstall.ps1
+```
+
+### On Linux with Supervisor
+
+Supervisor is a process control system for Linux. 
+It has extensive [documentation](http://supervisord.org/index.html), but the following should be enough to get started.
+
+#### Installing Supervisor
+
+This command installs Supervisor on Ubuntu:
+
+```bash
+sudo apt-get install supervisor
+```
+
+#### Configuring Supervisor
+
+Supervisor configuration files are stored in the **/etc/supervisor/conf.d** directory. Multiple files can be created in this directory to specify different programs, or multiple instances of the same program, for Supervisor to monitor. Copy this sample config into a file called **/etc/supervisor/conf.d/inengine-scheduler.conf**. 
+
+```ini
+[program:inengine]
+process_name=%(program_name)s_%(process_num)02d
+directory=/path/to/inengine
+command=mono inengine.exe -s
+autostart=true
+autorestart=true
+user=InEngine
+numprocs=1
+redirect_stderr=true
+stdout_logfile=./scheduler.log
+```
+
+#### Starting Supervisor
+
+Whenever a configuration change happens to files in the Supervisor config files, Supervisor needs to be instructed to reload its configuration.
+
+```bash
+sudo supervisorctl reread
+sudo supervisorctl update
+```
+
+Now, simply start the server workers with the **supervisorctl** program:
+
+```bash
+sudo supervisorctl start inengine:*
+```
+
+### In a Container with Docker
+
+Install [Docker](https://www.docker.com/what-docker) first, then pull the **ethanhann/inengine** image:
+
+```bash
+docker pull ethanhann/inengine:latest
+```
+
+Now run the InEngine in server mode:
+
+```bash
+docker run --rm inengine -s

mkdocs.yml

@@ -16,6 +16,7 @@ pages:
   - scheduling.md
   - queuing.md
   - configuration.md
+  - server.md
 
 extra_css:
     - css/style.css

src/InEngine.Core/InEngine.Core.csproj

@@ -38,7 +38,6 @@
     <Folder Include="Queuing\Message\" />
     <Folder Include="Scheduling\LifeCycle\" />
     <Folder Include="LifeCycle\" />
-    <Folder Include="Logging\" />
   </ItemGroup>
   <ItemGroup>
     <Reference Include="System.ComponentModel.DataAnnotations" />

src/InEngine.Core/Logging/ILog.cs

@@ -3,15 +3,15 @@
 using System.IO;
 using System.Linq;
 using System.Threading;
+using Common.Logging;
 using InEngine.Core.Exceptions;
-using InEngine.Core.Logging;
 using InEngine.Core.Queuing.Message;
 
 namespace InEngine.Core.Queuing.Clients
 {
     public class FileClient : IQueueClient
     {
-        public ILog Log { get; set; } = new Log();
+        public ILog Log { get; set; } = LogManager.GetLogger<FileClient>();
         public int Id { get; set; } = 0;
         public string QueueBaseName { get; set; }
         public string QueueName { get; set; }

src/InEngine.Core/Logging/Log.cs

@@ -3,16 +3,16 @@
 using System.Linq;
 using System.Threading;
 using System.Threading.Tasks;
+using Common.Logging;
 using InEngine.Core.Exceptions;
-using InEngine.Core.Logging;
 using InEngine.Core.Queuing.Message;
 using StackExchange.Redis;
 
 namespace InEngine.Core.Queuing.Clients
 {
     public class RedisClient : IQueueClient
     {
-        public ILog Log { get; set; } = new Log();
+        public ILog Log { get; set; } = LogManager.GetLogger<RedisClient>();
         public int Id { get; set; } = 0;
         public string QueueBaseName { get; set; } = "InEngineQueue";
         public string QueueName { get; set; } = "Primary";