如何处理由NLog的所有事件属性布局渲染器产生的空值?

时间:2019-05-24 18:39:27

标签: c# postgresql nlog npgsql hstore

我正在为PostgreSQL配置NLog的数据库目标,并且我想使用hstore column来存储所有事件属性。我为此使用all-event-properties layout renderer

这是我当前的目标配置:

<target name="database"
        xsi:type="Database"
        dbProvider="Npgsql.NpgsqlConnection, Npgsql"
        connectionString="Server=localhost;Port=5432;Database=db;User Id=postgres">
  <install-command>
    <text>
      CREATE EXTENSION IF NOT EXISTS hstore WITH SCHEMA public;
      CREATE TABLE IF NOT EXISTS logs (
      id bigserial PRIMARY KEY,
      moment timestamp NOT NULL,
      level text NOT NULL,
      message text NOT NULL,
      args hstore NOT NULL
      );
    </text>
  </install-command>
  <commandText>
    INSERT INTO logs (moment, level, message, args)
    VALUES (@moment::timestamp, @level, @message, @args::hstore);
  </commandText>
  <parameter name="@moment" layout="${longdate:universalTime=true}" />
  <parameter name="@level" layout="${level}" />
  <parameter name="@message" layout="${message}" />

  <!-- (!) Here's where the format of event properties adopted for hstore syntax (!)-->
  <parameter name="@args" layout="${all-event-properties:format=[key]=>[value]" />

</target>

它适用于不带参数但具有参数的日志,将生成以下SQL:

INSERT INTO logs (moment, level, message, args) VALUES (
'2019-05-24 18:44:49.7494'::timestamp,
'Info',
'Message text here',
'a=>1, b=>2, c=>3, EventId_Id=>555, EventId_Name=>, EventId=>555'::hstore);
--                           no value here--------^

这是无效的语法,因为PostgreSQL语法需要NULL关键字作为值或根本不包含键:

这是错误:

ERROR:  Syntax error near 'E' at position 51

当我手动执行此操作时,它可以准确复制,而当我拔出EventId_Name=>,键时,它会消失。因此,我很确定我需要某种方式跳过/处理那些空键才能感到高兴。

我也可以使用SQL中的任何解决方案,但是找不到一种简单而健壮的方法来处理这些值。

2 个答案:

答案 0 :(得分:1)

我不完全了解这种情况下的语法,但是您仍然可以使用自定义布局渲染器来解决此问题

创建:

// register ${all-properties-postgresql}
LayoutRenderer.Register("all-properties-postgresql", 
                       (logEvent) => SerializeProps(logEvent.Properties));

您需要编写SerializeProps来序列化LogEventInfo.Properties-请参见API docs

答案 1 :(得分:1)

为有助于解答,我已阅读了hstore format documentation

  

双引号键和值,包括空格,逗号,= s或> s。要在键或值中包含双引号或反斜杠,请使用反斜杠对其进行转义。

不确定=s>s是什么,因此我决定对所有内容使用双引号,同时转义双引号和反斜杠。这是我的解决方案:

LayoutRenderer.Register("all-event-properties-hstore", e =>
{
    var sb = new StringBuilder();
    var first = true;
    var fp = e.FormatProvider ?? CultureInfo.InvariantCulture;
    string GetString(object o) =>
        Convert.ToString(o, fp).Replace("\\", "\\\\").Replace("\"", "\\\"");
    foreach (var (key, value) in e.Properties)
    {
        if (first)
            first = false;
        else
            sb.Append(",");
        sb.Append("\"");
        sb.Append(GetString(key));
        sb.Append("\"=>\"");
        sb.Append(GetString(value));
        sb.Append("\"");
    }
    return sb.ToString();
});