spacewander commented on a change in pull request #6119:
URL: https://github.com/apache/apisix/pull/6119#discussion_r786373642
##########
File path: apisix/plugins/opentelemetry.lua
##########
@@ -50,31 +50,35 @@ local pairs = pairs
local ipairs = ipairs
local unpack = unpack
-local hostname
+local lrucache = core.lrucache.new({
+ type = 'plugin', count = 128, ttl = 24 * 60 * 60,
+})
+
local attr_schema = {
type = "object",
properties = {
- x_request_id_as_trace_id = {
- type = "boolean",
- description = "use x-request-id as new trace id",
- default = false,
+ trace_id_source = {
+ type = "string",
+ enum = {"x-request-id", "random"},
+ description = "alternate use x-request-id as trace id",
Review comment:
```suggestion
description = "the source of trace id",
```
##########
File path: apisix/plugins/opentelemetry.lua
##########
@@ -0,0 +1,325 @@
+--
+-- Licensed to the Apache Software Foundation (ASF) under one or more
+-- contributor license agreements. See the NOTICE file distributed with
+-- this work for additional information regarding copyright ownership.
+-- The ASF licenses this file to You under the Apache License, Version 2.0
+-- (the "License"); you may not use this file except in compliance with
+-- the License. You may obtain a copy of the License at
+--
+-- http://www.apache.org/licenses/LICENSE-2.0
+--
+-- Unless required by applicable law or agreed to in writing, software
+-- distributed under the License is distributed on an "AS IS" BASIS,
+-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+-- See the License for the specific language governing permissions and
+-- limitations under the License.
+--
+local plugin_name = "opentelemetry"
+local core = require("apisix.core")
+local plugin = require("apisix.plugin")
+local process = require("ngx.process")
+
+local always_off_sampler_new =
require("opentelemetry.trace.sampling.always_off_sampler").new
+local always_on_sampler_new =
require("opentelemetry.trace.sampling.always_on_sampler").new
+local parent_base_sampler_new =
require("opentelemetry.trace.sampling.parent_base_sampler").new
+local trace_id_ratio_sampler_new =
+
require("opentelemetry.trace.sampling.trace_id_ratio_sampler").new
+
+local exporter_client_new =
require("opentelemetry.trace.exporter.http_client").new
+local otlp_exporter_new = require("opentelemetry.trace.exporter.otlp").new
+local batch_span_processor_new =
require("opentelemetry.trace.batch_span_processor").new
+local id_generator = require("opentelemetry.trace.id_generator")
+local tracer_provider_new = require("opentelemetry.trace.tracer_provider").new
+
+local span_kind = require("opentelemetry.trace.span_kind")
+local span_status = require("opentelemetry.trace.span_status")
+local resource_new = require("opentelemetry.resource").new
+local attr = require("opentelemetry.attribute")
+
+local context_storage = require("opentelemetry.context_storage")
+local context = require("opentelemetry.context").new(context_storage)
+local carrier_new = require("opentelemetry.trace.propagation.carrier").new
+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
+local ipairs = ipairs
+local unpack = unpack
+
+local lrucache = core.lrucache.new({
+ type = 'plugin', count = 128, ttl = 24 * 60 * 60,
+})
+
+
+local attr_schema = {
+ type = "object",
+ properties = {
+ trace_id_source = {
+ type = "string",
+ enum = {"x-request-id", "random"},
+ description = "alternate use x-request-id as trace id",
+ default = "random",
+ },
+ resource = {
+ type = "object",
+ description = "additional resource",
+ additionalProperties = {{type = "boolean"}, {type = "number"},
{type = "string"}},
+ },
+ collector = {
+ type = "object",
+ description = "opentelemetry collector",
+ properties = {
+ address = {type = "string", description = "host:port", default
= "127.0.0.1:4317"},
+ request_timeout = {type = "integer", description = "second
uint", default = 3},
+ request_headers = {
+ type = "object",
+ description = "http headers",
+ additionalProperties = {
+ one_of = {{type = "boolean"},{type = "number"}, {type
= "string"}},
+ },
+ }
+ },
+ default = {address = "127.0.0.1:4317", request_timeout = 3}
+ },
+ batch_span_processor = {
+ type = "object",
+ description = "batch span processor",
+ properties = {
+ drop_on_queue_full = {
+ type = "boolean",
+ description = "if true, drop span when queue is full,"
+ .. " otherwise force process batches",
+ },
+ max_queue_size = {
+ type = "integer",
+ description = "maximum queue size to buffer spans for
delayed processing",
+ },
+ batch_timeout = {
+ type = "number",
+ description = "maximum duration for constructing a batch",
+ },
+ inactive_timeout = {
+ type = "number",
+ description = "maximum duration for processing batches",
+ },
+ max_export_batch_size = {
+ type = "integer",
+ description = "maximum number of spans to process in a
single batch",
+ }
+ },
+ default = {},
+ },
+ },
+}
+
+local schema = {
+ type = "object",
+ properties = {
+ sampler = {
+ type = "object",
+ properties = {
+ name = {
+ type = "string",
+ enum = {"always_on", "always_off", "trace_id_ratio",
"parent_base"},
+ title = "sampling strategy",
+ default = "always_off"
+ },
+ options = {
+ type = "object",
+ properties = {
+ fraction = {
+ type = "number", title = "trace_id_ratio
fraction", default = 0
+ },
+ root = {
+ type = "object",
+ title = "parent_base root sampler",
+ properties = {
+ name = {
+ type = "string",
+ enum = {"always_on", "always_off",
"trace_id_ratio"},
+ title = "sampling strategy",
+ default = "always_off"
+ },
+ options = {
+ type = "object",
+ properties = {
+ fraction = {
+ type = "number",
+ title = "trace_id_ratio fraction
parameter",
+ default = 0,
+ },
+ },
+ default = {fraction = 0}
+ }
+ },
+ default = {name = "always_off", options =
{fraction = 0}}
+ },
+ },
+ default = {fraction = 0, root = {name = "always_off"}}
+ }
+ },
+ default = {name = "always_off", options = {fraction = 0, root =
{name = "always_off"}}}
+ },
+ additional_attributes = {
+ type = "array",
+ items = {
+ type = "string",
+ minLength = 1,
+ }
+ }
+ }
+}
+
+
+local _M = {
+ version = 0.1,
+ priority = -1200, -- last running plugin, but before serverless post func
+ name = plugin_name,
+ schema = schema,
+ attr_schema = attr_schema,
+}
+
+
+function _M.check_schema(conf)
+ return core.schema.check(schema, conf)
+end
+
+
+local hostname
+local sampler_factory
+local plugin_info
+
+function _M.init()
+ if process.type() ~= "worker" then
+ return
+ end
+
+ sampler_factory = {
+ always_off = always_off_sampler_new,
+ always_on = always_on_sampler_new,
+ parent_base = parent_base_sampler_new,
+ trace_id_ratio = trace_id_ratio_sampler_new,
+ }
+ hostname = core.utils.gethostname()
+
+ plugin_info = plugin.plugin_attr(plugin_name) or {}
+ local ok, err = core.schema.check(attr_schema, plugin_info)
+ if not ok then
+ core.log.error("failed to check the plugin_attr[", plugin_name, "]",
+ ": ", err)
+ return
+ end
+
+ 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
+ return trace_id, id_generator.new_span_id()
+ end
+ end
+end
+
+
+local function create_tracer_obj(conf)
+ -- create exporter
+ local exporter =
otlp_exporter_new(exporter_client_new(plugin_info.collector.address,
+
plugin_info.collector.request_timeout,
+
plugin_info.collector.request_headers))
+ -- create span processor
+ local batch_span_processor = batch_span_processor_new(exporter,
+
plugin_info.batch_span_processor)
+ -- create sampler
+ local sampler
+ local sampler_name = conf.sampler.name
+ local sampler_options = conf.sampler.options
+ if sampler_name == "parent_base" then
+ local root_sampler
+ if sampler_options.root then
+ local name, fraction = sampler_options.root.name,
sampler_options.root.options.fraction
+ root_sampler = sampler_factory[name](fraction)
+ else
+ root_sampler = always_off_sampler_new()
+ end
+ sampler = sampler_factory[sampler_name](root_sampler)
+ else
+ sampler = sampler_factory[sampler_name](sampler_options.fraction)
+ end
+ local resource_attrs = {attr.string("hostname", hostname)}
+ if plugin_info.resource then
+ if not plugin_info.resource["service.name"] then
+ table.insert(resource_attrs, attr.string("service.name", "APISIX"))
+ end
+ for k, v in pairs(plugin_info.resource) do
+ if type(v) == "string" then
+ table.insert(resource_attrs, attr.string(k, v))
+ end
+ if type(v) == "number" then
+ table.insert(resource_attrs, attr.double(k, v))
+ end
+ if type(v) == "boolean" then
+ table.insert(resource_attrs, attr.bool(k, v))
+ end
+ end
+ end
+ -- create tracer provider
+ local tp = tracer_provider_new(batch_span_processor, {
+ resource = resource_new(unpack(resource_attrs)),
+ sampler = sampler,
+ })
+ -- create tracer
+ return tp:tracer("opentelemetry-lua")
+end
+
+
+function _M.access(conf, api_ctx)
+ local tracer, err = core.lrucache.plugin_ctx(lrucache, api_ctx, nil,
create_tracer_obj, conf)
+ if not tracer then
+ core.log.error("failed to fetch tracer object: ", err)
+ return
+ end
+
+ -- extract trace context from the headers of downstream HTTP request
+ local upstream_context = trace_context.extract(context, carrier_new())
+ local attributes = {
+ attr.string("service", api_ctx.service_name),
+ attr.string("route", api_ctx.route_name),
+ }
+ if conf.additional_attributes then
+ for _, key in ipairs(conf.additional_attributes) do
+ local val = api_ctx.var[key]
+ if val then
+ core.table.insert(attributes, attr.string(key, val))
+ end
+ end
+ end
+
+ local ctx, _ = tracer:start(upstream_context, api_ctx.var.request_uri, {
+ kind = span_kind.client,
+ attributes = attributes,
+ })
+ ctx:attach()
Review comment:
Let's add test to check the request_uri & attributes
##########
File path: t/plugin/opentelemetry.t
##########
@@ -0,0 +1,693 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+use t::APISIX 'no_plan';
+
+add_block_preprocessor(sub {
+ my ($block) = @_;
+
+ my $extra_yaml_config = <<_EOC_;
+plugins:
+ - opentelemetry
+plugin_attr:
+ opentelemetry:
+ batch_span_processor:
+ max_export_batch_size: 1
+ inactive_timeout: 0.5
+_EOC_
+
+ $block->set_value("extra_yaml_config", $extra_yaml_config);
+
+ my $extra_init_by_lua = <<_EOC_;
+ -- mock exporter http client
+ local client = require("opentelemetry.trace.exporter.http_client")
+ client.do_request = function()
+ ngx.log(ngx.INFO, "opentelemetry export span")
+ end
+_EOC_
+
+ $block->set_value("extra_init_by_lua", $extra_init_by_lua);
+
+ if (!$block->request) {
+ $block->set_value("request", "GET /t");
+ }
+
+ if (!$block->response_body) {
+ $block->set_value("response_body", "passed\n");
+ }
+
+ if (!$block->no_error_log && !$block->error_log) {
+ $block->set_value("no_error_log", "[error]");
+ }
+
+ $block;
+});
+
+repeat_each(1);
+no_long_string();
+no_root_location();
+log_level("debug");
+
+run_tests;
+
+__DATA__
+
+=== TEST 1: add plugin
+--- config
+ location /t {
+ content_by_lua_block {
+ local t = require("lib.test_admin").test
+ local code, body = t('/apisix/admin/routes/1',
+ ngx.HTTP_PUT,
+ [[{
+ "plugins": {
+ "opentelemetry": {
+ "sampler": {
+ "name": "always_on"
+ }
+ }
+ },
+ "upstream": {
+ "nodes": {
+ "127.0.0.1:1980": 1
+ },
+ "type": "roundrobin"
+ },
+ "uri": "/opentracing"
+ }]],
+ [[{
Review comment:
Would be better if we can remove the etcd response check:
```
[[{
"node": {
"value": {
"plugins": {
"opentelemetry": {
"sampler": {
"name": "always_on"
}
}
},
"upstream": {
"nodes": {
"127.0.0.1:1980": 1
},
"type": "roundrobin"
},
"uri": "/opentracing"
},
"key": "/apisix/routes/1"
},
"action": "set"
}]]
```
##########
File path: apisix/plugins/opentelemetry.lua
##########
@@ -0,0 +1,325 @@
+--
+-- Licensed to the Apache Software Foundation (ASF) under one or more
+-- contributor license agreements. See the NOTICE file distributed with
+-- this work for additional information regarding copyright ownership.
+-- The ASF licenses this file to You under the Apache License, Version 2.0
+-- (the "License"); you may not use this file except in compliance with
+-- the License. You may obtain a copy of the License at
+--
+-- http://www.apache.org/licenses/LICENSE-2.0
+--
+-- Unless required by applicable law or agreed to in writing, software
+-- distributed under the License is distributed on an "AS IS" BASIS,
+-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+-- See the License for the specific language governing permissions and
+-- limitations under the License.
+--
+local plugin_name = "opentelemetry"
+local core = require("apisix.core")
+local plugin = require("apisix.plugin")
+local process = require("ngx.process")
+
+local always_off_sampler_new =
require("opentelemetry.trace.sampling.always_off_sampler").new
+local always_on_sampler_new =
require("opentelemetry.trace.sampling.always_on_sampler").new
+local parent_base_sampler_new =
require("opentelemetry.trace.sampling.parent_base_sampler").new
+local trace_id_ratio_sampler_new =
+
require("opentelemetry.trace.sampling.trace_id_ratio_sampler").new
+
+local exporter_client_new =
require("opentelemetry.trace.exporter.http_client").new
+local otlp_exporter_new = require("opentelemetry.trace.exporter.otlp").new
+local batch_span_processor_new =
require("opentelemetry.trace.batch_span_processor").new
+local id_generator = require("opentelemetry.trace.id_generator")
+local tracer_provider_new = require("opentelemetry.trace.tracer_provider").new
+
+local span_kind = require("opentelemetry.trace.span_kind")
+local span_status = require("opentelemetry.trace.span_status")
+local resource_new = require("opentelemetry.resource").new
+local attr = require("opentelemetry.attribute")
+
+local context_storage = require("opentelemetry.context_storage")
+local context = require("opentelemetry.context").new(context_storage)
+local carrier_new = require("opentelemetry.trace.propagation.carrier").new
+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
+local ipairs = ipairs
+local unpack = unpack
+
+local lrucache = core.lrucache.new({
+ type = 'plugin', count = 128, ttl = 24 * 60 * 60,
+})
+
+
+local attr_schema = {
+ type = "object",
+ properties = {
+ trace_id_source = {
+ type = "string",
+ enum = {"x-request-id", "random"},
+ description = "alternate use x-request-id as trace id",
+ default = "random",
+ },
+ resource = {
+ type = "object",
+ description = "additional resource",
+ additionalProperties = {{type = "boolean"}, {type = "number"},
{type = "string"}},
+ },
+ collector = {
+ type = "object",
+ description = "opentelemetry collector",
+ properties = {
+ address = {type = "string", description = "host:port", default
= "127.0.0.1:4317"},
+ request_timeout = {type = "integer", description = "second
uint", default = 3},
+ request_headers = {
+ type = "object",
+ description = "http headers",
+ additionalProperties = {
+ one_of = {{type = "boolean"},{type = "number"}, {type
= "string"}},
+ },
+ }
+ },
+ default = {address = "127.0.0.1:4317", request_timeout = 3}
+ },
+ batch_span_processor = {
+ type = "object",
+ description = "batch span processor",
+ properties = {
+ drop_on_queue_full = {
+ type = "boolean",
+ description = "if true, drop span when queue is full,"
+ .. " otherwise force process batches",
+ },
+ max_queue_size = {
+ type = "integer",
+ description = "maximum queue size to buffer spans for
delayed processing",
+ },
+ batch_timeout = {
+ type = "number",
+ description = "maximum duration for constructing a batch",
+ },
+ inactive_timeout = {
+ type = "number",
+ description = "maximum duration for processing batches",
+ },
+ max_export_batch_size = {
+ type = "integer",
+ description = "maximum number of spans to process in a
single batch",
+ }
+ },
+ default = {},
+ },
+ },
+}
+
+local schema = {
+ type = "object",
+ properties = {
+ sampler = {
+ type = "object",
+ properties = {
+ name = {
+ type = "string",
+ enum = {"always_on", "always_off", "trace_id_ratio",
"parent_base"},
+ title = "sampling strategy",
+ default = "always_off"
+ },
+ options = {
+ type = "object",
+ properties = {
+ fraction = {
+ type = "number", title = "trace_id_ratio
fraction", default = 0
+ },
+ root = {
+ type = "object",
+ title = "parent_base root sampler",
+ properties = {
+ name = {
+ type = "string",
+ enum = {"always_on", "always_off",
"trace_id_ratio"},
+ title = "sampling strategy",
+ default = "always_off"
+ },
+ options = {
+ type = "object",
+ properties = {
+ fraction = {
+ type = "number",
+ title = "trace_id_ratio fraction
parameter",
+ default = 0,
+ },
+ },
+ default = {fraction = 0}
+ }
+ },
+ default = {name = "always_off", options =
{fraction = 0}}
+ },
+ },
+ default = {fraction = 0, root = {name = "always_off"}}
+ }
+ },
+ default = {name = "always_off", options = {fraction = 0, root =
{name = "always_off"}}}
+ },
+ additional_attributes = {
+ type = "array",
+ items = {
+ type = "string",
+ minLength = 1,
+ }
+ }
+ }
+}
+
+
+local _M = {
+ version = 0.1,
+ priority = -1200, -- last running plugin, but before serverless post func
+ name = plugin_name,
+ schema = schema,
+ attr_schema = attr_schema,
+}
+
+
+function _M.check_schema(conf)
+ return core.schema.check(schema, conf)
+end
+
+
+local hostname
+local sampler_factory
+local plugin_info
+
+function _M.init()
+ if process.type() ~= "worker" then
+ return
+ end
+
+ sampler_factory = {
+ always_off = always_off_sampler_new,
+ always_on = always_on_sampler_new,
+ parent_base = parent_base_sampler_new,
+ trace_id_ratio = trace_id_ratio_sampler_new,
+ }
+ hostname = core.utils.gethostname()
+
+ plugin_info = plugin.plugin_attr(plugin_name) or {}
+ local ok, err = core.schema.check(attr_schema, plugin_info)
+ if not ok then
+ core.log.error("failed to check the plugin_attr[", plugin_name, "]",
+ ": ", err)
+ return
+ end
+
+ 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
+ return trace_id, id_generator.new_span_id()
+ end
+ end
+end
+
+
+local function create_tracer_obj(conf)
+ -- create exporter
+ local exporter =
otlp_exporter_new(exporter_client_new(plugin_info.collector.address,
+
plugin_info.collector.request_timeout,
+
plugin_info.collector.request_headers))
+ -- create span processor
+ local batch_span_processor = batch_span_processor_new(exporter,
+
plugin_info.batch_span_processor)
+ -- create sampler
+ local sampler
+ local sampler_name = conf.sampler.name
+ local sampler_options = conf.sampler.options
+ if sampler_name == "parent_base" then
+ local root_sampler
+ if sampler_options.root then
+ local name, fraction = sampler_options.root.name,
sampler_options.root.options.fraction
+ root_sampler = sampler_factory[name](fraction)
+ else
+ root_sampler = always_off_sampler_new()
+ end
+ sampler = sampler_factory[sampler_name](root_sampler)
+ else
+ sampler = sampler_factory[sampler_name](sampler_options.fraction)
+ end
+ local resource_attrs = {attr.string("hostname", hostname)}
+ if plugin_info.resource then
+ if not plugin_info.resource["service.name"] then
+ table.insert(resource_attrs, attr.string("service.name", "APISIX"))
+ end
+ for k, v in pairs(plugin_info.resource) do
+ if type(v) == "string" then
+ table.insert(resource_attrs, attr.string(k, v))
+ end
+ if type(v) == "number" then
+ table.insert(resource_attrs, attr.double(k, v))
+ end
+ if type(v) == "boolean" then
+ table.insert(resource_attrs, attr.bool(k, v))
+ end
+ end
+ end
+ -- create tracer provider
+ local tp = tracer_provider_new(batch_span_processor, {
+ resource = resource_new(unpack(resource_attrs)),
+ sampler = sampler,
+ })
+ -- create tracer
+ return tp:tracer("opentelemetry-lua")
+end
+
+
+function _M.access(conf, api_ctx)
+ local tracer, err = core.lrucache.plugin_ctx(lrucache, api_ctx, nil,
create_tracer_obj, conf)
+ if not tracer then
+ core.log.error("failed to fetch tracer object: ", err)
+ return
+ end
+
+ -- extract trace context from the headers of downstream HTTP request
+ local upstream_context = trace_context.extract(context, carrier_new())
+ local attributes = {
+ attr.string("service", api_ctx.service_name),
+ attr.string("route", api_ctx.route_name),
+ }
+ if conf.additional_attributes then
+ for _, key in ipairs(conf.additional_attributes) do
+ local val = api_ctx.var[key]
+ if val then
+ core.table.insert(attributes, attr.string(key, val))
+ end
+ end
+ end
+
+ local ctx, _ = tracer:start(upstream_context, api_ctx.var.request_uri, {
+ kind = span_kind.client,
+ attributes = attributes,
+ })
+ ctx:attach()
+
+ -- inject trace context into the headers of upstream HTTP request
+ trace_context.inject(ctx, carrier_new())
+end
+
+
+function _M.body_filter(conf, ctx)
+ if ngx.arg[2] then
+ local upstream_status = core.response.get_upstream_status(ctx)
+ -- get span from current context
+ local span = context:current():span()
+ if upstream_status and upstream_status >= 500 then
+ span:set_status(span_status.error,
+ "upstream response status: " .. upstream_status)
+ end
+
+ span:finish()
Review comment:
Look like the span is not finished if the response doesn't have a body.
##########
File path: docs/en/latest/plugins/opentelemetry.md
##########
@@ -0,0 +1,153 @@
+---
+title: opentelemetry
+---
+
+<!--
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+-->
+
+## Summary
+
+- [**Name**](#name)
+- [**Attributes**](#attributes)
+- [**How To Enable**](#how-to-enable)
+- [**How to set collecting**](#how-to-set-collecting)
+- [**Disable Plugin**](#disable-plugin)
+
+## Name
+
+[OpenTelemetry](https://opentelemetry.io/) report Tracing data according to
[opentelemetry
specification](https://github.com/open-telemetry/opentelemetry-specification).
+
+Just support reporting in `HTTP` with `Content-Type=application/x-protobuf`,
the specification: [OTLP/HTTP
Request](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/otlp.md#otlphttp-request)。
+
+## Attributes
+
+| Name | Type | Requirement | Default | Valid | Description
|
+| ------------ | ------ | ------ | -------- | ------------ |
----------------------------------------------------- |
+| sampler | object | optional | | | sampling config
+| sampler.name | string | optional | always_off | ["always_on", "always_off",
"trace_id_ratio", "parent_base"] | sampling strategy，always_on：sampling
all；always_off：sampling nothing；trace_id_ratio：base trace id
percentage；parent_base：use parent decision, otherwise determined by root
+| sampler.options | object | optional | | {fraction = 0, root = {name =
"always_off"}} | sampling strategy parameters
+| sampler.options.fraction | number | optional | 0 | [0, 1] | trace_id_ratio
fraction
+| sampler.options.root | object | optional | {name = "always_off", options =
{fraction = 0}} | | parent_base root sampler
+| sampler.options.root.name | string | optional | always_off | ["always_on",
"always_off", "trace_id_ratio"] | sampling strategy
+| sampler.options.root.options | object | optional | {fraction = 0} | |
sampling strategy parameters
+| sampler.options.root.options.fraction | number | optional | 0 | [0, 1] |
trace_id_ratio fraction
+| additional_attributes | array[string] | optional | | | append to trace span
attributes
Review comment:
```suggestion
| additional_attributes | array[string] | optional | | | attributes
(variable and its value) which will be appended to the trace span
```
##########
File path: docs/en/latest/plugins/opentelemetry.md
##########
@@ -0,0 +1,153 @@
+---
+title: opentelemetry
+---
+
+<!--
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+-->
+
+## Summary
+
+- [**Name**](#name)
+- [**Attributes**](#attributes)
+- [**How To Enable**](#how-to-enable)
+- [**How to set collecting**](#how-to-set-collecting)
+- [**Disable Plugin**](#disable-plugin)
+
+## Name
+
+[OpenTelemetry](https://opentelemetry.io/) report Tracing data according to
[opentelemetry
specification](https://github.com/open-telemetry/opentelemetry-specification).
+
+Just support reporting in `HTTP` with `Content-Type=application/x-protobuf`,
the specification: [OTLP/HTTP
Request](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/otlp.md#otlphttp-request)。
+
+## Attributes
+
+| Name | Type | Requirement | Default | Valid | Description
|
+| ------------ | ------ | ------ | -------- | ------------ |
----------------------------------------------------- |
+| sampler | object | optional | | | sampling config
+| sampler.name | string | optional | always_off | ["always_on", "always_off",
"trace_id_ratio", "parent_base"] | sampling strategy，always_on：sampling
all；always_off：sampling nothing；trace_id_ratio：base trace id
percentage；parent_base：use parent decision, otherwise determined by root
+| sampler.options | object | optional | | {fraction = 0, root = {name =
"always_off"}} | sampling strategy parameters
+| sampler.options.fraction | number | optional | 0 | [0, 1] | trace_id_ratio
fraction
+| sampler.options.root | object | optional | {name = "always_off", options =
{fraction = 0}} | | parent_base root sampler
+| sampler.options.root.name | string | optional | always_off | ["always_on",
"always_off", "trace_id_ratio"] | sampling strategy
+| sampler.options.root.options | object | optional | {fraction = 0} | |
sampling strategy parameters
+| sampler.options.root.options.fraction | number | optional | 0 | [0, 1] |
trace_id_ratio fraction
+| additional_attributes | array[string] | optional | | | append to trace span
attributes
+| additional_attributes[0] | string | required | | | key of ctx.var
Review comment:
```suggestion
| additional_attributes[0] | string | required | | | APISIX or Nginx
variable, like `http_header` or `route_id`
```
##########
File path: apisix/plugins/opentelemetry.lua
##########
@@ -0,0 +1,325 @@
+--
+-- Licensed to the Apache Software Foundation (ASF) under one or more
+-- contributor license agreements. See the NOTICE file distributed with
+-- this work for additional information regarding copyright ownership.
+-- The ASF licenses this file to You under the Apache License, Version 2.0
+-- (the "License"); you may not use this file except in compliance with
+-- the License. You may obtain a copy of the License at
+--
+-- http://www.apache.org/licenses/LICENSE-2.0
+--
+-- Unless required by applicable law or agreed to in writing, software
+-- distributed under the License is distributed on an "AS IS" BASIS,
+-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+-- See the License for the specific language governing permissions and
+-- limitations under the License.
+--
+local plugin_name = "opentelemetry"
+local core = require("apisix.core")
+local plugin = require("apisix.plugin")
+local process = require("ngx.process")
+
+local always_off_sampler_new =
require("opentelemetry.trace.sampling.always_off_sampler").new
+local always_on_sampler_new =
require("opentelemetry.trace.sampling.always_on_sampler").new
+local parent_base_sampler_new =
require("opentelemetry.trace.sampling.parent_base_sampler").new
+local trace_id_ratio_sampler_new =
+
require("opentelemetry.trace.sampling.trace_id_ratio_sampler").new
+
+local exporter_client_new =
require("opentelemetry.trace.exporter.http_client").new
+local otlp_exporter_new = require("opentelemetry.trace.exporter.otlp").new
+local batch_span_processor_new =
require("opentelemetry.trace.batch_span_processor").new
+local id_generator = require("opentelemetry.trace.id_generator")
+local tracer_provider_new = require("opentelemetry.trace.tracer_provider").new
+
+local span_kind = require("opentelemetry.trace.span_kind")
+local span_status = require("opentelemetry.trace.span_status")
+local resource_new = require("opentelemetry.resource").new
+local attr = require("opentelemetry.attribute")
+
+local context_storage = require("opentelemetry.context_storage")
+local context = require("opentelemetry.context").new(context_storage)
+local carrier_new = require("opentelemetry.trace.propagation.carrier").new
+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
+local ipairs = ipairs
+local unpack = unpack
+
+local lrucache = core.lrucache.new({
+ type = 'plugin', count = 128, ttl = 24 * 60 * 60,
+})
+
+
+local attr_schema = {
+ type = "object",
+ properties = {
+ trace_id_source = {
+ type = "string",
+ enum = {"x-request-id", "random"},
+ description = "alternate use x-request-id as trace id",
+ default = "random",
+ },
+ resource = {
+ type = "object",
+ description = "additional resource",
+ additionalProperties = {{type = "boolean"}, {type = "number"},
{type = "string"}},
+ },
+ collector = {
+ type = "object",
+ description = "opentelemetry collector",
+ properties = {
+ address = {type = "string", description = "host:port", default
= "127.0.0.1:4317"},
+ request_timeout = {type = "integer", description = "second
uint", default = 3},
+ request_headers = {
+ type = "object",
+ description = "http headers",
+ additionalProperties = {
+ one_of = {{type = "boolean"},{type = "number"}, {type
= "string"}},
+ },
+ }
+ },
+ default = {address = "127.0.0.1:4317", request_timeout = 3}
+ },
+ batch_span_processor = {
+ type = "object",
+ description = "batch span processor",
+ properties = {
+ drop_on_queue_full = {
+ type = "boolean",
+ description = "if true, drop span when queue is full,"
+ .. " otherwise force process batches",
+ },
+ max_queue_size = {
+ type = "integer",
+ description = "maximum queue size to buffer spans for
delayed processing",
+ },
+ batch_timeout = {
+ type = "number",
+ description = "maximum duration for constructing a batch",
+ },
+ inactive_timeout = {
+ type = "number",
+ description = "maximum duration for processing batches",
+ },
+ max_export_batch_size = {
+ type = "integer",
+ description = "maximum number of spans to process in a
single batch",
+ }
+ },
+ default = {},
+ },
+ },
+}
+
+local schema = {
+ type = "object",
+ properties = {
+ sampler = {
+ type = "object",
+ properties = {
+ name = {
+ type = "string",
+ enum = {"always_on", "always_off", "trace_id_ratio",
"parent_base"},
+ title = "sampling strategy",
+ default = "always_off"
+ },
+ options = {
+ type = "object",
+ properties = {
+ fraction = {
+ type = "number", title = "trace_id_ratio
fraction", default = 0
+ },
+ root = {
+ type = "object",
+ title = "parent_base root sampler",
+ properties = {
+ name = {
+ type = "string",
+ enum = {"always_on", "always_off",
"trace_id_ratio"},
+ title = "sampling strategy",
+ default = "always_off"
+ },
+ options = {
+ type = "object",
+ properties = {
+ fraction = {
+ type = "number",
+ title = "trace_id_ratio fraction
parameter",
+ default = 0,
+ },
+ },
+ default = {fraction = 0}
+ }
+ },
+ default = {name = "always_off", options =
{fraction = 0}}
+ },
+ },
+ default = {fraction = 0, root = {name = "always_off"}}
+ }
+ },
+ default = {name = "always_off", options = {fraction = 0, root =
{name = "always_off"}}}
+ },
+ additional_attributes = {
+ type = "array",
+ items = {
+ type = "string",
+ minLength = 1,
+ }
+ }
+ }
+}
+
+
+local _M = {
+ version = 0.1,
+ priority = -1200, -- last running plugin, but before serverless post func
+ name = plugin_name,
+ schema = schema,
+ attr_schema = attr_schema,
+}
+
+
+function _M.check_schema(conf)
+ return core.schema.check(schema, conf)
+end
+
+
+local hostname
+local sampler_factory
+local plugin_info
+
+function _M.init()
+ if process.type() ~= "worker" then
+ return
+ end
+
+ sampler_factory = {
+ always_off = always_off_sampler_new,
+ always_on = always_on_sampler_new,
+ parent_base = parent_base_sampler_new,
+ trace_id_ratio = trace_id_ratio_sampler_new,
+ }
+ hostname = core.utils.gethostname()
+
+ plugin_info = plugin.plugin_attr(plugin_name) or {}
+ local ok, err = core.schema.check(attr_schema, plugin_info)
+ if not ok then
+ core.log.error("failed to check the plugin_attr[", plugin_name, "]",
+ ": ", err)
+ return
+ end
+
+ 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
+ return trace_id, id_generator.new_span_id()
+ end
+ end
+end
+
+
+local function create_tracer_obj(conf)
+ -- create exporter
+ local exporter =
otlp_exporter_new(exporter_client_new(plugin_info.collector.address,
+
plugin_info.collector.request_timeout,
+
plugin_info.collector.request_headers))
+ -- create span processor
+ local batch_span_processor = batch_span_processor_new(exporter,
+
plugin_info.batch_span_processor)
+ -- create sampler
+ local sampler
+ local sampler_name = conf.sampler.name
+ local sampler_options = conf.sampler.options
+ if sampler_name == "parent_base" then
+ local root_sampler
+ if sampler_options.root then
+ local name, fraction = sampler_options.root.name,
sampler_options.root.options.fraction
+ root_sampler = sampler_factory[name](fraction)
+ else
+ root_sampler = always_off_sampler_new()
+ end
+ sampler = sampler_factory[sampler_name](root_sampler)
+ else
+ sampler = sampler_factory[sampler_name](sampler_options.fraction)
+ end
+ local resource_attrs = {attr.string("hostname", hostname)}
+ if plugin_info.resource then
+ if not plugin_info.resource["service.name"] then
+ table.insert(resource_attrs, attr.string("service.name", "APISIX"))
+ end
+ for k, v in pairs(plugin_info.resource) do
+ if type(v) == "string" then
+ table.insert(resource_attrs, attr.string(k, v))
+ end
+ if type(v) == "number" then
+ table.insert(resource_attrs, attr.double(k, v))
+ end
+ if type(v) == "boolean" then
+ table.insert(resource_attrs, attr.bool(k, v))
+ end
+ end
+ end
+ -- create tracer provider
+ local tp = tracer_provider_new(batch_span_processor, {
+ resource = resource_new(unpack(resource_attrs)),
+ sampler = sampler,
+ })
+ -- create tracer
+ return tp:tracer("opentelemetry-lua")
+end
+
+
+function _M.access(conf, api_ctx)
+ local tracer, err = core.lrucache.plugin_ctx(lrucache, api_ctx, nil,
create_tracer_obj, conf)
+ if not tracer then
+ core.log.error("failed to fetch tracer object: ", err)
+ return
+ end
+
+ -- extract trace context from the headers of downstream HTTP request
+ local upstream_context = trace_context.extract(context, carrier_new())
+ local attributes = {
+ attr.string("service", api_ctx.service_name),
+ attr.string("route", api_ctx.route_name),
+ }
+ if conf.additional_attributes then
+ for _, key in ipairs(conf.additional_attributes) do
+ local val = api_ctx.var[key]
+ if val then
+ core.table.insert(attributes, attr.string(key, val))
+ end
+ end
+ end
+
+ local ctx, _ = tracer:start(upstream_context, api_ctx.var.request_uri, {
+ kind = span_kind.client,
+ attributes = attributes,
+ })
+ ctx:attach()
+
+ -- inject trace context into the headers of upstream HTTP request
+ trace_context.inject(ctx, carrier_new())
+end
+
+
+function _M.body_filter(conf, ctx)
+ if ngx.arg[2] then
+ local upstream_status = core.response.get_upstream_status(ctx)
+ -- get span from current context
+ local span = context:current():span()
+ if upstream_status and upstream_status >= 500 then
+ span:set_status(span_status.error,
Review comment:
Let's add test to check `span_status.error`
##########
File path: t/plugin/opentelemetry.t
##########
@@ -0,0 +1,673 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+use t::APISIX 'no_plan';
+
+add_block_preprocessor(sub {
+ my ($block) = @_;
+
+ my $extra_yaml_config = <<_EOC_;
+plugins:
+ - opentelemetry
+plugin_attr:
+ opentelemetry:
+ batch_span_processor:
+ max_export_batch_size: 1
+ inactive_timeout: 0.5
+_EOC_
+
+ $block->set_value("extra_yaml_config", $extra_yaml_config);
+
+ my $extra_init_by_lua = <<_EOC_;
+ -- mock exporter http client
+ local client = require("opentelemetry.trace.exporter.http_client")
+ client.do_request = function()
+ ngx.log(ngx.INFO, "opentelemetry export span")
+ end
+_EOC_
+
+ $block->set_value("extra_init_by_lua", $extra_init_by_lua);
+
+ if (!$block->request) {
+ $block->set_value("request", "GET /t");
+ }
+
+ if (!$block->response_body) {
+ $block->set_value("response_body", "passed\n");
+ }
+
+ if (!$block->no_error_log && !$block->error_log) {
+ $block->set_value("no_error_log", "[error]");
+ }
+
+ $block;
+});
+
+repeat_each(1);
+no_long_string();
+no_root_location();
+log_level("debug");
+
+run_tests;
+
+__DATA__
+
+=== TEST 1: add plugin
+--- config
+ location /t {
+ content_by_lua_block {
+ local t = require("lib.test_admin").test
+ local code, body = t('/apisix/admin/routes/1',
+ ngx.HTTP_PUT,
+ [[{
+ "plugins": {
+ "opentelemetry": {
+ "sampler": {
+ "name": "always_on"
+ }
+ }
+ },
+ "upstream": {
+ "nodes": {
+ "127.0.0.1:1980": 1
+ },
+ "type": "roundrobin"
+ },
+ "uri": "/opentracing"
+ }]],
+ [[{
+ "node": {
+ "value": {
+ "plugins": {
+ "opentelemetry": {
+ "sampler": {
+ "name": "always_on"
+ }
+ }
+ },
+ "upstream": {
+ "nodes": {
+ "127.0.0.1:1980": 1
+ },
+ "type": "roundrobin"
+ },
+ "uri": "/opentracing"
+ },
+ "key": "/apisix/routes/1"
+ },
+ "action": "set"
+ }]]
+ )
+
+ if code >= 300 then
+ ngx.status = code
+ end
+ ngx.say(body)
+ }
+ }
+
+
+
+=== TEST 2: trigger opentelemetry
+--- request
+GET /opentracing
+--- response_body
+opentracing
+--- wait: 1
+--- grep_error_log eval
+qr/opentelemetry export span/
+--- grep_error_log_out
+opentelemetry export span
+
+
+
+=== TEST 3: use default always_off sampler
+--- config
+ location /t {
+ content_by_lua_block {
+ local t = require("lib.test_admin").test
+ local code, body = t('/apisix/admin/routes/1',
+ ngx.HTTP_PUT,
+ [[{
+ "plugins": {
+ "opentelemetry": {
+ }
+ },
+ "upstream": {
+ "nodes": {
+ "127.0.0.1:1980": 1
+ },
+ "type": "roundrobin"
+ },
+ "uri": "/opentracing"
+ }]],
+ [[{
Review comment:
Ditto
##########
File path: docs/en/latest/plugins/opentelemetry.md
##########
@@ -0,0 +1,153 @@
+---
+title: opentelemetry
+---
+
+<!--
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+-->
+
+## Summary
+
+- [**Name**](#name)
+- [**Attributes**](#attributes)
+- [**How To Enable**](#how-to-enable)
+- [**How to set collecting**](#how-to-set-collecting)
+- [**Disable Plugin**](#disable-plugin)
+
+## Name
+
+[OpenTelemetry](https://opentelemetry.io/) report Tracing data according to
[opentelemetry
specification](https://github.com/open-telemetry/opentelemetry-specification).
+
+Just support reporting in `HTTP` with `Content-Type=application/x-protobuf`,
the specification: [OTLP/HTTP
Request](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/otlp.md#otlphttp-request)。
+
+## Attributes
+
+| Name | Type | Requirement | Default | Valid | Description
|
+| ------------ | ------ | ------ | -------- | ------------ |
----------------------------------------------------- |
+| sampler | object | optional | | | sampling config
+| sampler.name | string | optional | always_off | ["always_on", "always_off",
"trace_id_ratio", "parent_base"] | sampling strategy，always_on：sampling
all；always_off：sampling nothing；trace_id_ratio：base trace id
percentage；parent_base：use parent decision, otherwise determined by root
+| sampler.options | object | optional | | {fraction = 0, root = {name =
"always_off"}} | sampling strategy parameters
+| sampler.options.fraction | number | optional | 0 | [0, 1] | trace_id_ratio
fraction
+| sampler.options.root | object | optional | {name = "always_off", options =
{fraction = 0}} | | parent_base root sampler
+| sampler.options.root.name | string | optional | always_off | ["always_on",
"always_off", "trace_id_ratio"] | sampling strategy
+| sampler.options.root.options | object | optional | {fraction = 0} | |
sampling strategy parameters
+| sampler.options.root.options.fraction | number | optional | 0 | [0, 1] |
trace_id_ratio fraction
+| additional_attributes | array[string] | optional | | | append to trace span
attributes
+| additional_attributes[0] | string | required | | | key of ctx.var
+
+## How To Enable
+
+First of all, enable the opentelemetry plugin in the `config.yaml`:
+
+```yaml
+# Add this in config.yaml
+plugins:
+ - ... # plugin you need
+ - opentelemetry
+```
+
+Then reload APISIX.
+
+Here's an example, enable the opentelemetry plugin on the specified route:
+
+```shell
+curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY:
edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
+{
+ "methods": ["GET"],
+ "uris": [
+ "/uid/*"
+ ],
+ "plugins": {
+ "opentelemetry": {
+ sampler": {
+ "name": "always_on",
+ }
+ }
+ },
+ "upstream": {
+ "type": "roundrobin",
+ "nodes": {
+ "10.110.149.175:8089": 1
+ }
+ }
+}'
+```
+
+## How to set collecting
+
+We can set the collecting by specifying the configuration in
`conf/config.yaml`.
+
+| Name | Type | Default | Description
|
+| ------------ | ------ | -------- |
----------------------------------------------------- |
+| trace_id_source | enum | random | alternate use x-request-id as trace id,
valid value is `random` or `x-request-id`, if use `x-request-id`, please make
sure it match regex pattern `[0-9a-f]{32}` |
Review comment:
```suggestion
| trace_id_source | enum | random | the source of trace id, the valid value
is `random` or `x-request-id`. If `x-request-id` is set, the value of
`x-request-id` request header will be used as trace id. Please make sure it
match regex pattern `[0-9a-f]{32}` |
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
