Есть ли способ сделать условие в макете NLog?

Question

Я пытаюсь создать конфигурацию макета NLog следующим образом:

layout = "${callsite} > ${message} (${exception:format=tostring})"

Выход для этого макета (когда я его тестирую):

TestProject.Program.Main> исключение выдается (System.Exception: сообщение об исключении)

Однако, если я пытаюсь вывести сообщение, которое не имеет исключения, оно выглядит так:

TestProject.Program.Main> исключение не выброшено ()

Можно ли изменить этот макет так, чтобы скобки отображались только тогда, когда на самом деле есть исключение?

Answer 1

Вы можете написать свой собственный LayoutRenderer следующим образом:

  [LayoutRenderer("MyCustomExceptionLayoutRenderer")]
  class MyCustomExceptionLayoutRenderer : LayoutRenderer
  {
    protected override void Append(StringBuilder builder, LogEventInfo logEvent)
    {
      if (logEvent.Exception == null)
      {
        builder.Append("no exception thrown");
      }
      else
      {
        //Might want fancier formatting of exception here...
        builder.Append("exception thrown ({0})", logEvent.Exception.ToString());
      }
    }

    protected override int GetEstimatedBufferSize(LogEventInfo logEvent)
    {
      return 100;
    }
  }

Я думаю (но не пробовал), что вы также можете определить свой LayoutRenderer для одного (или нескольких параметров), например так:

  public enum BracketOption
  {
    None,
    Parentheses,        // ()
    CurlyBraces,        // {}
    SquareBraces,       // []
    LessThanGreaterThan // <>
  }

  [LayoutRenderer("MyCustomExceptionLayoutRenderer")]
  class MyCustomExceptionLayoutRenderer : LayoutRenderer
  {
    public BracketOption Option { get; set; }

    private string left = "";
    private string right = "";

    public MyCustomExceptionLayoutRenderer()
      :base()
    {
      Option = BracketOption.None;
    }

    protected override void Initialize()
    {
      switch(Option)
      {
        case BracketOption.Parentheses:
          left = "(";
          right = ")";
          break;
        case BracketOption.CurlyBraces:
          left = "{";
          right = "}";
          break;
        case BracketOption.SquareBraces:
          left = "[";
          right = "]";
          break;
        case BracketOption.LessThanGreaterThan:
          left = "<";
          right = ">";
          break;
        case BracketOption.None:
        default:
          left = "";
          right = "";
          break;
      }
    }

    protected override void Append(StringBuilder builder, LogEventInfo logEvent)
    {
      if (logEvent.Exception == null)
      {
        builder.Append("no exception thrown");
      }
      else
      {
        //Might want fancier formatting of exception here...
        builder.Append(string.Format("exception thrown {0}{1}{2}", 
                        left, logEvent.Exception.ToString(), right);
      }
    }

    protected override int GetEstimatedBufferSize(LogEventInfo logEvent)
    {
      return 100;
    }
  }

Чтобы использовать, добавьте такие строки в NLog.config (или app.config при настройке inline), например:

<extensions>
  <add assembly="MyNLogExtensions" />
</extensions>

И добавьте в свой макет вот так:

<targets>
  <target type="Console" layout="Exception: ${MyCustomException}" />
</targets>

Параметризованный макет может выглядеть следующим образом (не уверен в точном формате для указания параметров):

<targets>
  <target type="Console" layout="Exception: ${MyCustomException:BracketOption=Parentheses}" />
</targets>