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/17 02:06:26 UTC
[GitHub] [apisix] spacewander commented on a change in pull request #6119: feat: add opentelemetry plugin #3891
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