Add support for `TRACE_HTTP_CLIENT_TAG_QUERY_STRING` and change default value of `HTTP_CLIENT_TAG_QUERY_STRING` to `true` #7677

mhlidd · 2024-09-24T13:13:30Z

What Does This Do

Changes the default value of the HTTP_CLIENT_TAG_QUERY_STRING to have the value of true instead of false to be consistent with other language defaults. Additionally, we add support to handle
the TRACE_HTTP_CLIENT_TAG_QUERY_STRING tag as well as the original HTTP_CLIENT_TAG_QUERY_STRING in efforts to be more consistent with the tags from other languages as well.

Motivation

Our goal is to make the implementation of configuration variables consistent for all languages as part of the config consistency effort listed in the following RFC.

Additional Notes

In Release Notes: Mention the change of the default value of the HTTP_CLIENT_TAG_QUERY_STRING to true and state that the tag can be manually set to false

Contributor Checklist

Format the title according the contribution guidelines
Assign the type: and (comp: or inst:) labels in addition to any usefull labels
Squash your commits prior merging or merge using GitHub's Squash and merge
Don't use close, fix or any linking keywords when referencing an issue.
Use solves instead, and assign the PR milestone to the issue
Update the public documentation in case of new configuration flag or behavior

Jira ticket: [PROJ-IDENT]

pr-commenter · 2024-09-26T15:31:19Z

Benchmarks

Startup

Parameters

	Baseline	Candidate
baseline_or_candidate	baseline	candidate
git_branch	master	mhlidd/client_tag_query
git_commit_date	1730205460	1730216816
git_commit_sha	`9d6a07b`	`4f35efe`
release_version	1.42.0-SNAPSHOT~9d6a07b28b	1.42.0-SNAPSHOT~4f35efe453

See matching parameters

	Baseline	Candidate
application	insecure-bank	insecure-bank
ci_job_date	1730219197	1730219197
ci_job_id	688407706	688407706
ci_pipeline_id	47735343	47735343
cpu_model	Intel(R) Xeon(R) Platinum 8259CL CPU @ 2.50GHz	Intel(R) Xeon(R) Platinum 8259CL CPU @ 2.50GHz
module	Agent	Agent
parent	None	None
variant	iast	iast

Summary

Found 0 performance improvements and 0 performance regressions! Performance is the same for 53 metrics, 10 unstable metrics.

Startup time reports for petclinic

gantt
    title petclinic - global startup overhead: candidate=1.42.0-SNAPSHOT~4f35efe453, baseline=1.42.0-SNAPSHOT~9d6a07b28b

    dateFormat X
    axisFormat %s
section tracing
Agent [baseline] (1.083 s) : 0, 1083223
Total [baseline] (10.423 s) : 0, 10423177
Agent [candidate] (1.077 s) : 0, 1076609
Total [candidate] (10.314 s) : 0, 10313721
section appsec
Agent [baseline] (1.221 s) : 0, 1221383
Total [baseline] (10.645 s) : 0, 10645115
Agent [candidate] (1.213 s) : 0, 1212641
Total [candidate] (10.613 s) : 0, 10612552
section iast
Agent [baseline] (1.201 s) : 0, 1200978
Total [baseline] (10.881 s) : 0, 10880736
Agent [candidate] (1.202 s) : 0, 1202017
Total [candidate] (10.837 s) : 0, 10837278
section profiling
Agent [baseline] (1.281 s) : 0, 1280544
Total [baseline] (10.759 s) : 0, 10758677
Agent [candidate] (1.273 s) : 0, 1272944
Total [candidate] (10.732 s) : 0, 10731910

baseline results

Module	Variant	Duration	Δ tracing
Agent	tracing	1.083 s	-
Agent	appsec	1.221 s	138.16 ms (12.8%)
Agent	iast	1.201 s	117.755 ms (10.9%)
Agent	profiling	1.281 s	197.321 ms (18.2%)
Total	tracing	10.423 s	-
Total	appsec	10.645 s	221.938 ms (2.1%)
Total	iast	10.881 s	457.559 ms (4.4%)
Total	profiling	10.759 s	335.5 ms (3.2%)

candidate results

Module	Variant	Duration	Δ tracing
Agent	tracing	1.077 s	-
Agent	appsec	1.213 s	136.032 ms (12.6%)
Agent	iast	1.202 s	125.408 ms (11.6%)
Agent	profiling	1.273 s	196.335 ms (18.2%)
Total	tracing	10.314 s	-
Total	appsec	10.613 s	298.831 ms (2.9%)
Total	iast	10.837 s	523.557 ms (5.1%)
Total	profiling	10.732 s	418.189 ms (4.1%)

gantt
    title petclinic - break down per module: candidate=1.42.0-SNAPSHOT~4f35efe453, baseline=1.42.0-SNAPSHOT~9d6a07b28b

    dateFormat X
    axisFormat %s
section tracing
BytebuddyAgent [baseline] (689.451 ms) : 0, 689451
BytebuddyAgent [candidate] (684.327 ms) : 0, 684327
GlobalTracer [baseline] (315.297 ms) : 0, 315297
GlobalTracer [candidate] (314.216 ms) : 0, 314216
AppSec [baseline] (54.254 ms) : 0, 54254
AppSec [candidate] (53.975 ms) : 0, 53975
Remote Config [baseline] (666.182 µs) : 0, 666
Remote Config [candidate] (684.141 µs) : 0, 684
Telemetry [baseline] (9.861 ms) : 0, 9861
Telemetry [candidate] (9.784 ms) : 0, 9784
section appsec
BytebuddyAgent [baseline] (708.665 ms) : 0, 708665
BytebuddyAgent [candidate] (704.219 ms) : 0, 704219
GlobalTracer [baseline] (314.093 ms) : 0, 314093
GlobalTracer [candidate] (311.296 ms) : 0, 311296
AppSec [baseline] (165.475 ms) : 0, 165475
AppSec [candidate] (165.267 ms) : 0, 165267
IAST [baseline] (20.739 ms) : 0, 20739
IAST [candidate] (19.116 ms) : 0, 19116
Remote Config [baseline] (637.0 µs) : 0, 637
Remote Config [candidate] (633.833 µs) : 0, 634
Telemetry [baseline] (8.401 ms) : 0, 8401
Telemetry [candidate] (8.009 ms) : 0, 8009
section iast
BytebuddyAgent [baseline] (800.005 ms) : 0, 800005
BytebuddyAgent [candidate] (801.429 ms) : 0, 801429
GlobalTracer [baseline] (302.105 ms) : 0, 302105
GlobalTracer [candidate] (302.333 ms) : 0, 302333
AppSec [baseline] (57.317 ms) : 0, 57317
AppSec [candidate] (56.223 ms) : 0, 56223
IAST [baseline] (19.882 ms) : 0, 19882
IAST [candidate] (20.545 ms) : 0, 20545
Remote Config [baseline] (612.512 µs) : 0, 613
Remote Config [candidate] (585.634 µs) : 0, 586
Telemetry [baseline] (7.468 ms) : 0, 7468
Telemetry [candidate] (7.261 ms) : 0, 7261
section profiling
BytebuddyAgent [baseline] (683.727 ms) : 0, 683727
BytebuddyAgent [candidate] (679.029 ms) : 0, 679029
GlobalTracer [baseline] (398.743 ms) : 0, 398743
GlobalTracer [candidate] (396.882 ms) : 0, 396882
AppSec [baseline] (54.583 ms) : 0, 54583
AppSec [candidate] (54.123 ms) : 0, 54123
Remote Config [baseline] (668.435 µs) : 0, 668
Remote Config [candidate] (662.821 µs) : 0, 663
Telemetry [baseline] (13.369 ms) : 0, 13369
Telemetry [candidate] (11.814 ms) : 0, 11814
ProfilingAgent [baseline] (90.534 ms) : 0, 90534
ProfilingAgent [candidate] (91.736 ms) : 0, 91736
Profiling [baseline] (90.557 ms) : 0, 90557
Profiling [candidate] (91.76 ms) : 0, 91760

Startup time reports for insecure-bank

gantt
    title insecure-bank - global startup overhead: candidate=1.42.0-SNAPSHOT~4f35efe453, baseline=1.42.0-SNAPSHOT~9d6a07b28b

    dateFormat X
    axisFormat %s
section tracing
Agent [baseline] (1.08 s) : 0, 1080144
Total [baseline] (8.578 s) : 0, 8577618
Agent [candidate] (1.076 s) : 0, 1075737
Total [candidate] (8.544 s) : 0, 8544495
section iast
Agent [baseline] (1.203 s) : 0, 1202543
Total [baseline] (9.076 s) : 0, 9075609
Agent [candidate] (1.201 s) : 0, 1201052
Total [candidate] (9.085 s) : 0, 9085327
section iast_HARDCODED_SECRET_DISABLED
Agent [baseline] (1.199 s) : 0, 1199158
Total [baseline] (9.056 s) : 0, 9056170
Agent [candidate] (1.199 s) : 0, 1199434
Total [candidate] (9.086 s) : 0, 9085608
section iast_TELEMETRY_OFF
Agent [baseline] (1.198 s) : 0, 1198121
Total [baseline] (9.085 s) : 0, 9084517
Agent [candidate] (1.195 s) : 0, 1194990
Total [candidate] (9.098 s) : 0, 9097736

baseline results

Module	Variant	Duration	Δ tracing
Agent	tracing	1.08 s	-
Agent	iast	1.203 s	122.398 ms (11.3%)
Agent	iast_HARDCODED_SECRET_DISABLED	1.199 s	119.014 ms (11.0%)
Agent	iast_TELEMETRY_OFF	1.198 s	117.977 ms (10.9%)
Total	tracing	8.578 s	-
Total	iast	9.076 s	497.991 ms (5.8%)
Total	iast_HARDCODED_SECRET_DISABLED	9.056 s	478.553 ms (5.6%)
Total	iast_TELEMETRY_OFF	9.085 s	506.899 ms (5.9%)

candidate results

Module	Variant	Duration	Δ tracing
Agent	tracing	1.076 s	-
Agent	iast	1.201 s	125.316 ms (11.6%)
Agent	iast_HARDCODED_SECRET_DISABLED	1.199 s	123.697 ms (11.5%)
Agent	iast_TELEMETRY_OFF	1.195 s	119.254 ms (11.1%)
Total	tracing	8.544 s	-
Total	iast	9.085 s	540.833 ms (6.3%)
Total	iast_HARDCODED_SECRET_DISABLED	9.086 s	541.113 ms (6.3%)
Total	iast_TELEMETRY_OFF	9.098 s	553.242 ms (6.5%)

gantt
    title insecure-bank - break down per module: candidate=1.42.0-SNAPSHOT~4f35efe453, baseline=1.42.0-SNAPSHOT~9d6a07b28b

    dateFormat X
    axisFormat %s
section tracing
BytebuddyAgent [baseline] (686.773 ms) : 0, 686773
BytebuddyAgent [candidate] (684.974 ms) : 0, 684974
GlobalTracer [baseline] (314.96 ms) : 0, 314960
GlobalTracer [candidate] (313.567 ms) : 0, 313567
AppSec [baseline] (54.334 ms) : 0, 54334
AppSec [candidate] (53.873 ms) : 0, 53873
Remote Config [baseline] (662.021 µs) : 0, 662
Remote Config [candidate] (664.777 µs) : 0, 665
Telemetry [baseline] (9.779 ms) : 0, 9779
Telemetry [candidate] (9.078 ms) : 0, 9078
section iast
BytebuddyAgent [baseline] (801.203 ms) : 0, 801203
BytebuddyAgent [candidate] (800.352 ms) : 0, 800352
GlobalTracer [baseline] (302.461 ms) : 0, 302461
GlobalTracer [candidate] (302.194 ms) : 0, 302194
AppSec [baseline] (56.591 ms) : 0, 56591
AppSec [candidate] (57.248 ms) : 0, 57248
IAST [baseline] (20.687 ms) : 0, 20687
IAST [candidate] (19.675 ms) : 0, 19675
Remote Config [baseline] (609.137 µs) : 0, 609
Remote Config [candidate] (593.538 µs) : 0, 594
Telemetry [baseline] (7.357 ms) : 0, 7357
Telemetry [candidate] (7.344 ms) : 0, 7344
section iast_HARDCODED_SECRET_DISABLED
BytebuddyAgent [baseline] (798.855 ms) : 0, 798855
BytebuddyAgent [candidate] (798.776 ms) : 0, 798776
GlobalTracer [baseline] (301.869 ms) : 0, 301869
GlobalTracer [candidate] (302.084 ms) : 0, 302084
AppSec [baseline] (56.519 ms) : 0, 56519
AppSec [candidate] (57.226 ms) : 0, 57226
IAST [baseline] (20.488 ms) : 0, 20488
IAST [candidate] (19.743 ms) : 0, 19743
Remote Config [baseline] (594.053 µs) : 0, 594
Remote Config [candidate] (606.879 µs) : 0, 607
Telemetry [baseline] (7.261 ms) : 0, 7261
Telemetry [candidate] (7.39 ms) : 0, 7390
section iast_TELEMETRY_OFF
BytebuddyAgent [baseline] (797.149 ms) : 0, 797149
BytebuddyAgent [candidate] (795.616 ms) : 0, 795616
GlobalTracer [baseline] (302.571 ms) : 0, 302571
GlobalTracer [candidate] (301.473 ms) : 0, 301473
AppSec [baseline] (57.382 ms) : 0, 57382
AppSec [candidate] (56.314 ms) : 0, 56314
IAST [baseline] (19.497 ms) : 0, 19497
IAST [candidate] (20.186 ms) : 0, 20186
Remote Config [baseline] (593.199 µs) : 0, 593
Remote Config [candidate] (583.645 µs) : 0, 584
Telemetry [baseline] (7.324 ms) : 0, 7324
Telemetry [candidate] (7.24 ms) : 0, 7240

Load

Parameters

	Baseline	Candidate
baseline_or_candidate	baseline	candidate
end_time	2024-10-29T15:57:12	2024-10-29T16:04:11
git_branch	master	mhlidd/client_tag_query
git_commit_date	1730205460	1730216816
git_commit_sha	`9d6a07b`	`4f35efe`
release_version	1.42.0-SNAPSHOT~9d6a07b28b	1.42.0-SNAPSHOT~4f35efe453
start_time	2024-10-29T15:56:59	2024-10-29T16:03:58

See matching parameters

	Baseline	Candidate
application	insecure-bank	insecure-bank
ci_job_date	1730218201	1730218201
ci_job_id	688407707	688407707
ci_pipeline_id	47735343	47735343
cpu_model	Intel(R) Xeon(R) Platinum 8259CL CPU @ 2.50GHz	Intel(R) Xeon(R) Platinum 8259CL CPU @ 2.50GHz
variant	iast	iast

Summary

Found 0 performance improvements and 0 performance regressions! Performance is the same for 13 metrics, 15 unstable metrics.

Request duration reports for insecure-bank

gantt
    title insecure-bank - request duration [CI 0.99] : candidate=1.42.0-SNAPSHOT~4f35efe453, baseline=1.42.0-SNAPSHOT~9d6a07b28b
    dateFormat X
    axisFormat %s
section baseline
no_agent (383.429 µs) : 364, 403
.   : milestone, 383,
iast (503.188 µs) : 482, 525
.   : milestone, 503,
iast_FULL (651.962 µs) : 631, 673
.   : milestone, 652,
iast_GLOBAL (524.895 µs) : 504, 546
.   : milestone, 525,
iast_HARDCODED_SECRET_DISABLED (486.672 µs) : 466, 508
.   : milestone, 487,
iast_INACTIVE (462.421 µs) : 441, 484
.   : milestone, 462,
iast_TELEMETRY_OFF (478.872 µs) : 458, 500
.   : milestone, 479,
tracing (448.084 µs) : 427, 469
.   : milestone, 448,
section candidate
no_agent (381.924 µs) : 362, 401
.   : milestone, 382,
iast (495.208 µs) : 474, 517
.   : milestone, 495,
iast_FULL (647.846 µs) : 626, 669
.   : milestone, 648,
iast_GLOBAL (525.094 µs) : 503, 547
.   : milestone, 525,
iast_HARDCODED_SECRET_DISABLED (496.095 µs) : 475, 518
.   : milestone, 496,
iast_INACTIVE (451.757 µs) : 431, 473
.   : milestone, 452,
iast_TELEMETRY_OFF (482.317 µs) : 461, 504
.   : milestone, 482,
tracing (446.278 µs) : 426, 467
.   : milestone, 446,

baseline results

Variant	Request duration [CI 0.99]	Δ no_agent
no_agent	383.429 µs [363.781 µs, 403.076 µs]	-
iast	503.188 µs [481.525 µs, 524.852 µs]	119.76 µs (31.2%)
iast_FULL	651.962 µs [630.529 µs, 673.395 µs]	268.534 µs (70.0%)
iast_GLOBAL	524.895 µs [503.792 µs, 545.997 µs]	141.466 µs (36.9%)
iast_HARDCODED_SECRET_DISABLED	486.672 µs [465.57 µs, 507.773 µs]	103.243 µs (26.9%)
iast_INACTIVE	462.421 µs [440.797 µs, 484.046 µs]	78.993 µs (20.6%)
iast_TELEMETRY_OFF	478.872 µs [458.06 µs, 499.685 µs]	95.444 µs (24.9%)
tracing	448.084 µs [427.491 µs, 468.677 µs]	64.656 µs (16.9%)

candidate results

Variant	Request duration [CI 0.99]	Δ no_agent
no_agent	381.924 µs [362.421 µs, 401.428 µs]	-
iast	495.208 µs [473.596 µs, 516.82 µs]	113.284 µs (29.7%)
iast_FULL	647.846 µs [626.335 µs, 669.358 µs]	265.922 µs (69.6%)
iast_GLOBAL	525.094 µs [503.014 µs, 547.174 µs]	143.17 µs (37.5%)
iast_HARDCODED_SECRET_DISABLED	496.095 µs [474.654 µs, 517.537 µs]	114.171 µs (29.9%)
iast_INACTIVE	451.757 µs [430.907 µs, 472.608 µs]	69.833 µs (18.3%)
iast_TELEMETRY_OFF	482.317 µs [461.056 µs, 503.579 µs]	100.393 µs (26.3%)
tracing	446.278 µs [425.834 µs, 466.722 µs]	64.354 µs (16.8%)

Request duration reports for petclinic

gantt
    title petclinic - request duration [CI 0.99] : candidate=1.42.0-SNAPSHOT~4f35efe453, baseline=1.42.0-SNAPSHOT~9d6a07b28b
    dateFormat X
    axisFormat %s
section baseline
no_agent (1.338 ms) : 1319, 1358
.   : milestone, 1338,
appsec (1.753 ms) : 1727, 1778
.   : milestone, 1753,
appsec_no_iast (1.73 ms) : 1705, 1754
.   : milestone, 1730,
iast (1.492 ms) : 1469, 1515
.   : milestone, 1492,
profiling (1.517 ms) : 1493, 1541
.   : milestone, 1517,
tracing (1.493 ms) : 1466, 1520
.   : milestone, 1493,
section candidate
no_agent (1.348 ms) : 1328, 1368
.   : milestone, 1348,
appsec (1.715 ms) : 1692, 1737
.   : milestone, 1715,
appsec_no_iast (1.713 ms) : 1688, 1738
.   : milestone, 1713,
iast (1.491 ms) : 1469, 1513
.   : milestone, 1491,
profiling (1.49 ms) : 1467, 1514
.   : milestone, 1490,
tracing (1.486 ms) : 1463, 1510
.   : milestone, 1486,

baseline results

Variant	Request duration [CI 0.99]	Δ no_agent
no_agent	1.338 ms [1.319 ms, 1.358 ms]	-
appsec	1.753 ms [1.727 ms, 1.778 ms]	414.387 µs (31.0%)
appsec_no_iast	1.73 ms [1.705 ms, 1.754 ms]	391.194 µs (29.2%)
iast	1.492 ms [1.469 ms, 1.515 ms]	153.932 µs (11.5%)
profiling	1.517 ms [1.493 ms, 1.541 ms]	178.77 µs (13.4%)
tracing	1.493 ms [1.466 ms, 1.52 ms]	154.303 µs (11.5%)

candidate results

Variant	Request duration [CI 0.99]	Δ no_agent
no_agent	1.348 ms [1.328 ms, 1.368 ms]	-
appsec	1.715 ms [1.692 ms, 1.737 ms]	366.55 µs (27.2%)
appsec_no_iast	1.713 ms [1.688 ms, 1.738 ms]	364.924 µs (27.1%)
iast	1.491 ms [1.469 ms, 1.513 ms]	143.018 µs (10.6%)
profiling	1.49 ms [1.467 ms, 1.514 ms]	142.493 µs (10.6%)
tracing	1.486 ms [1.463 ms, 1.51 ms]	138.348 µs (10.3%)

Dacapo

Parameters

	Baseline	Candidate
baseline_or_candidate	baseline	candidate
git_branch	master	mhlidd/client_tag_query
git_commit_date	1730205460	1730216816
git_commit_sha	`9d6a07b`	`4f35efe`
release_version	1.42.0-SNAPSHOT~9d6a07b28b	1.42.0-SNAPSHOT~4f35efe453

See matching parameters

	Baseline	Candidate
application	biojava	biojava
ci_job_date	1730218743	1730218743
ci_job_id	688407708	688407708
ci_pipeline_id	47735343	47735343
cpu_model	Intel(R) Xeon(R) Platinum 8259CL CPU @ 2.50GHz	Intel(R) Xeon(R) Platinum 8259CL CPU @ 2.50GHz
variant	appsec	appsec

Summary

Found 0 performance improvements and 0 performance regressions! Performance is the same for 12 metrics, 0 unstable metrics.

Execution time for biojava

gantt
    title biojava - execution time [CI 0.99] : candidate=1.42.0-SNAPSHOT~4f35efe453, baseline=1.42.0-SNAPSHOT~9d6a07b28b
    dateFormat X
    axisFormat %s
section baseline
no_agent (15.775 s) : 15775000, 15775000
.   : milestone, 15775000,
appsec (15.253 s) : 15253000, 15253000
.   : milestone, 15253000,
iast (18.883 s) : 18883000, 18883000
.   : milestone, 18883000,
iast_GLOBAL (18.129 s) : 18129000, 18129000
.   : milestone, 18129000,
profiling (15.71 s) : 15710000, 15710000
.   : milestone, 15710000,
tracing (15.222 s) : 15222000, 15222000
.   : milestone, 15222000,
section candidate
no_agent (15.091 s) : 15091000, 15091000
.   : milestone, 15091000,
appsec (15.217 s) : 15217000, 15217000
.   : milestone, 15217000,
iast (19.215 s) : 19215000, 19215000
.   : milestone, 19215000,
iast_GLOBAL (18.072 s) : 18072000, 18072000
.   : milestone, 18072000,
profiling (15.707 s) : 15707000, 15707000
.   : milestone, 15707000,
tracing (15.308 s) : 15308000, 15308000
.   : milestone, 15308000,

baseline results

Variant	Execution Time [CI 0.99]	Δ no_agent
no_agent	15.775 s [15.775 s, 15.775 s]	-
appsec	15.253 s [15.253 s, 15.253 s]	-522.0 ms (-3.3%)
iast	18.883 s [18.883 s, 18.883 s]	3.108 s (19.7%)
iast_GLOBAL	18.129 s [18.129 s, 18.129 s]	2.354 s (14.9%)
profiling	15.71 s [15.71 s, 15.71 s]	-65.0 ms (-0.4%)
tracing	15.222 s [15.222 s, 15.222 s]	-553.0 ms (-3.5%)

candidate results

Variant	Execution Time [CI 0.99]	Δ no_agent
no_agent	15.091 s [15.091 s, 15.091 s]	-
appsec	15.217 s [15.217 s, 15.217 s]	126.0 ms (0.8%)
iast	19.215 s [19.215 s, 19.215 s]	4.124 s (27.3%)
iast_GLOBAL	18.072 s [18.072 s, 18.072 s]	2.981 s (19.8%)
profiling	15.707 s [15.707 s, 15.707 s]	616.0 ms (4.1%)
tracing	15.308 s [15.308 s, 15.308 s]	217.0 ms (1.4%)

Execution time for tomcat

gantt
    title tomcat - execution time [CI 0.99] : candidate=1.42.0-SNAPSHOT~4f35efe453, baseline=1.42.0-SNAPSHOT~9d6a07b28b
    dateFormat X
    axisFormat %s
section baseline
no_agent (1.475 ms) : 1463, 1486
.   : milestone, 1475,
appsec (2.357 ms) : 2315, 2399
.   : milestone, 2357,
iast (2.096 ms) : 2044, 2148
.   : milestone, 2096,
iast_GLOBAL (2.131 ms) : 2079, 2184
.   : milestone, 2131,
profiling (1.931 ms) : 1890, 1972
.   : milestone, 1931,
tracing (1.931 ms) : 1891, 1971
.   : milestone, 1931,
section candidate
no_agent (1.467 ms) : 1456, 1479
.   : milestone, 1467,
appsec (2.341 ms) : 2299, 2382
.   : milestone, 2341,
iast (2.075 ms) : 2024, 2127
.   : milestone, 2075,
iast_GLOBAL (2.124 ms) : 2072, 2177
.   : milestone, 2124,
profiling (1.945 ms) : 1903, 1987
.   : milestone, 1945,
tracing (1.915 ms) : 1875, 1954
.   : milestone, 1915,

baseline results

Variant	Execution Time [CI 0.99]	Δ no_agent
no_agent	1.475 ms [1.463 ms, 1.486 ms]	-
appsec	2.357 ms [2.315 ms, 2.399 ms]	882.302 µs (59.8%)
iast	2.096 ms [2.044 ms, 2.148 ms]	621.241 µs (42.1%)
iast_GLOBAL	2.131 ms [2.079 ms, 2.184 ms]	656.718 µs (44.5%)
profiling	1.931 ms [1.89 ms, 1.972 ms]	456.479 µs (31.0%)
tracing	1.931 ms [1.891 ms, 1.971 ms]	456.455 µs (31.0%)

candidate results

Variant	Execution Time [CI 0.99]	Δ no_agent
no_agent	1.467 ms [1.456 ms, 1.479 ms]	-
appsec	2.341 ms [2.299 ms, 2.382 ms]	873.564 µs (59.5%)
iast	2.075 ms [2.024 ms, 2.127 ms]	608.355 µs (41.5%)
iast_GLOBAL	2.124 ms [2.072 ms, 2.177 ms]	657.139 µs (44.8%)
profiling	1.945 ms [1.903 ms, 1.987 ms]	478.08 µs (32.6%)
tracing	1.915 ms [1.875 ms, 1.954 ms]	447.542 µs (30.5%)

PerfectSlayer

Is the PR ready for review? I can see a bunch of leftovers 🤔

If not, thank for using draft as mentioned in contribution guidelines 🙏

internal-api/src/main/java/datadog/trace/bootstrap/config/provider/ConfigProvider.java

internal-api/src/main/java/datadog/trace/api/Config.java

...opentracing/api-0.31/src/main/java/datadog/trace/instrumentation/opentracing31/OTTracer.java

mhlidd · 2024-09-26T17:09:34Z

Is the PR ready for review? I can see a bunch of leftovers 🤔

If not, thank for using draft as mentioned in contribution guidelines 🙏

Accidentally marked as ready earlier. Code has been cleaned up and is ready for review! 🙇
@PerfectSlayer

PerfectSlayer

About test changes, it feels this duplicate the test url handling for #url test twice without adding new behavior test. If the goal is to test the setting is well applied, it is already covered through config name alias tests.

If you still want have a test for this behavior, I would recommend creating a parametric tests with all possible user config combinations (new config to null, true, false + old config to new, true, false) and only checking at the value the config returns (from Config.isHttpClientTagQueryString()).

internal-api/src/main/java/datadog/trace/api/Config.java

mtoffl01 · 2024-09-27T19:43:36Z

...test/groovy/datadog/trace/bootstrap/instrumentation/decorator/HttpClientDecoratorTest.groovy

@@ -98,6 +100,110 @@ class HttpClientDecoratorTest extends ClientDecoratorTest {
    req = [url: url == null ? null : new URI(url)]
  }

+  def "test url handling for #url : trace env var"() {


Rather than differentiating these tests with "default env var" and "trace env var," I'd suggest actually using the env var names (Because "default" didn't mean anything to me until I read "trace"): DD_HTTP_CLIENT_TAG_QUERY_STRING and DD_TRACE_HTTP_CLIENT_TAG_QUERY_STRING.

Not sure if this conflicts with Java standards, but just my two cents from a generic code reader

Spock test methods does not have to respect Java standards, so we're good here.

But if we really want to test the behavior with all the different config values (I started a discussion with @mhlidd already as it feels more like testing config rather than testing the HTTP client decorator), I would recommend creating test child classes, having the config setting / retrieval in the parent abstract method. -- and here, the class name will have to respect the standards 😉

PerfectSlayer

If the new default behavior is to have TRACE_HTTP_CLIENT_TAG_QUERY_STRING enabled, you would have to update all the tests that break with this new behavior rather than disabling it with injectSysConfig(TRACE_HTTP_CLIENT_TAG_QUERY_STRING, "false") -- I'm referring to the integration test updates.

dd-trace-api/src/main/java/datadog/trace/api/config/TraceInstrumentationConfig.java

...entation/aws-common/src/main/java/datadog/trace/instrumentation/aws/ExpectedQueryParams.java

…ng tests rebasing

merge conflicts rebase

fixing merge conflicts through rebase

PerfectSlayer

That's great improvements! 🙌
I left a bunch of comments as there are some changes needed but the hardest part is done 😉

dd-java-agent/instrumentation/aws-java-sns-1.0/src/test/groovy/SnsClientTest.groovy

PerfectSlayer · 2024-10-28T08:06:56Z

...entation/aws-common/src/main/java/datadog/trace/instrumentation/aws/ExpectedQueryParams.java

+import java.util.Arrays;
+import java.util.List;
+
+public class ExpectedQueryParams {


You can set the class as final and add a private constructor (private ExpectedQueryParams() {}).
This usually denotes utility classes, letting developers know this class only holds utility methods, and should not be instantiated.

In addition, as it is a test class, it would be better to put it under src/test/java rather than src/main/java.

I got it wrong, it is well src/main/java if you would like to be able to reuse it in some other modules 🙇

dd-java-agent/instrumentation/aws-java-sns-2.0/src/test/groovy/SnsClientTest.groovy

dd-java-agent/instrumentation/aws-java-sdk-2.2/build.gradle

dd-java-agent/instrumentation/aws-java-sns-1.0/build.gradle

dd-java-agent/instrumentation/aws-java-sqs-2.0/build.gradle

dd-java-agent/instrumentation/aws-java-sqs-2.0/src/test/groovy/SqsClientTest.groovy

dd-java-agent/instrumentation/mule-4/build.gradle

dd-java-agent/instrumentation/spring-messaging-4/build.gradle

dd-java-agent/testing/src/main/groovy/datadog/trace/agent/test/asserts/TagsAssert.groovy

PerfectSlayer

Looks good to me! Thanks for keep improving it PR 👍

mhlidd added type: enhancement comp: core Tracer core labels Sep 26, 2024

mhlidd requested a review from mtoffl01 September 26, 2024 15:19

mhlidd changed the title ~~testing logs~~ Add support for TRACE_HTTP_CLIENT_TAG_QUERY_STRING and change default value of HTTP_CLIENT_TAG_QUERY_STRING Sep 26, 2024

mhlidd marked this pull request as ready for review September 26, 2024 15:42

mhlidd requested review from a team as code owners September 26, 2024 15:42

mhlidd requested a review from PerfectSlayer September 26, 2024 15:42

PerfectSlayer reviewed Sep 26, 2024

View reviewed changes

PerfectSlayer reviewed Sep 27, 2024

View reviewed changes

internal-api/src/main/java/datadog/trace/api/Config.java Outdated Show resolved Hide resolved

mtoffl01 reviewed Sep 27, 2024

View reviewed changes

mhlidd force-pushed the mhlidd/client_tag_query branch from 91ec4e7 to b8ccaba Compare October 1, 2024 14:53

mhlidd requested review from mtoffl01 and PerfectSlayer October 2, 2024 18:47

PerfectSlayer reviewed Oct 3, 2024

View reviewed changes

dd-trace-api/src/main/java/datadog/trace/api/config/TraceInstrumentationConfig.java Show resolved Hide resolved

mhlidd requested a review from PerfectSlayer October 10, 2024 17:07

datadog-datadog-prod-us1 bot reviewed Oct 22, 2024

View reviewed changes

...entation/aws-common/src/main/java/datadog/trace/instrumentation/aws/ExpectedQueryParams.java Outdated Show resolved Hide resolved

mhlidd added 11 commits October 23, 2024 10:46

testing logs

410a1ed

fixing client header tags

aec929c

adding unit tests for env variables

d766849

code cleanup and fixing tests

bcf4d75

final code cleanup

fa453e6

modified existing decorator test to match new var default

9b6b90d

creating config var for trace_http_client_tag_query_string and updati…

8640cbc

…ng tests rebasing

spotless

1ecfec8

fixing more legacy tests

0929d6e

updating config for one more test

e46bf48

changing injectsysconfig

468eaec

mhlidd added 16 commits October 23, 2024 10:48

updating tests with new urlTags

5bf4953

merge conflicts rebase

spotless

fd81622

spotless apply pt2

d3036b0

updating url tag for snsclient test

e31f0f0

spotlesS

2d8fe8a

spotless 2.o

8319190

fixing last 2 tests

680662c

spotless apply

62b744a

removing unused imports

0f4f3de

moving expectedQueryParams to a shared module

a611a57

deleting class binary

f3794f2

adding default case

0f21994

spotless

c4496e0

importing module in last test

7120235

using shared module for last unit teset

fbad63e

adding support for new mule test

1436014

fixing merge conflicts through rebase

mhlidd force-pushed the mhlidd/client_tag_query branch from 95a6728 to 1436014 Compare October 23, 2024 14:50

PerfectSlayer reviewed Oct 28, 2024

View reviewed changes

small PR changes

9ee39fb

mhlidd force-pushed the mhlidd/client_tag_query branch from 81a3a5b to 9ee39fb Compare October 29, 2024 14:04

changing ExpectedQueryParams to a utility class

e1caccf

PerfectSlayer approved these changes Oct 29, 2024

View reviewed changes

mhlidd added 3 commits October 29, 2024 10:35

spotless

d120386

removing unused import

78cf7a5

Merge branch 'master' into mhlidd/client_tag_query

4f35efe

mhlidd merged commit a7982c2 into master Oct 29, 2024
104 checks passed

mhlidd deleted the mhlidd/client_tag_query branch October 29, 2024 17:10

github-actions bot added this to the 1.42.0 milestone Oct 29, 2024

mhlidd changed the title ~~Add support for TRACE_HTTP_CLIENT_TAG_QUERY_STRING and change default value of HTTP_CLIENT_TAG_QUERY_STRING~~ Add support for TRACE_HTTP_CLIENT_TAG_QUERY_STRING and change default value of HTTP_CLIENT_TAG_QUERY_STRING to true Oct 30, 2024

mhlidd added the tag: breaking change Breaking changes label Oct 30, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support for `TRACE_HTTP_CLIENT_TAG_QUERY_STRING` and change default value of `HTTP_CLIENT_TAG_QUERY_STRING` to `true` #7677

Add support for `TRACE_HTTP_CLIENT_TAG_QUERY_STRING` and change default value of `HTTP_CLIENT_TAG_QUERY_STRING` to `true` #7677

mhlidd commented Sep 24, 2024 •

edited

Loading

pr-commenter bot commented Sep 26, 2024 •

edited

Loading

PerfectSlayer left a comment •

edited

Loading

mhlidd commented Sep 26, 2024

PerfectSlayer left a comment •

edited

Loading

mtoffl01 Sep 27, 2024

PerfectSlayer Sep 30, 2024

PerfectSlayer left a comment

PerfectSlayer left a comment

PerfectSlayer Oct 28, 2024

PerfectSlayer Oct 28, 2024

PerfectSlayer Oct 29, 2024

PerfectSlayer left a comment

Add support for TRACE_HTTP_CLIENT_TAG_QUERY_STRING and change default value of HTTP_CLIENT_TAG_QUERY_STRING to true #7677

Add support for TRACE_HTTP_CLIENT_TAG_QUERY_STRING and change default value of HTTP_CLIENT_TAG_QUERY_STRING to true #7677

Conversation

mhlidd commented Sep 24, 2024 • edited Loading

What Does This Do

Motivation

Additional Notes

Contributor Checklist

pr-commenter bot commented Sep 26, 2024 • edited Loading

Benchmarks

Startup

Parameters

Summary

Load

Parameters

Summary

Dacapo

Parameters

Summary

PerfectSlayer left a comment • edited Loading

Choose a reason for hiding this comment

mhlidd commented Sep 26, 2024

PerfectSlayer left a comment • edited Loading

Choose a reason for hiding this comment

mtoffl01 Sep 27, 2024

Choose a reason for hiding this comment

PerfectSlayer Sep 30, 2024

Choose a reason for hiding this comment

PerfectSlayer left a comment

Choose a reason for hiding this comment

PerfectSlayer left a comment

Choose a reason for hiding this comment

PerfectSlayer Oct 28, 2024

Choose a reason for hiding this comment

PerfectSlayer Oct 28, 2024

Choose a reason for hiding this comment

PerfectSlayer Oct 29, 2024

Choose a reason for hiding this comment

PerfectSlayer left a comment

Choose a reason for hiding this comment

Add support for `TRACE_HTTP_CLIENT_TAG_QUERY_STRING` and change default value of `HTTP_CLIENT_TAG_QUERY_STRING` to `true` #7677

Add support for `TRACE_HTTP_CLIENT_TAG_QUERY_STRING` and change default value of `HTTP_CLIENT_TAG_QUERY_STRING` to `true` #7677

mhlidd commented Sep 24, 2024 •

edited

Loading

pr-commenter bot commented Sep 26, 2024 •

edited

Loading

PerfectSlayer left a comment •

edited

Loading

PerfectSlayer left a comment •

edited

Loading