reflectsoftware / reflectinsight-extensions-postsharp

A ReflectInsight Extension that receives logged messages from PostSharp framework

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

ReflectInsight-Extensions-PostSharp

Build status License Release NuGet Version Stars

Package - ReflectSoftware.Insight.Extensions.PostSharp | Platforms - .NET 4.5.1 and above

Overview

We've added support for the PostSharp tracer. This allows you to leverage your current investment in PostSharp, but leverage the power and flexibility that comes with the ReflectInsight viewer. You can view your PostSharp messages in real-time, in a rich viewer that allows you to filter out and search for what really matters to you.

The benefits of using the PostSharp extension gives you automatic traceability across all methods at a class level or only at a specific method, or a specific field. If using the extension at a class level there are cases where may want to ignore certain methods ie. constructor. You can also define if method traceability will log parameters and their values. At a field level traceability, changing field values will can be shown in the Viewer's Scratchpad and/or Log Window.

Benefits of ReflectInsight Extensions

The benefits to using the Insight Extensions is that you can easily and quickly add them to your applicable with little effort and then use the ReflectInsight Viewer to view your logging in real-time, allowing you to filter, search, navigate and see the details of your logged messages.

Specific to PostSharp

The benefits of using the PostSharp extension gives you automatic traceability across all methods at a class level or only at a specific method, or a specific field.

If using the extension at a class level there are cases where you may want to ignore certain methods ie. constructor.

You can also define if method traceability that will log parameters and their values.

At a field level traceability, changing field values will only be shown in the Viewer's Scratchpad. Note that Scratchpad values are not persisted and they are only available via the Viewer.

Getting Started

Install-Package ReflectSoftware.Insight.Extensions.PostSharp

Then in your app.config or web.config file, add the following configuration sections:

<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <configSections>    
    <section name="insightSettings" type="ReflectSoftware.Insight.ConfigurationHandler,ReflectSoftware.Insight" />
  </configSections>

  <insightSettings>
    <baseSettings>
      <configChange enabled="true" />
      <enable state="all" />
      <propagateException enabled="false" />
      <global category="ReflectInsight" />
      <exceptionEventTracker time="20" />
      <requestObject requestLifeSpan="10" />
      <debugMessageProcess enabled="true" />
    </baseSettings>

    <listenerGroups active="Debug">
      <group name="Debug" enabled="true" maskIdentities="false">
        <destinations>
          <destination name="Viewer" enabled="true" filter="" details="Viewer" />
        </destinations>
      </group>
    </listenerGroups>
    <logManager>
      <!-- used by the PostSharp Tracer Test -->
      <instance name="fields" />
      <instance name="serviceClass" category="ServiceLayer" />
      <instance name="businessClass" category="BusinessLayer" />
      <instance name="dataAccessClass" category="DataAccessLayer" />
    </logManager>

    <!--
		tracer properties = "None|MethodName|Parameters|HashedParameters|IgnoreExceptions" - default: MethodName
    
    None - will get nothing
    MethodName - will only show method name without parameters ( default )
    Parameters - will show method name and parameters but only for primitve types
    HashedParameters - will show method name but hash all parameter values
    IgnoreExceptions - will ignore logging exceptions between enter/exit block    
		-->

    <extensions>
      <extension name="tracer.fields" instance="fields" />
      <extension name="tracer.service" instance="serviceClass" properties="MethodName" />
      <extension name="tracer.business" instance="businessClass" properties="Parameters" />
      <extension name="tracer.dataAccess" instance="dataAccessClass" properties="HashedParameters" />
    </extensions>
  </insightSettings>   
</configuration>

Additional configuration details for the ReflectSoftware.Insight.Extensions.PostSharp logging extension can be found here.

Additional Resources

Documentation

Submit User Feedback

Contact Support

ReflectSoftware Website

About

A ReflectInsight Extension that receives logged messages from PostSharp framework

License:Microsoft Public License


Languages

Language:C# 88.5%Language:PowerShell 11.5%