(apisix) branch master updated: fix(opentelemetry): remove plugin attr set_ngx_var (#12411)

[baoyuan]

This is an automated email from the ASF dual-hosted git repository.

baoyuan pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/apisix.git


The following commit(s) were added to refs/heads/master by this push:
     new 1ebc21746 fix(opentelemetry): remove plugin attr set_ngx_var (#12411)
1ebc21746 is described below

commit 1ebc21746aa093f070e6abb6d3f0b1c684794dda
Author: Baoyuan <baoyuan....@gmail.com>
AuthorDate: Tue Jul 15 16:19:21 2025 +0800

    fix(opentelemetry): remove plugin attr set_ngx_var (#12411)
---
 apisix/cli/ngx_tpl.lua                  |  2 --
 apisix/cli/ops.lua                      |  6 ------
 docs/en/latest/plugins/opentelemetry.md | 14 ++++++++++----
 docs/zh/latest/plugins/opentelemetry.md | 12 +++++++++---
 4 files changed, 19 insertions(+), 15 deletions(-)

diff --git a/apisix/cli/ngx_tpl.lua b/apisix/cli/ngx_tpl.lua
index 5dd739b62..34576aadc 100644
--- a/apisix/cli/ngx_tpl.lua
+++ b/apisix/cli/ngx_tpl.lua
@@ -740,11 +740,9 @@ http {
         {% end %}
 
         # opentelemetry_set_ngx_var starts
-        {% if opentelemetry_set_ngx_var then %}
         set $opentelemetry_context_traceparent          '';
         set $opentelemetry_trace_id                     '';
         set $opentelemetry_span_id                      '';
-        {% end %}
         # opentelemetry_set_ngx_var ends
 
         # zipkin_set_ngx_var starts
diff --git a/apisix/cli/ops.lua b/apisix/cli/ops.lua
index 3b2e555b5..f3c6d3137 100644
--- a/apisix/cli/ops.lua
+++ b/apisix/cli/ops.lua
@@ -550,11 +550,6 @@ Please modify "admin_key" in conf/config.yaml .
         end
     end
 
-    local opentelemetry_set_ngx_var
-    if enabled_plugins["opentelemetry"] and 
yaml_conf.plugin_attr["opentelemetry"] then
-        opentelemetry_set_ngx_var = 
yaml_conf.plugin_attr["opentelemetry"].set_ngx_var
-    end
-
     local zipkin_set_ngx_var
     if enabled_plugins["zipkin"] and yaml_conf.plugin_attr["zipkin"] then
         zipkin_set_ngx_var = yaml_conf.plugin_attr["zipkin"].set_ngx_var
@@ -581,7 +576,6 @@ Please modify "admin_key" in conf/config.yaml .
         control_server_addr = control_server_addr,
         prometheus_server_addr = prometheus_server_addr,
         proxy_mirror_timeouts = proxy_mirror_timeouts,
-        opentelemetry_set_ngx_var = opentelemetry_set_ngx_var,
         zipkin_set_ngx_var = zipkin_set_ngx_var
     }
 
diff --git a/docs/en/latest/plugins/opentelemetry.md 
b/docs/en/latest/plugins/opentelemetry.md
index 54d930c7f..dc47b0f66 100644
--- a/docs/en/latest/plugins/opentelemetry.md
+++ b/docs/en/latest/plugins/opentelemetry.md
@@ -198,7 +198,16 @@ The following example demonstrates how to configure the 
`opentelemetry` Plugin t
 - `opentelemetry_trace_id`: trace ID of the current span
 - `opentelemetry_span_id`: span ID of the current span
 
-Update the configuration file as below. You should customize the access log 
format to use the `opentelemetry` Plugin variables, and set `opentelemetry` 
variables in the `set_ngx_var` field.
+Configure the plugin metadata to set `set_ngx_var` as true:
+
+```shell
+curl http://127.0.0.1:9180/apisix/admin/plugin_metadata/opentelemetry -H 
"X-API-KEY: $admin_key" -X PUT -d '
+{
+    "set_ngx_var": true
+}'
+```
+
+Update the configuration file as below. You should customize the access log 
format to use the `opentelemetry` Plugin variables.
 
 ```yaml title="conf/config.yaml"
 nginx_config:
@@ -206,9 +215,6 @@ nginx_config:
     enable_access_log: true
     access_log_format: '{"time": 
"$time_iso8601","opentelemetry_context_traceparent": 
"$opentelemetry_context_traceparent","opentelemetry_trace_id": 
"$opentelemetry_trace_id","opentelemetry_span_id": 
"$opentelemetry_span_id","remote_addr": "$remote_addr"}'
     access_log_format_escape: json
-plugin_attr:
-  opentelemetry:
-    set_ngx_var: true
 ```
 
 Reload APISIX for configuration changes to take effect.
diff --git a/docs/zh/latest/plugins/opentelemetry.md 
b/docs/zh/latest/plugins/opentelemetry.md
index fa04fb79b..2ba1c099d 100644
--- a/docs/zh/latest/plugins/opentelemetry.md
+++ b/docs/zh/latest/plugins/opentelemetry.md
@@ -197,6 +197,15 @@ Attributes:
 - `opentelemetry_trace_id`: 当前 span 的 trace_id
 - `opentelemetry_span_id`: 当前 span 的 span_id
 
+配置插件元数据以将 `set_ngx_var` 设置为 true：
+
+```shell
+curl http://127.0.0.1:9180/apisix/admin/plugin_metadata/opentelemetry -H 
"X-API-KEY: $admin_key" -X PUT -d '
+{
+    "set_ngx_var": true
+}'
+```
+
 如下更新配置文件。你应该自定义访问日志格式以使用 `opentelemetry` 插件变量，并在 `set_ngx_var` 字段中设置 
`opentelemetry` 变量。
 
 ```yaml title="conf/config.yaml"
@@ -205,9 +214,6 @@ nginx_config:
     enable_access_log: true
     access_log_format: '{"time": 
"$time_iso8601","opentelemetry_context_traceparent": 
"$opentelemetry_context_traceparent","opentelemetry_trace_id": 
"$opentelemetry_trace_id","opentelemetry_span_id": 
"$opentelemetry_span_id","remote_addr": "$remote_addr"}'
     access_log_format_escape: json
-plugin_attr:
-  opentelemetry:
-    set_ngx_var: true
 ```
 
 重新加载 APISIX 以使配置更改生效。