chore: Rename additional_header_attributes to additional_header_prefi…

…x_attributes
apache · Sep 5, 2022 · a19a27b · a19a27b
1 parent 8266b2a
commit a19a27b
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 6 deletions.
diff --git a/apisix/plugins/opentelemetry.lua b/apisix/plugins/opentelemetry.lua
@@ -171,7 +171,7 @@ local schema = {
                 minLength = 1,
             }
         },
-        additional_header_attributes = {
+        additional_header_prefix_attributes = {
             type = "array",
             items = {
                 type = "string",
@@ -320,10 +320,10 @@ function _M.rewrite(conf, api_ctx)
         inject_attributes(attributes, conf.additional_attributes, api_ctx.var, false)
     end
 
-    if conf.additional_header_attributes then
+    if conf.additional_header_prefix_attributes then
         inject_attributes(
             attributes,
-            conf.additional_header_attributes,
+            conf.additional_header_prefix_attributes,
             core.request.headers(api_ctx),
             true
         )

diff --git a/docs/en/latest/plugins/opentelemetry.md b/docs/en/latest/plugins/opentelemetry.md
@@ -46,8 +46,8 @@ The Plugin only supports binary-encoded [OLTP over HTTP](https://opentelemetry.i
 | sampler.options.root.options.fraction | number        | False    | 0                                               | [0, 1]                                                       | Root sampling probability for `trace_id_ratio`.                                                                                                                                                                                              |
 | additional_attributes                 | array[string] | False    |                                                 |                                                              | Variables and its values which will be appended to the trace span.                                                                                                                                                                           |
 | additional_attributes[0]              | string        | True     |                                                 |                                                              | APISIX or Nginx variables. For example, `http_header` or `route_id`.                                                                                                                                                                         |
-| additional_header_attributes          | array[string] | False    |                                                 |                                                              | Variables and its values which will be appended to the trace span.                                                                                                                                                                           |
-| additional_header_attributes[0]       | string        | True     |                                                 |                                                              | Request headers. For example, `x-my-header"` or `x-my-headers-*` to include all headers with the prefix `x-my-headers-`.                                                                                                                                                                         |
+| additional_header_prefix_attributes   | array[string] | False    |                                                 |                                                              | Headers or headers prefixes to be appended to the trace span's attributes.                                                                                                                                                                   |
+| additional_header_prefix_attributes[0]| string        | True     |                                                 |                                                              | Request headers. For example, `x-my-header"` or `x-my-headers-*` to include all headers with the prefix `x-my-headers-`.                                                                                                                     |
 
 ### Configuring the collector
 

diff --git a/t/plugin/opentelemetry2.t b/t/plugin/opentelemetry2.t
@@ -159,7 +159,7 @@ opentelemetry export span
                             "sampler": {
                                 "name": "always_on"
                             },
-                            "additional_header_attributes": [
+                            "additional_header_prefix_attributes": [
                                 "x-my-header-*"
                             ]
                         }