28.5. 动态跟踪

• 28 .5.1. 进行动态跟踪编译

• 28 .5.2. 内置探头

• 28 .5.3. 使用探针

• 28 .5.4. 定义新探针

PostgreSQL 提供了支持数据库服务器动态跟踪的功能。这允许在代码中的特定点调用外部 Util，从而跟踪执行。

许多探针或跟踪点已经插入到源代码中。这些探针旨在供数据库开发人员和 Management 员使用。默认情况下，探针不会编译到 PostgreSQL 中。用户需要明确告诉 configure 脚本以使探针可用。

当前支持DTraceUtil，在撰写本文时，该 Util 可在 Solaris，macOS，FreeBSD，NetBSD 和 Oracle Linux 上使用。 Linux 的SystemTap项目提供了 DTrace 等效项，也可以使用。理论上，通过更改src/include/utils/probes.h中宏的定义，可以支持其他动态跟踪 Util。

28 .5.1. 进行动态跟踪编译

默认情况下，探针不可用，因此您需要明确地告诉 configure 脚本以使探针在 PostgreSQL 中可用。要包括 DTrace 支持，请指定--enable-dtrace进行配置。有关更多信息，请参见Section 16.4。

28 .5.2. 内置探头

源代码中提供了许多标准探针，如Table 28.23所示； Table 28.24显示了探针中使用的类型。当然可以添加更多探针以增强 PostgreSQL 的可观察性。

表 28.23. 内置 DTrace 探头

表 28.24. 探针参数中使用的已定义类型

28 .5.3. 使用探针

下面的示例显示了一个 DTrace 脚本，用于分析系统中的事务计数，作为在性能测试前后对pg_stat_database进行快照的替代方法：

#!/usr/sbin/dtrace -qs

postgresql$1:::transaction-start
{
      @start["Start"] = count();
      self->ts  = timestamp;
}

postgresql$1:::transaction-abort
{
      @abort["Abort"] = count();
}

postgresql$1:::transaction-commit
/self->ts/
{
      @commit["Commit"] = count();
      @time["Total time (ns)"] = sum(timestamp - self->ts);
      self->ts=0;
}

执行后，示例 D 脚本将提供以下输出：

# ./txn_count.d `pgrep -n postgres` or ./txn_count.d <PID>
^C

Start                                          71
Commit                                         70
Total time (ns)                        2312105013

您应该记住，DTrace 脚本需要仔细编写和调试，否则收集的跟踪信息可能毫无意义。在大多数情况下，发现问题的是仪器故障，而不是基础系统。在讨论使用动态跟踪找到的信息时，请确保将用于检查和讨论该脚本的内容包含在内。

28 .5.4. 定义新探针

可以在开发人员希望的任何地方在代码中定义新的探针，尽管这需要重新编译。以下是插入新探针的步骤：

• 确定探针名称和将通过探针提供的数据

• 将探针定义添加到src/backend/utils/probes.d

• 如果包含探测点的模块中尚不存在pg_trace.h，则将其包含在内，并在源代码中的所需位置插入TRACE_POSTGRESQL探测宏

• 重新编译并验证新探针是否可用

示例： 这是一个示例，说明如何添加探针以按事务 ID 跟踪所有新事务。

• 确定探针将被命名为transaction-start，并且需要一个类型为LocalTransactionId的参数

• 将探针定义添加到src/backend/utils/probes.d：

probe transaction__start(LocalTransactionId);

请注意在探针名称中使用双下划线。在使用探针的 DTrace 脚本中，双下划线需要用连字符替换，因此transaction-start是为用户记录的名称。

• 在编译时，transaction__start被转换为名为TRACE_POSTGRESQL_TRANSACTION_START的宏(注意，这里的下划线是单个的)，可以通过包含pg_trace.h来使用。将宏调用添加到源代码中的适当位置。在这种情况下，它看起来如下所示：

TRACE_POSTGRESQL_TRANSACTION_START(vxid.localTransactionId);

• 重新编译并运行新的二进制文件后，通过执行以下 DTrace 命令检查新添加的探针是否可用。您应该看到类似的输出：

# dtrace -ln transaction-start
   ID    PROVIDER          MODULE           FUNCTION NAME
18705 postgresql49878     postgres     StartTransactionCommand transaction-start
18755 postgresql49877     postgres     StartTransactionCommand transaction-start
18805 postgresql49876     postgres     StartTransactionCommand transaction-start
18855 postgresql49875     postgres     StartTransactionCommand transaction-start
18986 postgresql49873     postgres     StartTransactionCommand transaction-start

将跟踪宏添加到 C 代码时，需要注意以下几点：

• 您应注意，为探针参数指定的数据类型与宏中使用的变量的数据类型相匹配。否则，您将获得编译错误。

• 在大多数平台上，如果 PostgreSQL 是使用--enable-dtrace构建的，则只要控制通过宏，即使没有完成跟踪，也会对 trace 宏的参数进行评估。如果仅报告一些局部变量的值，通常就不必担心。但是要注意不要将昂贵的函数调用放入参数中。如果需要这样做，请考虑通过检查是否实际启用跟踪来保护宏：

if (TRACE_POSTGRESQL_TRANSACTION_START_ENABLED())
    TRACE_POSTGRESQL_TRANSACTION_START(some_function(...));

每个跟踪宏都有一个对应的ENABLED宏。