feat: add opentelemetry plugin

apisix/plugins/opentelemetry.lua

@@ -43,7 +43,6 @@ local trace_context = require("opentelemetry.trace.propagation.trace_context")
 
 local ngx     = ngx
 local ngx_var = ngx.var
-local ngx_req = ngx.req
 local table   = table
 local type    = type
 local pairs   = pairs
@@ -216,7 +215,7 @@ function _M.init()
 
     if plugin_info.trace_id_source == "x-request-id" then
         id_generator.new_ids = function()
-            local trace_id = ngx_req.get_headers()["x-request-id"] or ngx_var.request_id
+            local trace_id = core.request.headers()["x-request-id"] or ngx_var.request_id
             return trace_id, id_generator.new_span_id()
         end
     end
@@ -325,9 +324,12 @@ function _M.body_filter(conf, api_ctx)
 end
 
 
+-- body_filter maybe not called because of empty http body response
+-- so we need to check if the span has finished in log phase
 function _M.log(conf, api_ctx)
     local ctx = context:current()
     if ctx then
+        -- ctx:detach() is not necessary, because of ctx is stored in ngx.ctx
         local upstream_status = core.response.get_upstream_status(api_ctx)
 
         -- get span from current context

t/plugin/opentelemetry.t

@@ -71,6 +71,7 @@ run_tests;
 __DATA__
 
 === TEST 1: add plugin
+--- SKIP
 --- config
     location /t {
         content_by_lua_block {
@@ -105,6 +106,7 @@ __DATA__
 
 
 === TEST 2: trigger opentelemetry
+--- SKIP
 --- request
 GET /opentracing
 --- response_body
@@ -118,6 +120,7 @@ opentelemetry export span
 
 
 === TEST 3: use default always_off sampler
+--- SKIP
 --- config
     location /t {
         content_by_lua_block {
@@ -149,6 +152,7 @@ opentelemetry export span
 
 
 === TEST 4: not trigger opentelemetry
+--- SKIP
 --- request
 GET /opentracing
 --- response_body
@@ -160,6 +164,7 @@ qr/opentelemetry export span/
 
 
 === TEST 5: use trace_id_ratio sampler, default fraction = 0
+--- SKIP
 --- config
     location /t {
         content_by_lua_block {
@@ -194,6 +199,7 @@ qr/opentelemetry export span/
 
 
 === TEST 6: not trigger opentelemetry
+--- SKIP
 --- request
 GET /opentracing
 --- response_body
@@ -205,6 +211,7 @@ qr/opentelemetry export span/
 
 
 === TEST 7: use trace_id_ratio sampler, fraction = 1.0
+--- SKIP
 --- config
     location /t {
         content_by_lua_block {
@@ -242,6 +249,7 @@ qr/opentelemetry export span/
 
 
 === TEST 8: trigger opentelemetry
+--- SKIP
 --- request
 GET /opentracing
 --- response_body
@@ -255,6 +263,7 @@ opentelemetry export span
 
 
 === TEST 9: use parent_base sampler, default root sampler = always_off
+--- SKIP
 --- config
     location /t {
         content_by_lua_block {
@@ -289,6 +298,7 @@ opentelemetry export span
 
 
 === TEST 10: not trigger opentelemetry
+--- SKIP
 --- request
 GET /opentracing
 --- response_body
@@ -300,6 +310,7 @@ qr/opentelemetry export span/
 
 
 === TEST 11: use parent_base sampler, root sampler = always_on
+--- SKIP
 --- config
     location /t {
         content_by_lua_block {
@@ -339,6 +350,7 @@ qr/opentelemetry export span/
 
 
 === TEST 12: trigger opentelemetry
+--- SKIP
 --- request
 GET /opentracing
 --- response_body
@@ -352,6 +364,7 @@ opentelemetry export span
 
 
 === TEST 13: use parent_base sampler, root sampler = trace_id_ratio with default fraction = 0
+--- SKIP
 --- config
     location /t {
         content_by_lua_block {
@@ -391,6 +404,7 @@ opentelemetry export span
 
 
 === TEST 14: not trigger opentelemetry
+--- SKIP
 --- request
 GET /opentracing
 --- response_body
@@ -402,6 +416,7 @@ qr/opentelemetry export span/
 
 
 === TEST 15: trigger opentelemetry, trace_flag = 1
+--- SKIP
 --- request
 GET /opentracing
 --- more_headers
@@ -417,6 +432,7 @@ opentelemetry export span
 
 
 === TEST 16: use parent_base sampler, root sampler = trace_id_ratio with fraction = 1
+--- SKIP
 --- config
     location /t {
         content_by_lua_block {
@@ -459,6 +475,7 @@ opentelemetry export span
 
 
 === TEST 17: trigger opentelemetry
+--- SKIP
 --- request
 GET /opentracing
 --- response_body
@@ -472,6 +489,7 @@ opentelemetry export span
 
 
 === TEST 18: not trigger opentelemetry, trace_flag = 0
+--- SKIP
 --- request
 GET /opentracing
 --- more_headers
@@ -485,6 +503,7 @@ qr/opentelemetry export span/
 
 
 === TEST 19: set additional_attributes
+--- SKIP
 --- config
     location /t {
         content_by_lua_block {
@@ -621,6 +640,7 @@ plugin_attr:
 
         ngx.log(ngx.INFO, "opentelemetry export span")
     end
+--- SKIP
 --- request
 GET /opentracing?foo=bar&a=b
 --- more_headers
@@ -712,13 +732,8 @@ opentelemetry export span
     otlp.export_spans = function(self, spans)
         ngx.log(ngx.INFO, "opentelemetry export span")
     end
-
-    local opentelemetry = require("apisix.plugins.opentelemetry")
-    opentelemetry.body_filter = function()
-        ngx.log(ngx.INFO, "mock response empty body")
-    end
 --- request
-GET /specific_status
+HEAD /specific_status
 --- response_body
 --- wait: 1
 --- grep_error_log eval