{"id":32,"date":"2017-03-23T16:48:00","date_gmt":"2017-03-23T21:48:00","guid":{"rendered":"https:\/\/www.chrystalsander.com\/blog\/?p=32"},"modified":"2023-07-27T12:15:43","modified_gmt":"2023-07-27T17:15:43","slug":"net-using-a-single-log4net-configuration-file-across-a-multi-tier-web-application","status":"publish","type":"post","link":"https:\/\/www.chrystalsander.com\/blog\/?p=32","title":{"rendered":".NET: Using A Single log4net Configuration File Across A Multi-Tier Web Application"},"content":{"rendered":"
\nlog4net <\/b><\/a>is
\na tool to help the programmer output log statements to a variety of output
\ntargets.<\/span><\/div>\n


<\/span>
\n<\/p>\n

\nThis
\nexample is written in Visual Studio 2015 for a WebAPI2 solution.  The sample solution consists of three projects
\nthat include a project for data, models, unit tests, etc.  Source code can be found here:<\/o:p><\/span>
\n
<\/a><\/span>
\nhttps:\/\/github.com\/cjsander\/Log4netInMultiTierWebApp<\/a><\/span><\/div>\n
\n
<\/span><\/div>\n
\nSETUP:<\/b><\/o:p><\/span><\/div>\n
\n1.     
\n<\/span><\/span>Create
\nyour project and then import the following Nuget package:        <\/span>https:\/\/www.nuget.org\/packages\/log4net\/<\/span><\/a><\/o:p><\/span><\/span><\/div>\n
\n2.     
\n<\/span><\/span>For
\neach project, add reference to log4net.dll assembly.  Though all configuration will be in the  main
\nAPI project, other projects will require the assembly reference as well.<\/o:p><\/span><\/span><\/div>\n
\n3.     
\n<\/span><\/span>Configuration
\nfiles to be included are: <\/o:p><\/span><\/span><\/div>\n
\na.       <\/span><\/span>Log4net.config<\/o:p><\/span><\/span><\/div>\n
\nb.      <\/span><\/span>Web.config<\/o:p><\/span><\/span><\/div>\n
\nc.       <\/span><\/span>Settings.xml<\/o:p><\/span><\/span><\/div>\n
\nd.      <\/span><\/span>Global.asax.cs<\/o:p><\/span><\/span><\/div>\n
\n4.     
\n<\/span><\/span>Note
\nthat the <appsettings> node of the web.config file has been abstracted
\ninto a separate file — Settings.xml.  
\nThese settings will be referenced in the web.config in the following
\nline of code:<\/o:p><\/span><\/span><\/div>\n
\n
<\/span><\/div>\n
\n<\/p>\n

<\/span><\/div>\n

\n        <\/span> <<\/span><\/span>appSettings<\/span> <\/span>file<\/span>=<\/span>“<\/span>c:webappslog4sampleconfigsettings.xml<\/span>“<\/span>\/><\/span><\/o:p><\/span><\/span><\/div>\n
\n
<\/span><\/div>\n
\nAPPLICATION:<\/b><\/o:p><\/span><\/div>\n
\n1.       <\/span><\/span>In your web.config file, enter the
\nfollowing:<\/o:p><\/span><\/span><\/div>\n
\n  <\/span><<\/span>configSections<\/span>><\/span><\/o:p><\/span><\/span><\/div>\n
\n   <\/a> <<\/a><\/span>section<\/span> <\/span>name<\/span>=<\/span>“<\/span>log4net<\/span>“<\/span> <\/span>type<\/span>=<\/span>“<\/span>log4net.Config.Log4NetConfigurationSectionHandler,
\nlog4net<\/span>“<\/span>\/><\/span><\/o:p><\/span><\/span><\/div>\n
\n  <\/<\/span>configSections<\/span>><\/span><\/span><\/o:p><\/span><\/div>\n
\n2.       <\/span><\/span>Now, add the logging configuration
\nvalues.  These can be added in your
\nweb.config(or app.config) but in this scenario, it has its own configuration
\nfile \u2013 log4net.config:<\/o:p><\/span><\/span><\/div>\n
\n<<\/span>log4net><\/span><\/o:p><\/span><\/span><\/div>\n
\n 
\n<<\/span>appender <\/span>name<\/span>=<\/span>“RollingFile<\/span>“ <\/span>type<\/span>=<\/span>“log4net.Appender.RollingFileAppender<\/span>“>\u2026..<\/o:p><\/span><\/span><\/span><\/div>\n
\n<\/<\/span>log4net<\/span>><\/span><\/o:p><\/span><\/span><\/span><\/div>\n
\n
<\/span><\/div>\n
\n3.       <\/span><\/span>Then,
\nyou will want to add the path to the file in your <appSettings> node:<\/o:p><\/span><\/span><\/div>\n
\n<<\/span>add<\/span> <\/span>key<\/span>=<\/span>“<\/span>logPath<\/span>“<\/span> <\/span>value<\/span>=<\/span>“<\/span>c:webappslog4sampleconfiglog4net.config<\/span>“<\/span><\/span> \/><\/span><\/o:p><\/span><\/span><\/div>\n
\n4.       <\/span><\/span>In your
\nGlobal.asax file, add the following to the Application_Start() method:<\/o:p><\/span><\/span><\/div>\n
\n\/\/log4net setup:<\/span><\/o:p><\/span><\/span><\/div>\n
\nvar<\/span> logPath = (<\/span>ConfigurationManager<\/span>.AppSettings[<\/span>“logPath”<\/span>]);<\/o:p><\/span><\/span><\/div>\n
\n<\/p>\n

<\/span><\/div>\n

\nlog4net.Config.<\/span>XmlConfigurator<\/span>.ConfigureAndWatch(<\/span>new<\/span> <\/span>FileInfo<\/span>(logPath));<\/span><\/span><\/div>\n
\n
<\/span><\/div>\n
\nEXTRA:<\/b><\/o:p><\/span><\/div>\n
\nYou can also
\nadd a helper method to customize your logging and add details that would help
\nwith your debugging:<\/o:p><\/span><\/div>\n
\npublic<\/span> <\/span>class<\/span> <\/span>Log4NetHelper<\/span><\/o:p><\/span><\/span><\/div>\n
\n    {<\/o:p><\/span><\/div>\n
\npublic<\/span> <\/span>string<\/span> LogMsg(<\/span>Message<\/span> m, [<\/span>Optional<\/span>] <\/span>string<\/span> exceptionMsg, [<\/span>CallerMemberName<\/span>] <\/span>string<\/span> methodName = <\/span>“”<\/span>)<\/o:p><\/span><\/span><\/div>\n
\n        {<\/o:p><\/span><\/div>\n
\n            <\/span>string<\/span> msg = <\/span>$”<\/span>{methodName}<\/span> <\/span>{m}<\/span> <\/span>{exceptionMsg}<\/span>“<\/span>;<\/o:p><\/span><\/span><\/div>\n
\n            <\/span>return<\/span> msg;<\/o:p><\/span><\/span><\/div>\n
\n        }<\/o:p><\/span><\/div>\n
\n}<\/span><\/o:p><\/span>
\n
<\/span><\/div>\n
\n               To
\nreference:<\/span><\/div>\n
\nprivate<\/span> <\/span>readonly<\/span> <\/span>Log4NetHelper _msg = new<\/span> Log4NetHelper();<\/o:p><\/span><\/span><\/div>\n
\n<\/div>\n
\n_logger.Debug(_msg.LogMsg(<\/span>Log4NetHelper.Message.InitialRequestStart));<\/span><\/span><\/o:p><\/span><\/div>\n
\n
<\/span>
\nSAMPLE FOLDER STRUCTURE:<\/span><\/b>
\n
<\/span>
\n<\/p>\n
\n<\/a><\/span><\/a><\/span><\/a><\/div>\n

\n
<\/span><\/div>\n

\n
<\/span><\/div>\n
\n
<\/span><\/div>\n
\n
<\/span>
\n
<\/span>
\n
<\/span>
\n
<\/span>
\n
<\/span>
\n
<\/span>
\n
<\/span>
\n
<\/span>
\n
<\/span>
\n
<\/span>
\n
<\/span>
\n
<\/span>
\n
<\/span>
\n
<\/span>
\n
<\/span>
\n
<\/span>
\nFURTHER REFERENCES:<\/span><\/b><\/p>\n
\nhttp:\/\/geekswithblogs.net\/michaelstephenson\/archive\/2014\/01\/02\/155044.aspx<\/a><\/span><\/o:p><\/span><\/span><\/div>\n

<\/p>\n

\nhttps:\/\/logging.apache.org\/log4net\/release\/config-examples.html<\/span><\/a><\/o:p><\/span><\/span><\/div>\n


<\/span>
\n
<\/span>
\n
<\/span>
\n
<\/span><\/div>\n","protected":false},"excerpt":{"rendered":"

log4net is a tool to help the programmer output log statements to a variety of output targets. This example is written in Visual Studio 2015 for a WebAPI2 solution.  The sample solution consists of three projects that include a project for data, models, unit tests, etc.  Source code can be found here: https:\/\/github.com\/cjsander\/Log4netInMultiTierWebApp SETUP: 1.      … Continue reading “.NET: Using A Single log4net Configuration File Across A Multi-Tier Web Application”<\/span><\/a><\/p>\n","protected":false},"author":2,"featured_media":0,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[20,4,92,17],"tags":[42],"_links":{"self":[{"href":"https:\/\/www.chrystalsander.com\/blog\/index.php?rest_route=\/wp\/v2\/posts\/32"}],"collection":[{"href":"https:\/\/www.chrystalsander.com\/blog\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.chrystalsander.com\/blog\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.chrystalsander.com\/blog\/index.php?rest_route=\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/www.chrystalsander.com\/blog\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=32"}],"version-history":[{"count":1,"href":"https:\/\/www.chrystalsander.com\/blog\/index.php?rest_route=\/wp\/v2\/posts\/32\/revisions"}],"predecessor-version":[{"id":206,"href":"https:\/\/www.chrystalsander.com\/blog\/index.php?rest_route=\/wp\/v2\/posts\/32\/revisions\/206"}],"wp:attachment":[{"href":"https:\/\/www.chrystalsander.com\/blog\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=32"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.chrystalsander.com\/blog\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=32"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.chrystalsander.com\/blog\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=32"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}