Skip to content

feat(plugin): Add span_name_strategy to OpenTelemetry plug-in config #13749

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
UnoYakshi wants to merge 1 commit into
base: master
Choose a base branch
from
+20 −1
Draft

feat(plugin): Add span_name_strategy to OpenTelemetry plug-in config #13749

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 20 additions & 1 deletion apisix/plugins/opentelemetry.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -197,6 +197,12 @@ local schema = {
},
default = {name = "always_off", options = {fraction = 0, root = {name = "always_off"}}}
},
span_name_strategy = {
type = "string",
enum = {"path", "target"},
description = "For trace name, either use APISIX Route path or HTTP target / URL.",
default = "path",
},
additional_attributes = {
type = "array",
items = {
Expand Down Expand Up @@ -375,6 +381,18 @@ local function inject_attributes(attributes, wanted_attributes, source, with_pre
end


-- Choose span name depending on the provided config (or use default "route")...
local function resolve_span_name(conf, api_ctx)
local span_name_strategy = conf.span_name_strategy or "route"

if strategy == "target" then
return api_ctx.var.uri
end

return api_ctx.curr_req_matched._path
end


function _M.rewrite(conf, api_ctx)
local metadata = plugin.plugin_metadata(plugin_name)
if metadata == nil then
Expand Down Expand Up @@ -414,7 +432,8 @@ function _M.rewrite(conf, api_ctx)
table.insert(attributes, attr.string("apisix.route_id", api_ctx.route_id))
table.insert(attributes, attr.string("apisix.route_name", api_ctx.route_name))
table.insert(attributes, attr.string("http.route", api_ctx.curr_req_matched._path))
span_name = span_name .. " " .. api_ctx.curr_req_matched._path
local span_name_suffix = resolve_span_name_suffix(plugin_info, api_ctx)
span_name = span_name .. " " .. api_ctx.curr_req_matched.span_name_suffix
end

if api_ctx.service_id then
Expand Down
Loading