Initial Commit

kentcooper · Sep 12, 2017 · d8aa2d1 · d8aa2d1
1 parent aec9fbf
commit d8aa2d1
Show file tree

Hide file tree

Showing 15 changed files with 1,101 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,242 @@
+## Ignore Visual Studio temporary files, build results, and
+## files generated by popular Visual Studio add-ons.
+
+# User-specific files
+*.suo
+*.user
+*.userosscache
+*.sln.docstates
+
+# User-specific files (MonoDevelop/Xamarin Studio)
+*.userprefs
+
+# Build results
+[Dd]ebug/
+[Dd]ebugPublic/
+[Rr]elease/
+[Rr]eleases/
+[Xx]64/
+[Xx]86/
+[Bb]uild/
+bld/
+[Bb]in/
+[Oo]bj/
+
+# Visual Studio 2015 cache/options directory
+.vs/
+# Uncomment if you have tasks that create the project's static files in wwwroot
+#wwwroot/
+
+# MSTest test Results
+[Tt]est[Rr]esult*/
+[Bb]uild[Ll]og.*
+
+# NUNIT
+*.VisualState.xml
+TestResult.xml
+
+# Build Results of an ATL Project
+[Dd]ebugPS/
+[Rr]eleasePS/
+dlldata.c
+
+# DNX
+project.lock.json
+artifacts/
+
+*_i.c
+*_p.c
+*_i.h
+*.ilk
+*.meta
+*.obj
+*.pch
+*.pdb
+*.pgc
+*.pgd
+*.rsp
+*.sbr
+*.tlb
+*.tli
+*.tlh
+*.tmp
+*.tmp_proj
+*.log
+*.vspscc
+*.vssscc
+.builds
+*.pidb
+*.svclog
+*.scc
+
+# Chutzpah Test files
+_Chutzpah*
+
+# Visual C++ cache files
+ipch/
+*.aps
+*.ncb
+*.opendb
+*.opensdf
+*.sdf
+*.cachefile
+*.VC.db
+
+# Visual Studio profiler
+*.psess
+*.vsp
+*.vspx
+*.sap
+
+# TFS 2012 Local Workspace
+$tf/
+
+# Guidance Automation Toolkit
+*.gpState
+
+# ReSharper is a .NET coding add-in
+_ReSharper*/
+*.[Rr]e[Ss]harper
+*.DotSettings.user
+
+# JustCode is a .NET coding add-in
+.JustCode
+
+# TeamCity is a build add-in
+_TeamCity*
+
+# DotCover is a Code Coverage Tool
+*.dotCover
+
+# NCrunch
+_NCrunch_*
+.*crunch*.local.xml
+nCrunchTemp_*
+
+# MightyMoose
+*.mm.*
+AutoTest.Net/
+
+# Web workbench (sass)
+.sass-cache/
+
+# Installshield output folder
+[Ee]xpress/
+
+# DocProject is a documentation generator add-in
+DocProject/buildhelp/
+DocProject/Help/*.HxT
+DocProject/Help/*.HxC
+DocProject/Help/*.hhc
+DocProject/Help/*.hhk
+DocProject/Help/*.hhp
+DocProject/Help/Html2
+DocProject/Help/html
+
+# Click-Once directory
+publish/
+
+# Publish Web Output
+*.[Pp]ublish.xml
+*.azurePubxml
+
+# TODO: Un-comment the next line if you do not want to checkin
+# your web deploy settings because they may include unencrypted
+# passwords
+#*.pubxml
+*.publishproj
+
+# NuGet Packages
+*.nupkg
+# The packages folder can be ignored because of Package Restore
+**/packages/*
+# except build/, which is used as an MSBuild target.
+!**/packages/build/
+# Uncomment if necessary however generally it will be regenerated when needed
+#!**/packages/repositories.config
+# NuGet v3's project.json files produces more ignoreable files
+*.nuget.props
+*.nuget.targets
+
+# Microsoft Azure Build Output
+csx/
+*.build.csdef
+
+# Microsoft Azure Emulator
+ecf/
+rcf/
+
+# Windows Store app package directory
+AppPackages/
+BundleArtifacts/
+
+# Visual Studio cache files
+# files ending in .cache can be ignored
+*.[Cc]ache
+# but keep track of directories ending in .cache
+!*.[Cc]ache/
+
+# Others
+ClientBin/
+[Ss]tyle[Cc]op.*
+~$*
+*~
+*.dbmdl
+*.dbproj.schemaview
+*.pfx
+*.publishsettings
+node_modules/
+orleans.codegen.cs
+
+# RIA/Silverlight projects
+Generated_Code/
+
+# Backup & report files from converting an old project file
+# to a newer Visual Studio version. Backup files are not needed,
+# because we have git ;-)
+_UpgradeReport_Files/
+Backup*/
+UpgradeLog*.XML
+UpgradeLog*.htm
+
+# SQL Server files
+*.mdf
+*.ldf
+
+# Business Intelligence projects
+*.rdl.data
+*.bim.layout
+*.bim_*.settings
+
+# Microsoft Fakes
+FakesAssemblies/
+
+# GhostDoc plugin setting file
+*.GhostDoc.xml
+
+# Node.js Tools for Visual Studio
+.ntvs_analysis.dat
+
+# Visual Studio 6 build log
+*.plg
+
+# Visual Studio 6 workspace options file
+*.opt
+
+# Visual Studio LightSwitch build output
+**/*.HTMLClient/GeneratedArtifacts
+**/*.DesktopClient/GeneratedArtifacts
+**/*.DesktopClient/ModelManifest.xml
+**/*.Server/GeneratedArtifacts
+**/*.Server/ModelManifest.xml
+_Pvt_Extensions
+
+# LightSwitch generated files
+GeneratedArtifacts/
+ModelManifest.xml
+
+# Paket dependency manager
+.paket/paket.exe
+
+# FAKE - F# Make
+.fake/
diff --git a/README.md b/README.md
@@ -1,2 +1,72 @@
 # NLog.Raven
 RavenDB target for NLog
+
+[![NuGet Version](https://img.shields.io/nuget/v/NLog.Raven.svg?style=flat-square)](https://www.nuget.org/packages/NLog.Raven/) 
+
+## Download
+
+The NLog.Raven library is available on nuget.org via package name `NLog.Raven`.
+
+To install NLog.Raven, run the following command in the Package Manager Console
+
+    PM> Install-Package NLog.Raven
+
+More information about NuGet package avaliable at
+<https://nuget.org/packages/NLog.Raven>
+
+## Configuration Syntax
+
+```xml
+<extensions>
+  <add assembly="NLog.Raven"/>
+</extensions>
+
+<targets>
+  <target xsi:type="Raven"
+          name="String"
+          connectionStringName="String"
+          url="String"
+          user="String"
+          password="Song"
+          domain="String"
+          database="String"          
+          idType="String"
+          collectionName="String">
+
+    <!-- repeated --> 
+    <field name="String" layout="Layout" />    
+  </target>
+</targets>
+```
+## Parameters
+
+### Options
+
+_connectionStringName_ - The name of the connection string to get from the config file. 
+_url_ - The url of the raven db server
+_user_ - The windows user name to use when making the connection
+_password_ - The password of the user to use when making the connection
+_domain_ - The windows domain
+_database_ - The name of the database to connect to
+_idType_ - The id type to use for log entries. Either 'String' | 'Guid'
+_collectionName_ - Set this to change the default document collection name
+
+## Examples
+
+```xml
+<targets>
+      <target name="raven" xsi:type="BufferingWrapper" flushTimeout="7000">
+        <target  xsi:type="Raven" ConnectionStringName="RavenNLog" IdType="Guid" CollectionName="LogEntries">
+          <field name="EventDate" layout="${longdate}"/>
+          <field name="Logger" layout="${logger}"/>
+          <field name="Message" layout="${message}"/>
+          <field name="Host" layout="${machinename}"/>
+          <field name="Exception" layout="${exception:format=toString,Data:maxInnerExceptionLevel=10}"/>
+        </target>
+      </target>
+    </targets>
+    <rules>
+      <logger name="*" minlevel="Info" writeTo="raven"/>
+    </rules>
+```
+
diff --git a/src/NLog.Raven.Tests/App.config b/src/NLog.Raven.Tests/App.config
@@ -0,0 +1,28 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<configuration>
+  <configSections>
+    <section name="nlog" type="NLog.Config.ConfigSectionHandler, NLog" />
+  </configSections>
+  <connectionStrings>
+    <add name="RavenNLog" connectionString="Url=http://ws-1:8080;Database=RavenNLog" />
+  </connectionStrings>
+  <nlog xmlns="http://www.nlog-project.org/schemas/NLog.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+    <extensions>
+      <add assembly="NLog.Raven" />
+    </extensions>
+    <targets>
+      <target name="raven" xsi:type="BufferingWrapper" flushTimeout="7000">
+        <target  xsi:type="Raven" ConnectionStringName="RavenNLog" IdType="Guid" CollectionName="LogEntries">
+          <field name="EventDate" layout="${longdate}"/>
+          <field name="Logger" layout="${logger}"/>
+          <field name="Message" layout="${message}"/>
+          <field name="Host" layout="${machinename}"/>
+          <field name="Exception" layout="${exception:format=toString,Data:maxInnerExceptionLevel=10}"/>
+        </target>
+      </target>
+    </targets>
+    <rules>
+      <logger name="*" minlevel="Info" writeTo="raven"/>
+    </rules>
+  </nlog>
+</configuration>