插件元数据

本文档将介绍 APISIX 中插件元数据的基本概念以及为什么需要它们。

在文档末尾探索其他资源，以获取有关相关主题的更多信息。

概述

在 APISIX 中，插件元数据（Plugin Metadata）对象用于配置共享相同插件名称的所有插件实例的公共元数据字段。当一个插件在多个对象中启用并且需要对其元数据字段进行统一更新时，这非常有用。

下图说明了插件元数据的概念，使用两个不同路由上的两个 syslog 插件实例，以及一个设置全局 log_format 的插件元数据对象：

除非另有说明，插件元数据对象上的 log_format 应将相同的日志格式统一应用于两个 syslog 插件。但是，由于 /order 路由上的 syslog 插件具有不同的 log_format，访问此路由的请求将生成该路由上插件指定的 log_format 的日志。

一般来说，如果一个插件的字段同时在插件元数据和另一个对象（如路由）中定义，则另一个对象上的定义优先于插件元数据中的全局定义，以提供更细粒度的控制。

插件元数据对象仅应用于具有元数据字段的插件。有关哪些插件具有元数据字段的更多详细信息，请参阅插件参考指南（即将推出）。