Added quicstart guide.

Updated to 1.0.0.2 RapidRegex
This commit is contained in:
Eric Fontana
2014-08-01 08:27:05 -04:00
parent 2d90627fb8
commit af7e240c3d
14 changed files with 129 additions and 12 deletions

34
Packages.dgml Normal file
View File

@@ -0,0 +1,34 @@
<?xml version="1.0" encoding="utf-8"?>
<DirectedGraph GraphDirection="LeftToRight" xmlns="http://schemas.microsoft.com/vs/2009/dgml">
<Nodes>
<Node Id="TimberWinR.UnitTests" Label="TimberWinR.UnitTests" Category="Project" />
<Node Id="Newtonsoft.Json 6.0.3" Label="Newtonsoft.Json 6.0.3" Category="Package" />
<Node Id="NUnit 2.6.3" Label="NUnit 2.6.3" Category="Package" />
<Node Id="TimberWinR.ServiceHost" Label="TimberWinR.ServiceHost" Category="Project" />
<Node Id="RapidRegex.Core 1.0.0.0" Label="RapidRegex.Core 1.0.0.0" Category="Package" />
<Node Id="Topshelf 3.1.3" Label="Topshelf 3.1.3" Category="Package" />
<Node Id="TimberWinR" Label="TimberWinR" Category="Project" />
<Node Id="csredis 1.4.7.1" Label="csredis 1.4.7.1" Category="Package" />
<Node Id="Newtonsoft.Json 6.0.3" Label="Newtonsoft.Json 6.0.3" Category="Package" />
<Node Id="NLog 3.1.0.0" Label="NLog 3.1.0.0" Category="Package" />
</Nodes>
<Links>
<Link Source="TimberWinR.UnitTests" Target="Newtonsoft.Json 6.0.3" Category="Installed Package" />
<Link Source="TimberWinR.UnitTests" Target="NUnit 2.6.3" Category="Installed Package" />
<Link Source="TimberWinR.ServiceHost" Target="RapidRegex.Core 1.0.0.0" Category="Installed Package" />
<Link Source="TimberWinR.ServiceHost" Target="Topshelf 3.1.3" Category="Installed Package" />
<Link Source="TimberWinR" Target="csredis 1.4.7.1" Category="Installed Package" />
<Link Source="TimberWinR" Target="Newtonsoft.Json 6.0.3" Category="Installed Package" />
<Link Source="TimberWinR" Target="NLog 3.1.0.0" Category="Installed Package" />
</Links>
<Categories>
<Category Id="Project" />
<Category Id="Package" />
</Categories>
<Styles>
<Style TargetType="Node" GroupLabel="Project" ValueLabel="True">
<Condition Expression="HasCategory('Project')" />
<Setter Property="Background" Value="Blue" />
</Style>
</Styles>
</DirectedGraph>

View File

@@ -128,4 +128,28 @@ Options:
Default is -configFile:default.json
```
### Quickstart Guide
If you really just want to try it out, grab the binary distribution, extract the .zip file
into a directory, e.g. C:\TimberWinR
Grab the [JSON example file](https://github.com/efontana/TimberWinR/blob/master/TimberWinR.ServiceHost/default.json) and place it into C:\TimberWinR\default.json.
Edit the default.json file and change the Redis instance to match yours, replace 'tstlexiceapp006.vistaprint.svc' with the IP or DNS name
of the machine running redis. Fire up the collector, enable the verbose debugging to see some Windows Events.
```
TimberWinR.ServiceHost.Exe -configFile:default.json -logLevel:Debug
```
You should see
To run it as a service
```
TimberWinR.ServiceHost.exe install --autostart
TimberWinR.ServiceHost.exe start
```

View File

@@ -33,7 +33,7 @@
</PropertyGroup>
<ItemGroup>
<Reference Include="RapidRegex.Core">
<HintPath>..\packages\RapidRegex.Core.1.0.0.0\lib\net40\RapidRegex.Core.dll</HintPath>
<HintPath>..\packages\RapidRegex.Core.1.0.0.2\lib\net40\RapidRegex.Core.dll</HintPath>
</Reference>
<Reference Include="System" />
<Reference Include="System.Core" />
@@ -56,7 +56,13 @@
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
</Content>
<None Include="binaries\TimberWinR-1.0.0.0.zip" />
<None Include="packages.config" />
<Content Include="default.json">
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
</Content>
<None Include="packages.config">
<SubType>Designer</SubType>
</None>
<None Include="TimberWinR.ServiceHost.nuspec" />
</ItemGroup>
<ItemGroup>
<ProjectReference Include="..\TimberWinR\TimberWinR.csproj">

View File

@@ -0,0 +1,23 @@
<?xml version="1.0"?>
<package >
<metadata>
<id>TimberWinR.ServiceHost</id>
<version>$version$</version>
<title>TimberWinR.ServiceHost</title>
<authors>efontana</authors>
<owners>efontana</owners>
<licenseUrl>http://LICENSE_URL_HERE_OR_DELETE_THIS_LINE</licenseUrl>
<projectUrl>http://PROJECT_URL_HERE_OR_DELETE_THIS_LINE</projectUrl>
<iconUrl>http://ICON_URL_HERE_OR_DELETE_THIS_LINE</iconUrl>
<requireLicenseAcceptance>false</requireLicenseAcceptance>
<description>TimberWinR Service</description>
<releaseNotes>Summary of changes made in this release of the package.</releaseNotes>
<copyright>Copyright 2014</copyright>
<tags>Tag1 Tag2</tags>
<dependencies>
<dependency id="csredis" version="1.4.7.1" />
<dependency id="Newtonsoft.Json" version="6.0.3" />
<dependency id="NLog" version="3.1.0.0" />
</dependencies>
</metadata>
</package>

View File

@@ -0,0 +1,30 @@
{
"TimberWinR": {
"Inputs": {
"WindowsEvents": [
{
"source": "System,Application",
"binaryFormat": "PRINT",
"resolveSIDS": true
}
],
"Tcp": [
{
"_comment": "Output from NLog",
"port": 5140
}
]
},
"Outputs": {
"Redis": [
{
"_comment": "Change the host to your Redis instance",
"port": 6379,
"host": [
"tstlexiceapp006.vistaprint.svc"
]
}
]
}
}
}

View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<packages>
<package id="RapidRegex.Core" version="1.0.0.0" targetFramework="net45" />
<package id="RapidRegex.Core" version="1.0.0.2" targetFramework="net45" />
<package id="Topshelf" version="3.1.3" targetFramework="net45" />
</packages>

View File

@@ -55,15 +55,15 @@ namespace TimberWinR
LogManager.GlobalThreshold = LogLevel.FromString(logLevel);
FileInfo fi = new FileInfo(jsonConfigFile);
var fi = new FileInfo(jsonConfigFile);
if (!fi.Exists)
throw new FileNotFoundException("Missing config file", jsonConfigFile);
LogManager.GetCurrentClassLogger().Info("Initialized, Reading Config: {0}", fi.FullName);
LogManager.GetCurrentClassLogger().Info("Log Directory {0}", logfileDir);
LogManager.GetCurrentClassLogger().Info("Logging Level: {0}", LogManager.GlobalThreshold);
if (!fi.Exists)
throw new FileNotFoundException("Missing config file", jsonConfigFile);
// Read the Configuration file
Config = Configuration.FromFile(jsonConfigFile);

View File

@@ -46,9 +46,8 @@
<Reference Include="NLog">
<HintPath>..\packages\NLog.3.1.0.0\lib\net40\NLog.dll</HintPath>
</Reference>
<Reference Include="RapidRegex.Core, Version=1.0.0.0, Culture=neutral, processorArchitecture=MSIL">
<SpecificVersion>False</SpecificVersion>
<HintPath>..\packages\RapidRegex.Core.1.0.0.0\lib\net40\RapidRegex.Core.dll</HintPath>
<Reference Include="RapidRegex.Core">
<HintPath>..\packages\RapidRegex.Core.1.0.0.2\lib\net40\RapidRegex.Core.dll</HintPath>
</Reference>
<Reference Include="System" />
<Reference Include="System.Core" />

View File

@@ -14,6 +14,7 @@
<dependency id="csredis" version="1.4.7.1" />
<dependency id="Newtonsoft.Json" version="6.0.3" />
<dependency id="NLog" version="3.1.0.0" />
<dependency id="RapidRegex.Core" version="1.0.0.2" />
</dependencies>
</metadata>
<files>

View File

@@ -3,5 +3,5 @@
<package id="csredis" version="1.4.7.1" targetFramework="net40" />
<package id="Newtonsoft.Json" version="6.0.3" targetFramework="net40" />
<package id="NLog" version="3.1.0.0" targetFramework="net40" />
<package id="RapidRegex.Core" version="1.0.0.0" targetFramework="net40" />
<package id="RapidRegex.Core" version="1.0.0.2" targetFramework="net40" />
</packages>

Binary file not shown.