Update doc with latest layout, instrumentation tests updated, and exception suppress note#9559
Conversation
This comment has been minimized.
This comment has been minimized.
BenchmarksStartupParameters
See matching parameters
SummaryFound 0 performance improvements and 0 performance regressions! Performance is the same for 48 metrics, 11 unstable metrics. Startup time reports for petclinicgantt
title petclinic - global startup overhead: candidate=1.54.0-SNAPSHOT~073d4015f7, baseline=1.54.0-SNAPSHOT~561eb5e7af
dateFormat X
axisFormat %s
section tracing
Agent [baseline] (1.063 s) : 0, 1063194
Total [baseline] (10.744 s) : 0, 10744113
Agent [candidate] (1.063 s) : 0, 1062535
Total [candidate] (10.673 s) : 0, 10672699
section appsec
Agent [baseline] (1.242 s) : 0, 1241742
Total [baseline] (11.055 s) : 0, 11054784
Agent [candidate] (1.236 s) : 0, 1236242
Total [candidate] (11.041 s) : 0, 11040720
section iast
Agent [baseline] (1.192 s) : 0, 1191867
Total [baseline] (11.019 s) : 0, 11018904
Agent [candidate] (1.196 s) : 0, 1196300
Total [candidate] (11.084 s) : 0, 11084071
section profiling
Agent [baseline] (1.222 s) : 0, 1222260
Total [baseline] (11.015 s) : 0, 11015174
Agent [candidate] (1.218 s) : 0, 1217983
Total [candidate] (11.019 s) : 0, 11019111
gantt
title petclinic - break down per module: candidate=1.54.0-SNAPSHOT~073d4015f7, baseline=1.54.0-SNAPSHOT~561eb5e7af
dateFormat X
axisFormat %s
section tracing
crashtracking [baseline] (1.474 ms) : 0, 1474
crashtracking [candidate] (1.463 ms) : 0, 1463
BytebuddyAgent [baseline] (734.014 ms) : 0, 734014
BytebuddyAgent [candidate] (732.93 ms) : 0, 732930
GlobalTracer [baseline] (253.304 ms) : 0, 253304
GlobalTracer [candidate] (253.034 ms) : 0, 253034
AppSec [baseline] (30.72 ms) : 0, 30720
AppSec [candidate] (30.624 ms) : 0, 30624
Debugger [baseline] (6.384 ms) : 0, 6384
Debugger [candidate] (6.383 ms) : 0, 6383
Remote Config [baseline] (696.444 µs) : 0, 696
Remote Config [candidate] (692.47 µs) : 0, 692
Telemetry [baseline] (15.599 ms) : 0, 15599
Telemetry [candidate] (16.272 ms) : 0, 16272
section appsec
crashtracking [baseline] (1.466 ms) : 0, 1466
crashtracking [candidate] (1.454 ms) : 0, 1454
BytebuddyAgent [baseline] (760.874 ms) : 0, 760874
BytebuddyAgent [candidate] (756.523 ms) : 0, 756523
GlobalTracer [baseline] (247.187 ms) : 0, 247187
GlobalTracer [candidate] (246.79 ms) : 0, 246790
AppSec [baseline] (171.0 ms) : 0, 171000
AppSec [candidate] (170.614 ms) : 0, 170614
Debugger [baseline] (6.823 ms) : 0, 6823
Debugger [candidate] (6.009 ms) : 0, 6009
Remote Config [baseline] (647.075 µs) : 0, 647
Remote Config [candidate] (635.853 µs) : 0, 636
Telemetry [baseline] (8.595 ms) : 0, 8595
Telemetry [candidate] (9.305 ms) : 0, 9305
IAST [baseline] (23.884 ms) : 0, 23884
IAST [candidate] (23.682 ms) : 0, 23682
section iast
crashtracking [baseline] (1.451 ms) : 0, 1451
crashtracking [candidate] (1.459 ms) : 0, 1459
BytebuddyAgent [baseline] (853.039 ms) : 0, 853039
BytebuddyAgent [candidate] (856.048 ms) : 0, 856048
GlobalTracer [baseline] (247.429 ms) : 0, 247429
GlobalTracer [candidate] (249.045 ms) : 0, 249045
AppSec [baseline] (25.26 ms) : 0, 25260
AppSec [candidate] (26.391 ms) : 0, 26391
Debugger [baseline] (6.06 ms) : 0, 6060
Debugger [candidate] (6.065 ms) : 0, 6065
Remote Config [baseline] (593.322 µs) : 0, 593
Remote Config [candidate] (597.212 µs) : 0, 597
Telemetry [baseline] (9.145 ms) : 0, 9145
Telemetry [candidate] (8.39 ms) : 0, 8390
IAST [baseline] (27.837 ms) : 0, 27837
IAST [candidate] (27.285 ms) : 0, 27285
section profiling
crashtracking [baseline] (1.456 ms) : 0, 1456
crashtracking [candidate] (1.448 ms) : 0, 1448
BytebuddyAgent [baseline] (768.571 ms) : 0, 768571
BytebuddyAgent [candidate] (765.839 ms) : 0, 765839
GlobalTracer [baseline] (234.846 ms) : 0, 234846
GlobalTracer [candidate] (234.513 ms) : 0, 234513
AppSec [baseline] (30.501 ms) : 0, 30501
AppSec [candidate] (30.333 ms) : 0, 30333
Debugger [baseline] (13.688 ms) : 0, 13688
Debugger [candidate] (13.941 ms) : 0, 13941
Remote Config [baseline] (734.704 µs) : 0, 735
Remote Config [candidate] (1.505 ms) : 0, 1505
Telemetry [baseline] (9.689 ms) : 0, 9689
Telemetry [candidate] (8.849 ms) : 0, 8849
ProfilingAgent [baseline] (111.233 ms) : 0, 111233
ProfilingAgent [candidate] (110.023 ms) : 0, 110023
Profiling [baseline] (111.888 ms) : 0, 111888
Profiling [candidate] (110.683 ms) : 0, 110683
Startup time reports for insecure-bankgantt
title insecure-bank - global startup overhead: candidate=1.54.0-SNAPSHOT~073d4015f7, baseline=1.54.0-SNAPSHOT~561eb5e7af
dateFormat X
axisFormat %s
section tracing
Agent [baseline] (1.066 s) : 0, 1065527
Total [baseline] (8.643 s) : 0, 8642750
Agent [candidate] (1.062 s) : 0, 1062019
Total [candidate] (8.593 s) : 0, 8592902
section iast
Agent [baseline] (1.202 s) : 0, 1201572
Total [baseline] (9.303 s) : 0, 9302817
Agent [candidate] (1.19 s) : 0, 1190378
Total [candidate] (9.305 s) : 0, 9305185
gantt
title insecure-bank - break down per module: candidate=1.54.0-SNAPSHOT~073d4015f7, baseline=1.54.0-SNAPSHOT~561eb5e7af
dateFormat X
axisFormat %s
section tracing
crashtracking [baseline] (1.464 ms) : 0, 1464
crashtracking [candidate] (1.455 ms) : 0, 1455
BytebuddyAgent [baseline] (735.294 ms) : 0, 735294
BytebuddyAgent [candidate] (732.993 ms) : 0, 732993
GlobalTracer [baseline] (253.516 ms) : 0, 253516
GlobalTracer [candidate] (252.696 ms) : 0, 252696
AppSec [baseline] (30.69 ms) : 0, 30690
AppSec [candidate] (30.638 ms) : 0, 30638
Debugger [baseline] (6.409 ms) : 0, 6409
Debugger [candidate] (6.366 ms) : 0, 6366
Remote Config [baseline] (695.73 µs) : 0, 696
Remote Config [candidate] (699.749 µs) : 0, 700
Telemetry [baseline] (16.446 ms) : 0, 16446
Telemetry [candidate] (16.157 ms) : 0, 16157
section iast
crashtracking [baseline] (1.47 ms) : 0, 1470
crashtracking [candidate] (1.456 ms) : 0, 1456
BytebuddyAgent [baseline] (861.05 ms) : 0, 861050
BytebuddyAgent [candidate] (852.1 ms) : 0, 852100
GlobalTracer [baseline] (247.699 ms) : 0, 247699
GlobalTracer [candidate] (245.479 ms) : 0, 245479
AppSec [baseline] (26.298 ms) : 0, 26298
AppSec [candidate] (26.02 ms) : 0, 26020
Debugger [baseline] (6.031 ms) : 0, 6031
Debugger [candidate] (6.034 ms) : 0, 6034
Remote Config [baseline] (600.063 µs) : 0, 600
Remote Config [candidate] (598.957 µs) : 0, 599
Telemetry [baseline] (8.358 ms) : 0, 8358
Telemetry [candidate] (8.302 ms) : 0, 8302
IAST [baseline] (28.971 ms) : 0, 28971
IAST [candidate] (29.494 ms) : 0, 29494
LoadParameters
See matching parameters
SummaryFound 1 performance improvements and 1 performance regressions! Performance is the same for 10 metrics, 12 unstable metrics.
Request duration reports for petclinicgantt
title petclinic - request duration [CI 0.99] : candidate=1.54.0-SNAPSHOT~073d4015f7, baseline=1.54.0-SNAPSHOT~561eb5e7af
dateFormat X
axisFormat %s
section baseline
no_agent (37.86 ms) : 37556, 38165
. : milestone, 37860,
appsec (47.709 ms) : 47294, 48125
. : milestone, 47709,
code_origins (45.829 ms) : 45423, 46235
. : milestone, 45829,
iast (45.639 ms) : 45255, 46022
. : milestone, 45639,
profiling (48.089 ms) : 47661, 48517
. : milestone, 48089,
tracing (43.495 ms) : 43138, 43852
. : milestone, 43495,
section candidate
no_agent (38.365 ms) : 38051, 38680
. : milestone, 38365,
appsec (50.227 ms) : 49780, 50673
. : milestone, 50227,
code_origins (46.773 ms) : 46370, 47176
. : milestone, 46773,
iast (45.611 ms) : 45206, 46016
. : milestone, 45611,
profiling (48.58 ms) : 48140, 49021
. : milestone, 48580,
tracing (44.27 ms) : 43896, 44644
. : milestone, 44270,
Request duration reports for insecure-bankgantt
title insecure-bank - request duration [CI 0.99] : candidate=1.54.0-SNAPSHOT~073d4015f7, baseline=1.54.0-SNAPSHOT~561eb5e7af
dateFormat X
axisFormat %s
section baseline
no_agent (4.487 ms) : 4435, 4540
. : milestone, 4487,
iast (9.853 ms) : 9687, 10019
. : milestone, 9853,
iast_FULL (13.899 ms) : 13625, 14173
. : milestone, 13899,
iast_GLOBAL (10.377 ms) : 10195, 10559
. : milestone, 10377,
profiling (9.398 ms) : 9252, 9545
. : milestone, 9398,
tracing (7.939 ms) : 7813, 8064
. : milestone, 7939,
section candidate
no_agent (4.235 ms) : 4189, 4282
. : milestone, 4235,
iast (9.618 ms) : 9455, 9782
. : milestone, 9618,
iast_FULL (14.234 ms) : 13953, 14514
. : milestone, 14234,
iast_GLOBAL (10.348 ms) : 10168, 10528
. : milestone, 10348,
profiling (9.074 ms) : 8928, 9220
. : milestone, 9074,
tracing (7.884 ms) : 7764, 8004
. : milestone, 7884,
DacapoParameters
See matching parameters
SummaryFound 1 performance improvements and 0 performance regressions! Performance is the same for 11 metrics, 0 unstable metrics.
Execution time for biojavagantt
title biojava - execution time [CI 0.99] : candidate=1.54.0-SNAPSHOT~073d4015f7, baseline=1.54.0-SNAPSHOT~561eb5e7af
dateFormat X
axisFormat %s
section baseline
no_agent (14.889 s) : 14889000, 14889000
. : milestone, 14889000,
appsec (14.997 s) : 14997000, 14997000
. : milestone, 14997000,
iast (18.299 s) : 18299000, 18299000
. : milestone, 18299000,
iast_GLOBAL (18.115 s) : 18115000, 18115000
. : milestone, 18115000,
profiling (15.786 s) : 15786000, 15786000
. : milestone, 15786000,
tracing (14.969 s) : 14969000, 14969000
. : milestone, 14969000,
section candidate
no_agent (14.98 s) : 14980000, 14980000
. : milestone, 14980000,
appsec (14.84 s) : 14840000, 14840000
. : milestone, 14840000,
iast (18.737 s) : 18737000, 18737000
. : milestone, 18737000,
iast_GLOBAL (18.084 s) : 18084000, 18084000
. : milestone, 18084000,
profiling (16.019 s) : 16019000, 16019000
. : milestone, 16019000,
tracing (14.84 s) : 14840000, 14840000
. : milestone, 14840000,
Execution time for tomcatgantt
title tomcat - execution time [CI 0.99] : candidate=1.54.0-SNAPSHOT~073d4015f7, baseline=1.54.0-SNAPSHOT~561eb5e7af
dateFormat X
axisFormat %s
section baseline
no_agent (1.478 ms) : 1466, 1489
. : milestone, 1478,
appsec (3.748 ms) : 3531, 3966
. : milestone, 3748,
iast (2.192 ms) : 2130, 2255
. : milestone, 2192,
iast_GLOBAL (2.245 ms) : 2182, 2308
. : milestone, 2245,
profiling (2.063 ms) : 2011, 2115
. : milestone, 2063,
tracing (2.022 ms) : 1972, 2071
. : milestone, 2022,
section candidate
no_agent (1.469 ms) : 1458, 1481
. : milestone, 1469,
appsec (2.449 ms) : 2399, 2499
. : milestone, 2449,
iast (2.19 ms) : 2128, 2252
. : milestone, 2190,
iast_GLOBAL (2.233 ms) : 2170, 2296
. : milestone, 2233,
profiling (2.072 ms) : 2020, 2125
. : milestone, 2072,
tracing (2.033 ms) : 1984, 2082
. : milestone, 2033,
|
bric3
left a comment
There was a problem hiding this comment.
LGTM, some suggestions though.
39b1bb3 to
7dea0c3
Compare
|
Thanks for the suggestions! Applied them all to make the doc even better 🤝 |
There was a problem hiding this comment.
| which configures the tests. | |
| which configure the tests. |
There was a problem hiding this comment.
| - As usual, class names should be nouns, in camel case with the first letter of each internal word capitalized. | |
| Use whole words-avoid acronyms and abbreviations (unless the abbreviation is much more widely used than the long form, | |
| such as URL or HTML). | |
| - As usual, class names should be nouns in camel case with the first letter of each internal word capitalized. | |
| Use whole words -- avoid acronyms and abbreviations (unless the abbreviation is much more widely used than the long form, | |
| such as with URLs or HTML). |
sarahchen6
left a comment
There was a problem hiding this comment.
Thanks for updating these docs! Left some nits, but feel free to ignore 😅
Co-authored-by: Sarah Chen <[email protected]> Co-authored-by: Brice Dutheil <[email protected]>
122b5c2 to
073d401
Compare
|
Thanks for the comments! I integrated them all and added both of you as co-authors 🤝 |
What Does This Do
Update the developer documentation with the latest instrumentation layout, the new instrumentation tests runner, and add a note about exception suppression on constructor.
Motivation
Keep the documentation up-to-date
Additional Notes
Contributor Checklist
type:and (comp:orinst:) labels in addition to any usefull labelsclose,fixor any linking keywords when referencing an issue.Use
solvesinstead, and assign the PR milestone to the issueJira ticket: [PROJ-IDENT]