You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@apisix.apache.org by GitBox <gi...@apache.org> on 2022/01/16 11:06:28 UTC
[GitHub] [apisix] yangxikun opened a new pull request #6119: feature: add opentelemetry plugin. (#3891)
yangxikun opened a new pull request #6119:
URL: https://github.com/apache/apisix/pull/6119
### What this PR does / why we need it:
<!--- Why is this change required? What problem does it solve? -->
<!--- If it fixes an open issue, please link to the issue here. -->
Add opentelemetry plugin.
### Pre-submission checklist:
<!--
Please follow the PR manners:
1. Use Draft if the PR is not ready to be reviewed
2. Test is required for the feat/fix PR, unless you have a good reason
3. Doc is required for the feat PR
4. Use a new commit to resolve review instead of `push -f`
5. If you need to resolve merge conflicts after the PR is reviewed, please merge master but do not rebase
6. Use "request review" to notify the reviewer once you have resolved the review
7. Only reviewer can click "Resolve conversation" to mark the reviewer's review resolved
-->
* [x] Did you explain what problem does this PR solve? Or what new features have been added?
* [x] Have you added corresponding test cases?
* [x] Have you modified the corresponding document?
* [x] Is this PR backward compatible? **If it is not backward compatible, please discuss on the [mailing list](https://github.com/apache/apisix/tree/master#community) first**
--
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: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] moonming commented on pull request #6119: feat: add opentelemetry plugin
Posted by GitBox <gi...@apache.org>.
moonming commented on pull request #6119:
URL: https://github.com/apache/apisix/pull/6119#issuecomment-1020740645
> @yangxikun is it possible to make an `opentelemetry-lua` repo like https://github.com/open-telemetry/opentelemetry-go?
got it https://github.com/apache/apisix/pull/6119/files#diff-c6a774885b1f6ef5f4cb5d027eb59cf81d6065588e3e7c5620814b3d0819ec1eR76
--
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: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] spacewander commented on a change in pull request #6119: feat: add opentelemetry plugin #3891
Posted by GitBox <gi...@apache.org>.
spacewander commented on a change in pull request #6119:
URL: https://github.com/apache/apisix/pull/6119#discussion_r786381242
##########
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?
--
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: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] moonming edited a comment on pull request #6119: feat: add opentelemetry plugin
Posted by GitBox <gi...@apache.org>.
moonming edited a comment on pull request #6119:
URL: https://github.com/apache/apisix/pull/6119#issuecomment-1020739131
@yangxikun is it possible to make an `opentelemetry-lua` repo like https://github.com/open-telemetry/opentelemetry-go?
--
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: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] leslie-tsang commented on a change in pull request #6119: feature: add opentelemetry plugin. (#3891)
Posted by GitBox <gi...@apache.org>.
leslie-tsang commented on a change in pull request #6119:
URL: https://github.com/apache/apisix/pull/6119#discussion_r785445833
##########
File path: docs/en/latest/plugins/opentelemetry.md
##########
@@ -0,0 +1,154 @@
+---
+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 report Tracing data according to [opentelemetry specification](https://github.com/open-telemetry/opentelemetry-specification).
Review comment:
```suggestion
[OpenTelemetry](https://opentelemetry.io/) report Tracing data according to [opentelemetry specification](https://github.com/open-telemetry/opentelemetry-specification).
```
##########
File path: docs/zh/latest/plugins/opentelemetry.md
##########
@@ -0,0 +1,152 @@
+---
+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.
+#
+-->
+
+## 目录
+
+- [名字](#名字)
+- [属性](#属性)
+- [如何启用](#如何启用)
+- [如何设置数据上报](#如何设置数据上报)
+- [禁用插件](#禁用插件)
+
+## 名字
+
+opentelemetry 提供符合 [opentelemetry specification](https://github.com/open-telemetry/opentelemetry-specification) 协议规范的 Tracing 数据上报。
+
+只支持 HTTP 协议 application/x-protobuf 类型的数据上报，相关协议标准：[OTLP/HTTP Request](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/otlp.md#otlphttp-request)。
+
+## 属性
+
+| 名称 | 类型 | 必选项 | 默认值 | 有效值 | 描述 |
+| ------------ | ------ | ------ | -------- | ------------ | ----------------------------------------------------- |
+| sampler | object | 可选 | | | 采样配置
+| sampler.name | string | 可选 | always_off | ["always_on", "always_off", "trace_id_ratio", "parent_base"] | 采样算法，always_on：全采样；always_off：不采样；trace_id_ratio：基于 trace id 的百分比采样；parent_base：如果存在 tracing 上游，则使用上游的采样决定，否则使用配置的采样算法决策
+| sampler.options | object | 可选 | | {fraction = 0, root = {name = "always_off"}} | 采样算法参数
+| sampler.options.fraction | number | 可选 | 0 | [0, 1] | trace_id_ratio 采样算法的百分比
+| sampler.options.root | object | 可选 | {name = "always_off", options = {fraction = 0}} | | parent_base 采样算法在没有上游 tracing 时，会使用 root 采样算法做决策
+| sampler.options.root.name | string | 可选 | always_off | ["always_on", "always_off", "trace_id_ratio"] | 采样算法
+| sampler.options.root.options | object | 可选 | {fraction = 0} | | 采样算法参数
+| sampler.options.root.options.fraction | number | 可选 | 0 | [0, 1] | trace_id_ratio 采样算法的百分比
+| tags | array[object] | 可选 | | | 追加到 trace span 的属性
+| tags.position | string | 必须 | | ["http", "arg", "cookie"] | 变量的位置
+| tags.name | string | 必须 | | | 变量的名称
+
+## 如何启用
+
+首先，你需要在 `config.yaml` 里面启用 opentelemetry 插件：
+
+```
Review comment:
```suggestion
```yaml
```
##########
File path: docs/en/latest/plugins/opentelemetry.md
##########
@@ -0,0 +1,154 @@
+---
+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 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)。
Review comment:
```suggestion
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)。
```
##########
File path: t/plugin/opentelemetry.t
##########
@@ -0,0 +1,729 @@
+#
+# 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);
+
+ $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)
+ }
+ }
+--- request
+GET /t
+--- response_body
+passed
+--- no_error_log
+[error]
Review comment:
Shall we optimize it this way ?
```perl
add_block_preprocessor(sub {
my ($block) = @_;
if (!$block->request) {
$block->set_value("request", "GET /t");
}
if ((!defined $block->error_log) && (!defined $block->no_error_log)) {
$block->set_value("no_error_log", "[error]");
}
});
```
##########
File path: docs/zh/latest/plugins/opentelemetry.md
##########
@@ -0,0 +1,152 @@
+---
+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.
+#
+-->
+
+## 目录
+
+- [名字](#名字)
+- [属性](#属性)
+- [如何启用](#如何启用)
+- [如何设置数据上报](#如何设置数据上报)
+- [禁用插件](#禁用插件)
+
+## 名字
+
+opentelemetry 提供符合 [opentelemetry specification](https://github.com/open-telemetry/opentelemetry-specification) 协议规范的 Tracing 数据上报。
Review comment:
```suggestion
[OpenTelemetry](https://opentelemetry.io/) 提供符合 [opentelemetry specification](https://github.com/open-telemetry/opentelemetry-specification) 协议规范的 Tracing 数据上报。
```
##########
File path: apisix/plugins/opentelemetry.lua
##########
@@ -0,0 +1,275 @@
+local plugin_name = "opentelemetry"
Review comment:
Need to add Apache Lic
##########
File path: docs/zh/latest/plugins/opentelemetry.md
##########
@@ -0,0 +1,152 @@
+---
+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.
+#
+-->
+
+## 目录
+
+- [名字](#名字)
+- [属性](#属性)
+- [如何启用](#如何启用)
+- [如何设置数据上报](#如何设置数据上报)
+- [禁用插件](#禁用插件)
+
+## 名字
+
+opentelemetry 提供符合 [opentelemetry specification](https://github.com/open-telemetry/opentelemetry-specification) 协议规范的 Tracing 数据上报。
+
+只支持 HTTP 协议 application/x-protobuf 类型的数据上报，相关协议标准：[OTLP/HTTP Request](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/otlp.md#otlphttp-request)。
Review comment:
Ditto, Seems to be out of sync with the en docs.
##########
File path: apisix/plugins/opentelemetry.lua
##########
@@ -0,0 +1,275 @@
+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_var = ngx.var
+local ngx_req = ngx.req
Review comment:
```suggestion
local ngx = ngx
local ngx_var = ngx.var
local ngx_req = ngx.req
local table = table
```
##########
File path: docs/en/latest/plugins/opentelemetry.md
##########
@@ -0,0 +1,154 @@
+---
+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 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
+| tags | array[object] | optional | | | append to trace span attributes
+| tags.position | string | required | | ["http", "arg", "cookie"] | where variable in
+| tags.name | string | required | | | variable name
+
+## How To Enable
+
+First of all, enable the opentelemetry plugin in the `config.yaml`:
+
+```
Review comment:
```suggestion
```yaml
```
--
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: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] spacewander commented on a change in pull request #6119: feat: add opentelemetry plugin #3891
Posted by GitBox <gi...@apache.org>.
spacewander commented on a change in pull request #6119:
URL: https://github.com/apache/apisix/pull/6119#discussion_r787387986
##########
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:
Can we add a complex mock like this one?
https://github.com/apache/apisix/blob/fadf5c270a68d32d2861c518d09cf57939403909/t/plugin/zipkin2.t#L35-L45
--
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: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] bisakhmondal commented on a change in pull request #6119: feat: add opentelemetry plugin
Posted by GitBox <gi...@apache.org>.
bisakhmondal commented on a change in pull request #6119:
URL: https://github.com/apache/apisix/pull/6119#discussion_r791090462
##########
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 | | | attributes (variable and its value) which will be appended to the trace span
+| additional_attributes[0] | string | required | | | APISIX or Nginx variable, like `http_header` or `route_id`
+
+## 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`.
Review comment:
```suggestion
You can set the collecting by specifying the configuration in `conf/config.yaml`.
```
Based on the pronouns used throughout the document : )
##########
File path: apisix/plugins/opentelemetry.lua
##########
@@ -0,0 +1,347 @@
+--
+-- 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 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 = "the source of 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 = core.request.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.rewrite(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, {
Review comment:
```suggestion
local ctx = tracer:start(upstream_context, api_ctx.var.request_uri, {
```
##########
File path: conf/config-default.yaml
##########
@@ -379,6 +379,7 @@ plugins: # plugin list (sorted by priority)
# <- recommend to use priority (0, 100) for your custom plugins
- example-plugin # priority: 0
#- skywalking # priority: -1100
+ #- opentelemetry # priority: -1200
Review comment:
can we add a plugin_attr there as a reference? Similar to
https://github.com/apache/apisix/blob/94088cde46a0c12149ba8dcfeb7bf4bfdb1ff869/conf/config-default.yaml#L403-L411
--
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: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] tao12345666333 commented on a change in pull request #6119: feat: add opentelemetry plugin
Posted by GitBox <gi...@apache.org>.
tao12345666333 commented on a change in pull request #6119:
URL: https://github.com/apache/apisix/pull/6119#discussion_r791321244
##########
File path: apisix/plugins/opentelemetry.lua
##########
@@ -0,0 +1,347 @@
+--
+-- 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
Review comment:
```suggestion
local trace_id_ratio_sampler_new = require("opentelemetry.trace.sampling.trace_id_ratio_sampler").new
```
I personally prefer to put them on the same line.
--
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: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] spacewander merged pull request #6119: feat: add opentelemetry plugin
Posted by GitBox <gi...@apache.org>.
spacewander merged pull request #6119:
URL: https://github.com/apache/apisix/pull/6119
--
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: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] spacewander commented on a change in pull request #6119: feat: add opentelemetry plugin #3891
Posted by GitBox <gi...@apache.org>.
spacewander commented on a change in pull request #6119:
URL: https://github.com/apache/apisix/pull/6119#discussion_r786382281
##########
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)
Review comment:
Sorry, I just realize that we need to call `shutdown` in the tracer.
What happens if we don't call the `shutdown` method?
--
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: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] spacewander commented on a change in pull request #6119: feat: add opentelemetry plugin #3891
Posted by GitBox <gi...@apache.org>.
spacewander commented on a change in pull request #6119:
URL: https://github.com/apache/apisix/pull/6119#discussion_r785597611
##########
File path: apisix/plugins/opentelemetry.lua
##########
@@ -0,0 +1,336 @@
+--
+-- 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 hostname
+
+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,
+ },
+ resource = {
+ type = "object",
+ description = "additional resource",
+ additional_properties = {{type = "boolean"}, {type = "number"}, {type = "string"}},
+ },
+ collector = {
+ type = "object",
+ description = "otel 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",
+ additional_properties = {
+ 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"}}}
+ },
+ tags = {
+ type = "array",
+ items = {
+ type = "object",
+ properties = {
+ position = {
+ type = "string",
+ enum = {"http", "arg", "cookie"}
+ },
+ name = {
+ 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 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.x_request_id_as_trace_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 tracers = {}
+
+local function fetch_tracer(conf, ctx)
+ local t = tracers[ctx.route_id]
Review comment:
There seems to be an issue:
If the route is removed, the tracer will still be in the tracers.
What about using a lrucache like https://github.com/apache/apisix/blob/94088cde46a0c12149ba8dcfeb7bf4bfdb1ff869/apisix/plugins/limit-count.lua#L216
--
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: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] spacewander commented on pull request #6119: feat: add opentelemetry plugin
Posted by GitBox <gi...@apache.org>.
spacewander commented on pull request #6119:
URL: https://github.com/apache/apisix/pull/6119#issuecomment-1021820712
Merged. Thanks!
Let's update the README too
--
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: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] yangxikun commented on a change in pull request #6119: feat: add opentelemetry plugin
Posted by GitBox <gi...@apache.org>.
yangxikun commented on a change in pull request #6119:
URL: https://github.com/apache/apisix/pull/6119#discussion_r791607568
##########
File path: apisix/plugins/opentelemetry.lua
##########
@@ -0,0 +1,347 @@
+--
+-- 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
Review comment:
Yes, for linting.
--
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: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] moonming commented on pull request #6119: feat: add opentelemetry plugin
Posted by GitBox <gi...@apache.org>.
moonming commented on pull request #6119:
URL: https://github.com/apache/apisix/pull/6119#issuecomment-1020739131
--
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: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] yangxikun commented on a change in pull request #6119: feat: add opentelemetry plugin #3891
Posted by GitBox <gi...@apache.org>.
yangxikun commented on a change in pull request #6119:
URL: https://github.com/apache/apisix/pull/6119#discussion_r788354124
##########
File path: apisix/plugins/opentelemetry.lua
##########
@@ -0,0 +1,344 @@
+--
+-- 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 = "the source of 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, api_ctx)
+ if ngx.arg[2] then
+ local upstream_status = core.response.get_upstream_status(api_ctx)
+ local ctx = context:current();
+ ctx:detach()
+
+ -- get span from current context
+ local span = ctx:span()
+ if upstream_status and upstream_status >= 500 then
+ span:set_status(span_status.error,
+ "upstream response status: " .. upstream_status)
+ end
+
+ span:finish()
+ end
+end
+
+
+function _M.log(conf, api_ctx)
+ local ctx = context:current();
+ if ctx then
+ local upstream_status = core.response.get_upstream_status(api_ctx)
Review comment:
Not necessary, ctx is stored in `ngx.ctx`.
--
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: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] moonming commented on pull request #6119: feat: add opentelemetry plugin
Posted by GitBox <gi...@apache.org>.
moonming commented on pull request #6119:
URL: https://github.com/apache/apisix/pull/6119#issuecomment-1020739131
@yangxikun is it possible to make an `opentelemetry-nginx` repo like https://github.com/open-telemetry/opentelemetry-go?
--
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: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] yangxikun commented on a change in pull request #6119: feat: add opentelemetry plugin
Posted by GitBox <gi...@apache.org>.
yangxikun commented on a change in pull request #6119:
URL: https://github.com/apache/apisix/pull/6119#discussion_r791607568
##########
File path: apisix/plugins/opentelemetry.lua
##########
@@ -0,0 +1,347 @@
+--
+-- 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
Review comment:
Yes, for linting.
--
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: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] yangxikun commented on a change in pull request #6119: feat: add opentelemetry plugin #3891
Posted by GitBox <gi...@apache.org>.
yangxikun commented on a change in pull request #6119:
URL: https://github.com/apache/apisix/pull/6119#discussion_r786762931
##########
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)
Review comment:
`shuitdown` is just used to export spans immediately.
If `shutdown` is not call, the batch_span_processor background timer will export spans too, then exit when there is no more spans need to export.
##########
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:
I cannot figure out how to write an unit test for this.
--
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: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] xuminwlt commented on pull request #6119: feat: add opentelemetry plugin #3891
Posted by GitBox <gi...@apache.org>.
xuminwlt commented on pull request #6119:
URL: https://github.com/apache/apisix/pull/6119#issuecomment-1014106013
great, brother.
--
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: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] spacewander commented on a change in pull request #6119: feat: add opentelemetry plugin #3891
Posted by GitBox <gi...@apache.org>.
spacewander commented on a change in pull request #6119:
URL: https://github.com/apache/apisix/pull/6119#discussion_r785592116
##########
File path: apisix/plugins/opentelemetry.lua
##########
@@ -0,0 +1,336 @@
+--
+-- 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 hostname
+
+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,
+ },
+ resource = {
+ type = "object",
+ description = "additional resource",
+ additional_properties = {{type = "boolean"}, {type = "number"}, {type = "string"}},
+ },
+ collector = {
+ type = "object",
+ description = "otel collector",
Review comment:
```suggestion
description = "opentelemetry collector",
```
##########
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:
We don't need to check the response in every test? Is it necessary to the correctness?
##########
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"
+ }]],
+ [[{
+ "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
+--- no_error_log
Review comment:
we can save the duplicate `no_error_log` as we already set it in https://github.com/apache/apisix/pull/6119/files#diff-9202b17a30a4b69a6ba8aed818a92d90bbb8a135b34cd752d005aa1eb7df89dbR53
##########
File path: docs/en/latest/plugins/opentelemetry.md
##########
@@ -0,0 +1,154 @@
+---
+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
+| tags | array[object] | optional | | | append to trace span attributes
+| tags.position | string | required | | ["http", "arg", "cookie"] | where variable in
+| tags.name | string | required | | | variable name
+
+## 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
Review comment:
Let's add a commented placeholder like
https://github.com/apache/apisix/blob/94088cde46a0c12149ba8dcfeb7bf4bfdb1ff869/conf/config-default.yaml#L384
##########
File path: docs/en/latest/plugins/opentelemetry.md
##########
@@ -0,0 +1,154 @@
+---
+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
+| tags | array[object] | optional | | | append to trace span attributes
+| tags.position | string | required | | ["http", "arg", "cookie"] | where variable in
+| tags.name | string | required | | | variable name
+
+## 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 |
+| ------------ | ------ | -------- | ----------------------------------------------------- |
+| x_request_id_as_trace_id | boolean | false | use current request id as new TraceID, you should make sure the request id is match regex pattern: `[0-9a-f]{32}`|
+| resource | object | | additional [resource](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/resource/sdk.md) append to trace |
+| collector | object | {address = "127.0.0.1:4317", request_timeout = 3} | otlp collector |
+| collector.address | string | 127.0.0.1:4317 | collector address |
+| collector.request_timeout | integer | 3 | report request timeout |
Review comment:
Better to add a time unit to the doc
##########
File path: apisix/plugins/opentelemetry.lua
##########
@@ -0,0 +1,336 @@
+--
+-- 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 hostname
+
+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,
+ },
+ resource = {
+ type = "object",
+ description = "additional resource",
+ additional_properties = {{type = "boolean"}, {type = "number"}, {type = "string"}},
+ },
+ collector = {
+ type = "object",
+ description = "otel 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",
+ additional_properties = {
+ 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"}}}
+ },
+ tags = {
+ type = "array",
+ items = {
+ type = "object",
+ properties = {
+ position = {
+ type = "string",
+ enum = {"http", "arg", "cookie"}
+ },
+ name = {
+ 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 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.x_request_id_as_trace_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 tracers = {}
+
+local function fetch_tracer(conf, ctx)
+ local t = tracers[ctx.route_id]
+ if t and t.v == ctx.conf_version then
+ return t.tracer
+ end
+
+ -- 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
+ local tracer = tp:tracer("opentelemetry-lua")
+ tracers[ctx.route_id] = {tracer = tracer, v = ctx.conf_version}
+
+ return tracer
+end
+
Review comment:
Let's use two blank lines to separate each sections
##########
File path: docs/en/latest/plugins/opentelemetry.md
##########
@@ -0,0 +1,154 @@
+---
+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
+| tags | array[object] | optional | | | append to trace span attributes
+| tags.position | string | required | | ["http", "arg", "cookie"] | where variable in
+| tags.name | string | required | | | variable name
+
+## 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 |
+| ------------ | ------ | -------- | ----------------------------------------------------- |
+| x_request_id_as_trace_id | boolean | false | use current request id as new TraceID, you should make sure the request id is match regex pattern: `[0-9a-f]{32}`|
+| resource | object | | additional [resource](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/resource/sdk.md) append to trace |
+| collector | object | {address = "127.0.0.1:4317", request_timeout = 3} | otlp collector |
+| collector.address | string | 127.0.0.1:4317 | collector address |
+| collector.request_timeout | integer | 3 | report request timeout |
+| collector.request_headers | object | | report request http headers |
+| batch_span_processor | object | | trace span processor |
+| batch_span_processor.drop_on_queue_full | boolean | true | drop span when queue is full, otherwise force process batches |
+| batch_span_processor.max_queue_size | integer | 2048 | maximum queue size to buffer spans for delayed processing |
+| batch_span_processor.batch_timeout | number | 5 | maximum duration(second) for constructing a batch |
+| batch_span_processor.max_export_batch_size | integer | 256 | maximum number of spans to process in a single batch |
+| batch_span_processor.inactive_timeout | number | 2 | timer interval for processing batches |
Review comment:
Ditto
##########
File path: apisix/plugins/opentelemetry.lua
##########
@@ -0,0 +1,336 @@
+--
+-- 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 hostname
+
+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,
+ },
+ resource = {
+ type = "object",
+ description = "additional resource",
+ additional_properties = {{type = "boolean"}, {type = "number"}, {type = "string"}},
+ },
+ collector = {
+ type = "object",
+ description = "otel 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",
+ additional_properties = {
+ 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"}}}
+ },
+ tags = {
+ type = "array",
+ items = {
+ type = "object",
+ properties = {
+ position = {
+ type = "string",
+ enum = {"http", "arg", "cookie"}
+ },
+ name = {
+ 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 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.x_request_id_as_trace_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 tracers = {}
+
+local function fetch_tracer(conf, ctx)
+ local t = tracers[ctx.route_id]
+ if t and t.v == ctx.conf_version then
+ return t.tracer
+ end
+
+ -- 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
+ local tracer = tp:tracer("opentelemetry-lua")
+ tracers[ctx.route_id] = {tracer = tracer, v = ctx.conf_version}
+
+ return tracer
+end
+
+function _M.access(conf, api_ctx)
+ -- 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.tags then
+ for _, tag in ipairs(conf.tags) do
+ local key = tag.position .. "_" .. tag.name
Review comment:
Can we just use a single field, like `tag.var`, instead of always concat the two fields?
Also, use variable as tag can make it possible to correct more data like remote_addr
##########
File path: apisix/plugins/opentelemetry.lua
##########
@@ -0,0 +1,336 @@
+--
+-- 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 hostname
+
+local attr_schema = {
+ type = "object",
+ properties = {
+ x_request_id_as_trace_id = {
Review comment:
Would be better to use an enum? Like:
```
enum = {"x-request-id", "random"},
```
--
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: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] membphis commented on a change in pull request #6119: feat: add opentelemetry plugin #3891
Posted by GitBox <gi...@apache.org>.
membphis commented on a change in pull request #6119:
URL: https://github.com/apache/apisix/pull/6119#discussion_r789667798
##########
File path: t/plugin/opentelemetry.t
##########
@@ -160,6 +164,7 @@ qr/opentelemetry export span/
=== TEST 5: use trace_id_ratio sampler, default fraction = 0
+--- SKIP
Review comment:
for testing?
--
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: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] spacewander commented on a change in pull request #6119: feat: add opentelemetry plugin #3891
Posted by GitBox <gi...@apache.org>.
spacewander commented on a change in pull request #6119:
URL: https://github.com/apache/apisix/pull/6119#discussion_r789387584
##########
File path: apisix/plugins/opentelemetry.lua
##########
@@ -0,0 +1,345 @@
+--
+-- 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 = "the source of 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
Review comment:
```suggestion
local trace_id = core.request.headers()["x-request-id"] or ctx.var.request_id
```
##########
File path: apisix/plugins/opentelemetry.lua
##########
@@ -0,0 +1,345 @@
+--
+-- 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 = "the source of 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.rewrite(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, api_ctx)
+ if ngx.arg[2] then
+ local upstream_status = core.response.get_upstream_status(api_ctx)
+ local ctx = context:current()
+ ctx:detach()
+
+ -- get span from current context
+ local span = ctx:span()
+ if upstream_status and upstream_status >= 500 then
+ span:set_status(span_status.error,
+ "upstream response status: " .. upstream_status)
+ end
+
+ span:finish()
+ end
+end
+
+
+function _M.log(conf, api_ctx)
+ local ctx = context:current()
+ if ctx then
Review comment:
We can add a comment to explain why we don't need to detach it
##########
File path: t/plugin/opentelemetry.t
##########
@@ -0,0 +1,727 @@
+#
+# 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) = @_;
+
+ if (!$block->extra_yaml_config) {
+ 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);
+ }
+
+
+ if (!$block->extra_init_by_lua) {
+ 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 (!defined $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"
+ }]]
+ )
+
+ 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"
+ }]]
+ )
+
+ if code >= 300 then
+ ngx.status = code
+ end
+ ngx.say(body)
+ }
+ }
+
+
+
+=== TEST 4: not trigger opentelemetry
+--- request
+GET /opentracing
+--- response_body
+opentracing
+--- grep_error_log eval
+qr/opentelemetry export span/
+--- grep_error_log_out
+
+
+
+=== TEST 5: use trace_id_ratio sampler, default fraction = 0
+--- 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": "trace_id_ratio"
+ }
+ }
+ },
+ "upstream": {
+ "nodes": {
+ "127.0.0.1:1980": 1
+ },
+ "type": "roundrobin"
+ },
+ "uri": "/opentracing"
+ }]]
+ )
+
+ if code >= 300 then
+ ngx.status = code
+ end
+ ngx.say(body)
+ }
+ }
+
+
+
+=== TEST 6: not trigger opentelemetry
+--- request
+GET /opentracing
+--- response_body
+opentracing
+--- grep_error_log eval
+qr/opentelemetry export span/
+--- grep_error_log_out
+
+
+
+=== TEST 7: use trace_id_ratio sampler, fraction = 1.0
+--- 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": "trace_id_ratio",
+ "options": {
+ "fraction": 1.0
+ }
+ }
+ }
+ },
+ "upstream": {
+ "nodes": {
+ "127.0.0.1:1980": 1
+ },
+ "type": "roundrobin"
+ },
+ "uri": "/opentracing"
+ }]]
+ )
+
+ if code >= 300 then
+ ngx.status = code
+ end
+ ngx.say(body)
+ }
+ }
+
+
+
+=== TEST 8: 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 9: use parent_base sampler, default root sampler = always_off
+--- 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": "parent_base"
+ }
+ }
+ },
+ "upstream": {
+ "nodes": {
+ "127.0.0.1:1980": 1
+ },
+ "type": "roundrobin"
+ },
+ "uri": "/opentracing"
+ }]]
+ )
+
+ if code >= 300 then
+ ngx.status = code
+ end
+ ngx.say(body)
+ }
+ }
+
+
+
+=== TEST 10: not trigger opentelemetry
+--- request
+GET /opentracing
+--- response_body
+opentracing
+--- grep_error_log eval
+qr/opentelemetry export span/
+--- grep_error_log_out
+
+
+
+=== TEST 11: use parent_base sampler, root sampler = always_on
+--- 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": "parent_base",
+ "options": {
+ "root": {
+ "name": "always_on"
+ }
+ }
+ }
+ }
+ },
+ "upstream": {
+ "nodes": {
+ "127.0.0.1:1980": 1
+ },
+ "type": "roundrobin"
+ },
+ "uri": "/opentracing"
+ }]]
+ )
+
+ if code >= 300 then
+ ngx.status = code
+ end
+ ngx.say(body)
+ }
+ }
+
+
+
+=== TEST 12: 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 13: use parent_base sampler, root sampler = trace_id_ratio with default fraction = 0
+--- 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": "parent_base",
+ "options": {
+ "root": {
+ "name": "trace_id_ratio"
+ }
+ }
+ }
+ }
+ },
+ "upstream": {
+ "nodes": {
+ "127.0.0.1:1980": 1
+ },
+ "type": "roundrobin"
+ },
+ "uri": "/opentracing"
+ }]]
+ )
+
+ if code >= 300 then
+ ngx.status = code
+ end
+ ngx.say(body)
+ }
+ }
+
+
+
+=== TEST 14: not trigger opentelemetry
+--- request
+GET /opentracing
+--- response_body
+opentracing
+--- grep_error_log eval
+qr/opentelemetry export span/
+--- grep_error_log_out
+
+
+
+=== TEST 15: trigger opentelemetry, trace_flag = 1
+--- request
+GET /opentracing
+--- more_headers
+traceparent: 00-00000000000000000000000000000001-0000000000000001-01
+--- response_body
+opentracing
+--- wait: 1
+--- grep_error_log eval
+qr/opentelemetry export span/
+--- grep_error_log_out
+opentelemetry export span
+
+
+
+=== TEST 16: use parent_base sampler, root sampler = trace_id_ratio with fraction = 1
+--- 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": "parent_base",
+ "options": {
+ "root": {
+ "name": "trace_id_ratio",
+ "options": {
+ "fraction": 1.0
+ }
+ }
+ }
+ }
+ }
+ },
+ "upstream": {
+ "nodes": {
+ "127.0.0.1:1980": 1
+ },
+ "type": "roundrobin"
+ },
+ "uri": "/opentracing"
+ }]]
+ )
+
+ if code >= 300 then
+ ngx.status = code
+ end
+ ngx.say(body)
+ }
+ }
+
+
+
+=== TEST 17: 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 18: not trigger opentelemetry, trace_flag = 0
+--- request
+GET /opentracing
+--- more_headers
+traceparent: 00-00000000000000000000000000000001-0000000000000001-00
+--- response_body
+opentracing
+--- grep_error_log eval
+qr/opentelemetry export span/
+--- grep_error_log_out
+
+
+
+=== TEST 19: set additional_attributes
+--- config
+ location /t {
+ content_by_lua_block {
+ local t = require("lib.test_admin").test
+ local code, body = t('/apisix/admin/services/1',
+ ngx.HTTP_PUT,
+ [[{
+ "name": "service_name",
+ "upstream": {
+ "nodes": {
+ "127.0.0.1:1980": 1
+ },
+ "type": "roundrobin"
+ }
+ }]]
+ )
+ if code >= 300 then
+ ngx.status = code
+ ngx.say(body)
+ return
+ end
+ local code, body = t('/apisix/admin/routes/1',
+ ngx.HTTP_PUT,
+ [[{
+ "name": "route_name",
+ "plugins": {
+ "opentelemetry": {
+ "sampler": {
+ "name": "always_on"
+ },
+ "additional_attributes": [
+ "http_user_agent",
+ "arg_foo",
+ "cookie_token",
+ "remote_addr"
+ ]
+ }
+ },
+ "uri": "/opentracing",
+ "service_id": "1"
+ }]]
+ )
+
+ if code >= 300 then
+ ngx.status = code
+ end
+ ngx.say(body)
+ }
+ }
+
+
+
+=== TEST 20: trigger opentelemetry, test trace_id_source=x-request-id, custom resource, additional_attributes
+--- extra_yaml_config
+plugins:
+ - opentelemetry
+plugin_attr:
+ opentelemetry:
+ trace_id_source: x-request-id
+ resource:
+ service.name: test
+ test_key: test_val
+ batch_span_processor:
+ max_export_batch_size: 1
+ inactive_timeout: 0.5
+--- extra_init_by_lua
+ local core = require("apisix.core")
+ local otlp = require("opentelemetry.trace.exporter.otlp")
+ otlp.export_spans = function(self, spans)
+ if (#spans ~= 1) then
+ ngx.log(ngx.ERR, "unexpected spans length: ", #spans)
+ return
+ end
+
+ local span = spans[1]
+ if span:context().trace_id ~= "01010101010101010101010101010101" then
+ ngx.log(ngx.ERR, "unexpected trace id: ", span:context().trace_id)
+ return
+ end
+
+ if span.name ~= "/opentracing?foo=bar&a=b" then
+ ngx.log(ngx.ERR, "expect span name: /opentracing?foo=bar&a=b, but got ", span.name)
+ return
+ end
+
+ local expected_resource_attrs = {
+ test_key = "test_val",
+ }
+ expected_resource_attrs["service.name"] = "test"
+ expected_resource_attrs["telemetry.sdk.language"] = "lua"
+ expected_resource_attrs["telemetry.sdk.name"] = "opentelemetry-lua"
+ expected_resource_attrs["telemetry.sdk.version"] = "0.1.1"
+ expected_resource_attrs["hostname"] = core.utils.gethostname()
+ local actual_resource_attrs = span.tracer.provider.resource:attributes()
+ if #actual_resource_attrs ~= 6 then
+ ngx.log(ngx.ERR, "expect len(actual_resource) = 6, but got ", #actual_resource_attrs)
+ return
+ end
+ for _, attr in ipairs(actual_resource_attrs) do
+ local expected_val = expected_resource_attrs[attr.key]
+ if not expected_val then
+ ngx.log(ngx.ERR, "unexpected resource attr key: ", attr.key)
+ return
+ end
+ if attr.value.string_value ~= expected_val then
+ ngx.log(ngx.ERR, "unexpected resource attr val: ", attr.value.string_value)
+ return
+ end
+ end
+
+ local expected_attributes = {
+ service = "service_name",
+ route = "route_name",
+ http_user_agent = "test_nginx",
+ arg_foo = "bar",
+ cookie_token = "auth_token",
+ remote_addr = "127.0.0.1",
+ }
+ if #span.attributes ~= 6 then
+ ngx.log(ngx.ERR, "expect len(span.attributes) = 6, but got ", #span.attributes)
+ return
+ end
+ for _, attr in ipairs(span.attributes) do
+ local expected_val = expected_attributes[attr.key]
+ if not expected_val then
+ ngx.log(ngx.ERR, "unexpected attr key: ", attr.key)
+ return
+ end
+ if attr.value.string_value ~= expected_val then
+ ngx.log(ngx.ERR, "unexpected attr val: ", attr.value.string_value)
+ return
+ end
+ end
+
+ ngx.log(ngx.INFO, "opentelemetry export span")
+ end
+--- request
+GET /opentracing?foo=bar&a=b
+--- more_headers
+X-Request-Id: 01010101010101010101010101010101
+User-Agent: test_nginx
+Cookie: token=auth_token;
+--- response_body
+opentracing
+--- wait: 1
+--- grep_error_log eval
+qr/opentelemetry export span/
+--- grep_error_log_out
+opentelemetry export span
+
+
+
+=== TEST 21: create route for /specific_status
+--- config
+ location /t {
+ content_by_lua_block {
+ local t = require("lib.test_admin").test
+ local code, body = t('/apisix/admin/routes/2',
+ ngx.HTTP_PUT,
+ [[{
+ "name": "route_name",
+ "plugins": {
+ "opentelemetry": {
+ "sampler": {
+ "name": "always_on"
+ }
+ }
+ },
+ "uri": "/specific_status",
+ "upstream": {
+ "nodes": {
+ "127.0.0.1:1980": 1
+ },
+ "type": "roundrobin"
+ }
+ }]]
+ )
+
+ if code >= 300 then
+ ngx.status = code
+ end
+ ngx.say(body)
+ }
+ }
+
+
+
+=== TEST 22: 500 status, test span.status
+--- extra_init_by_lua
+ local otlp = require("opentelemetry.trace.exporter.otlp")
+ otlp.export_spans = function(self, spans)
+ if (#spans ~= 1) then
+ ngx.log(ngx.ERR, "unexpected spans length: ", #spans)
+ return
+ end
+
+ local span = spans[1]
+ if span.status.code ~= 2 then
+ ngx.log(ngx.ERR, "unexpected status.code: ", span.status.code)
+ end
+ if span.status.message ~= "upstream response status: 500" then
+ ngx.log(ngx.ERR, "unexpected status.message: ", span.status.message)
+ end
+
+ ngx.log(ngx.INFO, "opentelemetry export span")
+ end
+--- request
+GET /specific_status
+--- more_headers
+X-Test-Upstream-Status: 500
+--- error_code: 500
+--- response_body
+upstream status: 500
+--- wait: 1
+--- grep_error_log eval
+qr/opentelemetry export span/
+--- grep_error_log_out
+opentelemetry export span
+
+
+
+=== TEST 23: test response empty body
+--- extra_init_by_lua
+ local otlp = require("opentelemetry.trace.exporter.otlp")
+ 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
Review comment:
We can use `HEAD` to test it without mocking the body_filter
--
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: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] yangxikun commented on a change in pull request #6119: feat: add opentelemetry plugin #3891
Posted by GitBox <gi...@apache.org>.
yangxikun commented on a change in pull request #6119:
URL: https://github.com/apache/apisix/pull/6119#discussion_r786762931
##########
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)
Review comment:
`shuitdown` is just used to export spans immediately.
If `shutdown` is not call, the batch_span_processor background timer will export spans too, then exit when there is no more spans need to export.
So it's ok to remove `destroy`.
--
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: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] bisakhmondal commented on a change in pull request #6119: feat: add opentelemetry plugin
Posted by GitBox <gi...@apache.org>.
bisakhmondal commented on a change in pull request #6119:
URL: https://github.com/apache/apisix/pull/6119#discussion_r791354524
##########
File path: apisix/plugins/opentelemetry.lua
##########
@@ -0,0 +1,347 @@
+--
+-- 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
Review comment:
I guess it's for Linting? > 100 char
--
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: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] spacewander commented on a change in pull request #6119: feat: add opentelemetry plugin
Posted by GitBox <gi...@apache.org>.
spacewander commented on a change in pull request #6119:
URL: https://github.com/apache/apisix/pull/6119#discussion_r791298906
##########
File path: apisix/plugins/opentelemetry.lua
##########
@@ -0,0 +1,347 @@
+--
+-- 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 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 = "the source of 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 = core.request.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.rewrite(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, {
Review comment:
Personally, I prefer to keep the `_` so people will know we just ignore the `span`.
--
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: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] tao12345666333 commented on a change in pull request #6119: feat: add opentelemetry plugin
Posted by GitBox <gi...@apache.org>.
tao12345666333 commented on a change in pull request #6119:
URL: https://github.com/apache/apisix/pull/6119#discussion_r791321244
##########
File path: apisix/plugins/opentelemetry.lua
##########
@@ -0,0 +1,347 @@
+--
+-- 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
Review comment:
```suggestion
local trace_id_ratio_sampler_new = require("opentelemetry.trace.sampling.trace_id_ratio_sampler").new
```
I personally prefer to put them on the same line.
--
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: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] bisakhmondal commented on a change in pull request #6119: feat: add opentelemetry plugin
Posted by GitBox <gi...@apache.org>.
bisakhmondal commented on a change in pull request #6119:
URL: https://github.com/apache/apisix/pull/6119#discussion_r791090462
##########
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 | | | attributes (variable and its value) which will be appended to the trace span
+| additional_attributes[0] | string | required | | | APISIX or Nginx variable, like `http_header` or `route_id`
+
+## 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`.
Review comment:
```suggestion
You can set the collecting by specifying the configuration in `conf/config.yaml`.
```
Based on the pronouns used throughout the document : )
##########
File path: apisix/plugins/opentelemetry.lua
##########
@@ -0,0 +1,347 @@
+--
+-- 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 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 = "the source of 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 = core.request.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.rewrite(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, {
Review comment:
```suggestion
local ctx = tracer:start(upstream_context, api_ctx.var.request_uri, {
```
##########
File path: conf/config-default.yaml
##########
@@ -379,6 +379,7 @@ plugins: # plugin list (sorted by priority)
# <- recommend to use priority (0, 100) for your custom plugins
- example-plugin # priority: 0
#- skywalking # priority: -1100
+ #- opentelemetry # priority: -1200
Review comment:
can we add a plugin_attr there as a reference? Similar to
https://github.com/apache/apisix/blob/94088cde46a0c12149ba8dcfeb7bf4bfdb1ff869/conf/config-default.yaml#L403-L411
##########
File path: apisix/plugins/opentelemetry.lua
##########
@@ -0,0 +1,347 @@
+--
+-- 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
Review comment:
I guess it's for Linting? > 100 char
##########
File path: apisix/plugins/opentelemetry.lua
##########
@@ -0,0 +1,347 @@
+--
+-- 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 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 = "the source of 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 = core.request.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.rewrite(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, {
Review comment:
Yeah sure :+1:
--
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: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] spacewander commented on a change in pull request #6119: feat: add opentelemetry plugin #3891
Posted by GitBox <gi...@apache.org>.
spacewander commented on a change in pull request #6119:
URL: https://github.com/apache/apisix/pull/6119#discussion_r787453043
##########
File path: apisix/plugins/opentelemetry.lua
##########
@@ -0,0 +1,344 @@
+--
+-- 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 = "the source of 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, api_ctx)
+ if ngx.arg[2] then
+ local upstream_status = core.response.get_upstream_status(api_ctx)
+ local ctx = context:current();
+ ctx:detach()
+
+ -- get span from current context
+ local span = ctx:span()
+ if upstream_status and upstream_status >= 500 then
+ span:set_status(span_status.error,
+ "upstream response status: " .. upstream_status)
+ end
+
+ span:finish()
+ end
+end
+
+
+function _M.log(conf, api_ctx)
+ local ctx = context:current();
+ if ctx then
+ local upstream_status = core.response.get_upstream_status(api_ctx)
Review comment:
Do we need to detach ctx in the log phase? Maybe we can refactor the code to share the same logic
##########
File path: apisix/plugins/opentelemetry.lua
##########
@@ -0,0 +1,344 @@
+--
+-- 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 = "the source of 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)
Review comment:
For tracing, the injection should happen as early as possible. I think we can run it with the `rewrite` method, just like zipkin & skywalking.
##########
File path: apisix/plugins/opentelemetry.lua
##########
@@ -0,0 +1,344 @@
+--
+-- 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 = "the source of 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, api_ctx)
+ if ngx.arg[2] then
+ local upstream_status = core.response.get_upstream_status(api_ctx)
+ local ctx = context:current();
Review comment:
The `;` is not necessary.
--
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: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] spacewander commented on a change in pull request #6119: feat: add opentelemetry plugin
Posted by GitBox <gi...@apache.org>.
spacewander commented on a change in pull request #6119:
URL: https://github.com/apache/apisix/pull/6119#discussion_r791298906
##########
File path: apisix/plugins/opentelemetry.lua
##########
@@ -0,0 +1,347 @@
+--
+-- 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 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 = "the source of 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 = core.request.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.rewrite(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, {
Review comment:
Personally, I prefer to keep the `_` so people will know we just ignore the `span`.
--
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: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] moonming edited a comment on pull request #6119: feat: add opentelemetry plugin
Posted by GitBox <gi...@apache.org>.
moonming edited a comment on pull request #6119:
URL: https://github.com/apache/apisix/pull/6119#issuecomment-1020739131
@yangxikun is it possible to make an `opentelemetry-lua` repo like https://github.com/open-telemetry/opentelemetry-go?
--
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: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] bisakhmondal commented on a change in pull request #6119: feat: add opentelemetry plugin
Posted by GitBox <gi...@apache.org>.
bisakhmondal commented on a change in pull request #6119:
URL: https://github.com/apache/apisix/pull/6119#discussion_r791354633
##########
File path: apisix/plugins/opentelemetry.lua
##########
@@ -0,0 +1,347 @@
+--
+-- 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 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 = "the source of 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 = core.request.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.rewrite(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, {
Review comment:
Yeah sure :+1:
--
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: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] spacewander commented on a change in pull request #6119: feat: add opentelemetry plugin #3891
Posted by GitBox <gi...@apache.org>.
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: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org