Skip to main content
Version: 3.10

Plugin Metadata

摘要#

在本文档中，您将了解到 APISIX 中，插件元数据的基本概念和您可能使用到的场景。

浏览文档末尾的相关资源，获取与此相关的更多信息。

描述#

在 APISIX 中，配置通用的元数据属性，可以作用于包含该元数据插件的所有路由及服务中。例如为rocketmq-logger指定了 log_format，则所有绑定 rocketmq-logger 的路由或服务都将使用该日志格式。

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

如果没有另外指定，插件元数据对象上的log_format应将相同的日志格式统一应用于两个syslog插件。但是，由于/orders路由上的syslog插件具有不同的log_format，因此访问该路由的请求将按照路由中插件指定的log_format生成日志。

在插件级别设置的元数据属性更加精细，并且比全局元数据对象具有更高的优先级。

插件元数据对象只能用于具有元数据属性的插件。有关哪些插件具有元数据属性的更多详细信息，请查看插件配置属性及相关信息。

配置示例#

以下示例展示了如何通过 Admin API 配置插件元数据：

note

您可以这样从 config.yaml 中获取 admin_key 并存入环境变量：

admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g')
curl http://127.0.0.1:9180/apisix/admin/plugin_metadata/http-logger \
-H "X-API-KEY: $admin_key" -X PUT -d '
{
    "log_format": {
        "host": "$host",
        "@timestamp": "$time_iso8601",
        "client_ip": "$remote_addr"
    }
}'

配置完成后，你将在日志系统中看到如下类似日志：

{"host":"localhost","@timestamp":"2020-09-23T19:05:05-04:00","client_ip":"127.0.0.1","route_id":"1"}
{"host":"localhost","@timestamp":"2020-09-23T19:05:05-04:00","client_ip":"127.0.0.1","route_id":"1"}

相关资源#

核心概念 - 插件