feat: Include path in tags with Datadog plugin

[deiwin]

Description

Fixes # (issue)

Checklist

• I have explained the need for this PR and the problem it solves
• I have explained the changes or the new features added to this PR
• I have added tests corresponding to this change
• I have updated the documentation to reflect this change
• I have verified that this change is backward compatible (If not, please discuss on the APISIX mailing list first)

[Baoyuantop]

Hi @deiwin, I see PR is still in draft status, is there still time to advance?

[deiwin]

Hi! I haven't been able to work on this recently, but would love to see this completed.

Based on how I read the code, the code changes should work as-is, but the docs & tests still need work.

Unfortunately I wasn't able to get the tests to run on mac (following this guide), so I put this on hold for now.

[Baoyuantop]

Unfortunately I wasn't able to get the tests to run on mac

Can you share the specific problem?

[deiwin]

Following the linked guide, everything seems to work up to and including the make run but when I run any tests (e.g. with the suggested docker exec -it apisix-dev-env prove t/admin/routes.t command), then I get many errors & failures for all tests that I've tried. E.g.:

❯ docker exec -it apisix-dev-env prove t/admin/routes.t
t/admin/routes.t .. 1/? t/admin/routes.t TEST 2: get route(id: 1) - timeout when waiting for the process 45487 to exit at /usr/local/share/perl/5.30.0/Test/Nginx/Util.pm line 668.
t/admin/routes.t TEST 2: get route(id: 1) - WARNING: killing the child process 45487 with force... at /usr/local/share/perl/5.30.0/Test/Nginx/Util.pm line 707.
t/admin/routes.t .. 4/? t/admin/routes.t TEST 3: delete route(id: 1) - timeout when waiting for the process 45496 to exit at /usr/local/share/perl/5.30.0/Test/Nginx/Util.pm line 668.
t/admin/routes.t TEST 3: delete route(id: 1) - WARNING: killing the child process 45496 with force... at /usr/local/share/perl/5.30.0/Test/Nginx/Util.pm line 707.
t/admin/routes.t .. 7/?
#   Failed test 'ERROR: client socket timed out - t/admin/routes.t TEST 3: delete route(id: 1)
# '
#   at /usr/local/share/perl/5.30.0/Test/Nginx/Socket.pm line 2206.

#   Failed test 't/admin/routes.t TEST 3: delete route(id: 1) - status code ok'
#   at /usr/local/share/perl/5.30.0/Test/Nginx/Socket.pm line 949.
#          got: ''
#     expected: '200'

#   Failed test 't/admin/routes.t TEST 3: delete route(id: 1) - response_body - response is expected (repeated req 0, req 0)'
#   at /usr/local/share/perl/5.30.0/Test/Nginx/Socket.pm line 1660.
#          got: ''
#     expected: '[delete] code: 200 message: passed
# '
t/admin/routes.t TEST 4: delete route(id: not_found) - timeout when waiting for the process 45507 to exit at /usr/local/share/perl/5.30.0/Test/Nginx/Util.pm line 668.
t/admin/routes.t TEST 4: delete route(id: not_found) - WARNING: killing the child process 45507 with force... at /usr/local/share/perl/5.30.0/Test/Nginx/Util.pm line 707.
t/admin/routes.t .. 11/? t/admin/routes.t TEST 5: post route + delete - timeout when waiting for the process 45516 to exit at /usr/local/share/perl/5.30.0/Test/Nginx/Util.pm line 668.
t/admin/routes.t TEST 5: post route + delete - WARNING: killing the child process 45516 with force... at /usr/local/share/perl/5.30.0/Test/Nginx/Util.pm line 707.
t/admin/routes.t .. 14/? t/admin/routes.t TEST 6: uri + upstream - timeout when waiting for the process 45525 to exit at /usr/local/share/perl/5.30.0/Test/Nginx/Util.pm line 668.
t/admin/routes.t TEST 6: uri + upstream - WARNING: killing the child process 45525 with force... at /usr/local/share/perl/5.30.0/Test/Nginx/Util.pm line 707.
t/admin/routes.t .. 17/?
#   Failed test 'ERROR: client socket timed out - t/admin/routes.t TEST 6: uri + upstream
# '
#   at /usr/local/share/perl/5.30.0/Test/Nginx/Socket.pm line 2206.

#   Failed test 't/admin/routes.t TEST 6: uri + upstream - status code ok'
#   at /usr/local/share/perl/5.30.0/Test/Nginx/Socket.pm line 949.
#          got: ''
#     expected: '200'

#   Failed test 't/admin/routes.t TEST 6: uri + upstream - response_body - response is expected (repeated req 0, req 0)'
#   at /usr/local/share/perl/5.30.0/Test/Nginx/Socket.pm line 1660.
#          got: ''
#     expected: '[push] code: 200 message: passed
# '
t/admin/routes.t TEST 7: uri + plugins - timeout when waiting for the process 45534 to exit at /usr/local/share/perl/5.30.0/Test/Nginx/Util.pm line 668.
t/admin/routes.t TEST 7: uri + plugins - WARNING: killing the child process 45534 with force... at /usr/local/share/perl/5.30.0/Test/Nginx/Util.pm line 707.
t/admin/routes.t .. 21/? t/admin/routes.t TEST 8: invalid route: duplicate method - timeout when waiting for the process 45543 to exit at /usr/local/share/perl/5.30.0/Test/Nginx/Util.pm line 668.
t/admin/routes.t TEST 8: invalid route: duplicate method - WARNING: killing the child process 45543 with force... at /usr/local/share/perl/5.30.0/Test/Nginx/Util.pm line 707.
t/admin/routes.t .. 24/? t/admin/routes.t TEST 9: invalid method - timeout when waiting for the process 45552 to exit at /usr/local/share/perl/5.30.0/Test/Nginx/Util.pm line 668.
t/admin/routes.t TEST 9: invalid method - WARNING: killing the child process 45552 with force... at /usr/local/share/perl/5.30.0/Test/Nginx/Util.pm line 707.
t/admin/routes.t .. 27/?
#   Failed test 'ERROR: client socket timed out - t/admin/routes.t TEST 9: invalid method
# '
#   at /usr/local/share/perl/5.30.0/Test/Nginx/Socket.pm line 2206.

#   Failed test 't/admin/routes.t TEST 9: invalid method - status code ok'
#   at /usr/local/share/perl/5.30.0/Test/Nginx/Socket.pm line 936.
#          got: ''
#     expected: '400'

#   Failed test 't/admin/routes.t TEST 9: invalid method - response_body - response is expected (repeated req 0, req 0)'
#   at /usr/local/share/perl/5.30.0/Test/Nginx/Socket.pm line 1660.
#          got: ''
#     expected: '{"error_msg":"invalid configuration: property \"methods\" validation failed: failed to validate item 1: matches none of the enum values"}
# '
t/admin/routes.t .. 30/? t/admin/routes.t TEST 10: invalid service id - timeout when waiting for the process 45561 to exit at /usr/local/share/perl/5.30.0/Test/Nginx/Util.pm line 668.
t/admin/routes.t TEST 10: invalid service id - WARNING: killing the child process 45561 with force... at /usr/local/share/perl/5.30.0/Test/Nginx/Util.pm line 707.
t/admin/routes.t .. 31/? t/admin/routes.t TEST 11: service id: not exist - timeout when waiting for the process 45570 to exit at /usr/local/share/perl/5.30.0/Test/Nginx/Util.pm line 668.
t/admin/routes.t TEST 11: service id: not exist - WARNING: killing the child process 45570 with force... at /usr/local/share/perl/5.30.0/Test/Nginx/Util.pm line 707.
t/admin/routes.t .. 34/? t/admin/routes.t TEST 12: invalid id - timeout when waiting for the process 45579 to exit at /usr/local/share/perl/5.30.0/Test/Nginx/Util.pm line 668.
t/admin/routes.t TEST 12: invalid id - WARNING: killing the child process 45579 with force... at /usr/local/share/perl/5.30.0/Test/Nginx/Util.pm line 707.
t/admin/routes.t .. 37/?
#   Failed test 'ERROR: client socket timed out - t/admin/routes.t TEST 12: invalid id
# '
#   at /usr/local/share/perl/5.30.0/Test/Nginx/Socket.pm line 2206.

#   Failed test 't/admin/routes.t TEST 12: invalid id - status code ok'
#   at /usr/local/share/perl/5.30.0/Test/Nginx/Socket.pm line 936.
#          got: ''
#     expected: '400'

#   Failed test 't/admin/routes.t TEST 12: invalid id - response_body - response is expected (repeated req 0, req 0)'
#   at /usr/local/share/perl/5.30.0/Test/Nginx/Socket.pm line 1660.
#          got: ''
#     expected: '{"error_msg":"wrong route id"}
# '
t/admin/routes.t TEST 13: id in the rule - timeout when waiting for the process 45588 to exit at /usr/local/share/perl/5.30.0/Test/Nginx/Util.pm line 668.
t/admin/routes.t TEST 13: id in the rule - WARNING: killing the child process 45588 with force... at /usr/local/share/perl/5.30.0/Test/Nginx/Util.pm line 707.
t/admin/routes.t .. 41/? t/admin/routes.t TEST 14: integer id less than 1 - timeout when waiting for the process 45597 to exit at /usr/local/share/perl/5.30.0/Test/Nginx/Util.pm line 668.
t/admin/routes.t TEST 14: integer id less than 1 - WARNING: killing the child process 45597 with force... at /usr/local/share/perl/5.30.0/Test/Nginx/Util.pm line 707.
t/admin/routes.t .. 44/? t/admin/routes.t TEST 15: invalid upstream_id - timeout when waiting for the process 45606 to exit at /usr/local/share/perl/5.30.0/Test/Nginx/Util.pm line 668.
t/admin/routes.t TEST 15: invalid upstream_id - WARNING: killing the child process 45606 with force... at /usr/local/share/perl/5.30.0/Test/Nginx/Util.pm line 707.
t/admin/routes.t .. 47/?
#   Failed test 'ERROR: client socket timed out - t/admin/routes.t TEST 15: invalid upstream_id
# '
#   at /usr/local/share/perl/5.30.0/Test/Nginx/Socket.pm line 2206.

#   Failed test 't/admin/routes.t TEST 15: invalid upstream_id - status code ok'
#   at /usr/local/share/perl/5.30.0/Test/Nginx/Socket.pm line 936.
#          got: ''
#     expected: '400'

#   Failed test 't/admin/routes.t TEST 15: invalid upstream_id - response_body - response is expected (repeated req 0, req 0)'
#   at /usr/local/share/perl/5.30.0/Test/Nginx/Socket.pm line 1660.
#          got: ''
#     expected: '{"error_msg":"invalid configuration: property \"upstream_id\" validation failed: object matches none of the required"}
# '
t/admin/routes.t TEST 16: not exist upstream_id - timeout when waiting for the process 45615 to exit at /usr/local/share/perl/5.30.0/Test/Nginx/Util.pm line 668.
t/admin/routes.t TEST 16: not exist upstream_id - WARNING: killing the child process 45615 with force... at /usr/local/share/perl/5.30.0/Test/Nginx/Util.pm line 707.
t/admin/routes.t .. 51/? t/admin/routes.t TEST 17: wrong route id, do not need it - timeout when waiting for the process 45624 to exit at /usr/local/share/perl/5.30.0/Test/Nginx/Util.pm line 668.
t/admin/routes.t TEST 17: wrong route id, do not need it - WARNING: killing the child process 45624 with force... at /usr/local/share/perl/5.30.0/Test/Nginx/Util.pm line 707.
t/admin/routes.t .. 54/? t/admin/routes.t TEST 18: wrong route id, do not need it - timeout when waiting for the process 45633 to exit at /usr/local/share/perl/5.30.0/Test/Nginx/Util.pm line 668.
t/admin/routes.t TEST 18: wrong route id, do not need it - WARNING: killing the child process 45633 with force... at /usr/local/share/perl/5.30.0/Test/Nginx/Util.pm line 707.
t/admin/routes.t .. 57/?
#   Failed test 'ERROR: client socket timed out - t/admin/routes.t TEST 18: wrong route id, do not need it
# '
#   at /usr/local/share/perl/5.30.0/Test/Nginx/Socket.pm line 2206.

#   Failed test 't/admin/routes.t TEST 18: wrong route id, do not need it - status code ok'
#   at /usr/local/share/perl/5.30.0/Test/Nginx/Socket.pm line 936.
#          got: ''
#     expected: '400'

#   Failed test 't/admin/routes.t TEST 18: wrong route id, do not need it - response_body - response is expected (repeated req 0, req 0)'
#   at /usr/local/share/perl/5.30.0/Test/Nginx/Socket.pm line 1660.
#          got: ''
#     expected: '{"error_msg":"wrong route id, do not need it"}
# '
t/admin/routes.t TEST 19: limit-count with `disable` option - timeout when waiting for the process 45642 to exit at /usr/local/share/perl/5.30.0/Test/Nginx/Util.pm line 668.
t/admin/routes.t TEST 19: limit-count with `disable` option - WARNING: killing the child process 45642 with force... at /usr/local/share/perl/5.30.0/Test/Nginx/Util.pm line 707.
t/admin/routes.t .. 61/? t/admin/routes.t TEST 20: host: *.foo.com - timeout when waiting for the process 45651 to exit at /usr/local/share/perl/5.30.0/Test/Nginx/Util.pm line 668.
t/admin/routes.t TEST 20: host: *.foo.com - WARNING: killing the child process 45651 with force... at /usr/local/share/perl/5.30.0/Test/Nginx/Util.pm line 707.
t/admin/routes.t .. 64/? t/admin/routes.t TEST 21: invalid host: a.*.foo.com - timeout when waiting for the process 45660 to exit at /usr/local/share/perl/5.30.0/Test/Nginx/Util.pm line 668.
t/admin/routes.t TEST 21: invalid host: a.*.foo.com - WARNING: killing the child process 45660 with force... at /usr/local/share/perl/5.30.0/Test/Nginx/Util.pm line 707.
t/admin/routes.t .. 67/?
#   Failed test 'ERROR: client socket timed out - t/admin/routes.t TEST 21: invalid host: a.*.foo.com
# '
#   at /usr/local/share/perl/5.30.0/Test/Nginx/Socket.pm line 2206.

#   Failed test 't/admin/routes.t TEST 21: invalid host: a.*.foo.com - status code ok'
#   at /usr/local/share/perl/5.30.0/Test/Nginx/Socket.pm line 936.
#          got: ''
#     expected: '400'

#   Failed test 't/admin/routes.t TEST 21: invalid host: a.*.foo.com - response_body_like - response is expected ()'
#   at /usr/local/share/perl/5.30.0/Test/Nginx/Socket.pm line 1706.
#                   ''
#     doesn't match '(?^s:{"error_msg":"invalid configuration: property \\"host\\" validation failed: failed to match pattern .*
# )'
t/admin/routes.t TEST 22: invalid host: *.a.*.foo.com - timeout when waiting for the process 45669 to exit at /usr/local/share/perl/5.30.0/Test/Nginx/Util.pm line 668.
t/admin/routes.t TEST 22: invalid host: *.a.*.foo.com - WARNING: killing the child process 45669 with force... at /usr/local/share/perl/5.30.0/Test/Nginx/Util.pm line 707.
t/admin/routes.t .. 71/? t/admin/routes.t TEST 23: removing the init_dir key from etcd can still list all routes - timeout when waiting for the process 45678 to exit at /usr/local/share/perl/5.30.0/Test/Nginx/Util.pm line 668.
t/admin/routes.t TEST 23: removing the init_dir key from etcd can still list all routes - WARNING: killing the child process 45678 with force... at /usr/local/share/perl/5.30.0/Test/Nginx/Util.pm line 707.
t/admin/routes.t .. 74/? END - timeout when waiting for the process 45687 to exit at /usr/local/share/perl/5.30.0/Test/Nginx/Util.pm line 668.
END - WARNING: killing the child process 45687 with force... at /usr/local/share/perl/5.30.0/Test/Nginx/Util.pm line 707.
t/admin/routes.t .. Failed 21/76 subtests

Test Summary Report
-------------------
t/admin/routes.t (Wstat: 0 Tests: 76 Failed: 21)
  Failed tests:  7-9, 17-19, 27-29, 37-39, 47-49, 57-59
                67-69
  Parse errors: No plan found in TAP output
Files=1, Tests=76, 210 wallclock secs ( 0.03 usr  0.01 sys +  1.24 cusr  0.98 csys =  2.26 CPU)
Result: FAIL

[deiwin]

I actually opened this PR hoping that I could use the CI system to validate my changes, but unfortunately it looks like not all PRs are automatically validated by CI.