Search code examples
c#loggingnlog

NLog custom LayoutRenderer for scope indentation


can any one provide me of a very sample custom layoutrenderer for nlog ?

I want to make indentation while im logging , by example

if im calling Method B from Method C

the Text log file goes like this :

Inside Method C
       Inside Method B

and so on.


Solution

  • here it is:

    [LayoutRenderer("IndentationLayout")]
    public sealed class IndentationLayoutRenderer : LayoutRenderer
    {
        // Value to substract from stack count
        private uint _ignore = 12;
    
        // Value to pad with.
        private string _ipadding = "| ";
    
        /// <summary>Set the number of (top) stackframes to ignore</summary>
        public uint Ignore
        {
            get { return _ignore; }
            set { _ignore = value; }
        }
    
        /// <summary>Set the padding value</summary>
        public string IndentationPadding
        {
            get { return _ipadding; }
            set { _ipadding = value; }
        }
    
        protected override void Append(StringBuilder builder, LogEventInfo ev)
        {
            // Get current stack depth, insert padding chars.
            StackTrace st = new StackTrace();
            long indent = st.FrameCount;
            indent = indent > _ignore ? indent - _ignore : 0;
            for (int i = 0; i < indent; ++i)
            {
                builder.Append(_ipadding);
            }
        }
    }
    

    Registration:

    if(NLog.Config.ConfigurationItemFactory.Default.LayoutRenderers.AllRegisteredItems.ContainsKey(
                    "IndentationLayout"))
                    return;
    
    NLog.Config.ConfigurationItemFactory.Default.LayoutRenderers.RegisterDefinition("IndentationLayout", typeof(IndentationLayoutRenderer));