-
Notifications
You must be signed in to change notification settings - Fork 314
Add bootstrap development guidelines #9821
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.
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
base: master
Are you sure you want to change the base?
Conversation
Hi! 👋 Thanks for your pull request! 🎉 To help us review it, please make sure to:
If you need help, please check our contributing guidelines. |
🎯 Code Coverage 🔗 Commit SHA: 487b8dd | Docs | Was this helpful? Give us feedback! |
BenchmarksStartupParameters
See matching parameters
SummaryFound 0 performance improvements and 0 performance regressions! Performance is the same for 51 metrics, 14 unstable metrics. Startup time reports for insecure-bankgantt
title insecure-bank - global startup overhead: candidate=1.55.0-SNAPSHOT~487b8ddca4, baseline=1.55.0-SNAPSHOT~f42a6e9909
dateFormat X
axisFormat %s
section tracing
Agent [baseline] (1.028 s) : 0, 1028237
Total [baseline] (8.675 s) : 0, 8674804
Agent [candidate] (1.027 s) : 0, 1027176
Total [candidate] (8.685 s) : 0, 8684579
section iast
Agent [baseline] (1.176 s) : 0, 1176447
Total [baseline] (9.444 s) : 0, 9444359
Agent [candidate] (1.15 s) : 0, 1149752
Total [candidate] (9.271 s) : 0, 9271164
gantt
title insecure-bank - break down per module: candidate=1.55.0-SNAPSHOT~487b8ddca4, baseline=1.55.0-SNAPSHOT~f42a6e9909
dateFormat X
axisFormat %s
section tracing
crashtracking [baseline] (1.463 ms) : 0, 1463
crashtracking [candidate] (1.466 ms) : 0, 1466
BytebuddyAgent [baseline] (701.065 ms) : 0, 701065
BytebuddyAgent [candidate] (699.729 ms) : 0, 699729
GlobalTracer [baseline] (244.369 ms) : 0, 244369
GlobalTracer [candidate] (244.826 ms) : 0, 244826
AppSec [baseline] (32.181 ms) : 0, 32181
AppSec [candidate] (32.488 ms) : 0, 32488
Debugger [baseline] (6.364 ms) : 0, 6364
Debugger [candidate] (6.41 ms) : 0, 6410
Remote Config [baseline] (677.459 µs) : 0, 677
Remote Config [candidate] (685.341 µs) : 0, 685
Telemetry [baseline] (14.501 ms) : 0, 14501
Telemetry [candidate] (9.298 ms) : 0, 9298
Flare Poller [baseline] (6.379 ms) : 0, 6379
Flare Poller [candidate] (10.963 ms) : 0, 10963
section iast
crashtracking [baseline] (1.476 ms) : 0, 1476
crashtracking [candidate] (1.474 ms) : 0, 1474
BytebuddyAgent [baseline] (835.206 ms) : 0, 835206
BytebuddyAgent [candidate] (813.764 ms) : 0, 813764
GlobalTracer [baseline] (236.365 ms) : 0, 236365
GlobalTracer [candidate] (231.363 ms) : 0, 231363
AppSec [baseline] (28.409 ms) : 0, 28409
AppSec [candidate] (35.161 ms) : 0, 35161
Debugger [baseline] (6.158 ms) : 0, 6158
Debugger [candidate] (6.201 ms) : 0, 6201
Remote Config [baseline] (614.053 µs) : 0, 614
Remote Config [candidate] (595.687 µs) : 0, 596
Telemetry [baseline] (8.57 ms) : 0, 8570
Telemetry [candidate] (8.706 ms) : 0, 8706
Flare Poller [baseline] (4.157 ms) : 0, 4157
Flare Poller [candidate] (4.293 ms) : 0, 4293
IAST [baseline] (33.805 ms) : 0, 33805
IAST [candidate] (26.714 ms) : 0, 26714
Startup time reports for petclinicgantt
title petclinic - global startup overhead: candidate=1.55.0-SNAPSHOT~487b8ddca4, baseline=1.55.0-SNAPSHOT~f42a6e9909
dateFormat X
axisFormat %s
section tracing
Agent [baseline] (1.028 s) : 0, 1027919
Total [baseline] (10.801 s) : 0, 10801385
Agent [candidate] (1.018 s) : 0, 1018118
Total [candidate] (10.759 s) : 0, 10758593
section appsec
Agent [baseline] (1.205 s) : 0, 1205468
Total [baseline] (11.013 s) : 0, 11012595
Agent [candidate] (1.198 s) : 0, 1198292
Total [candidate] (10.937 s) : 0, 10936792
section iast
Agent [baseline] (1.159 s) : 0, 1159219
Total [baseline] (11.111 s) : 0, 11111160
Agent [candidate] (1.158 s) : 0, 1157794
Total [candidate] (11.078 s) : 0, 11078228
section profiling
Agent [baseline] (1.172 s) : 0, 1171963
Total [baseline] (10.914 s) : 0, 10913593
Agent [candidate] (1.168 s) : 0, 1167716
Total [candidate] (10.887 s) : 0, 10886887
gantt
title petclinic - break down per module: candidate=1.55.0-SNAPSHOT~487b8ddca4, baseline=1.55.0-SNAPSHOT~f42a6e9909
dateFormat X
axisFormat %s
section tracing
crashtracking [baseline] (1.459 ms) : 0, 1459
crashtracking [candidate] (1.458 ms) : 0, 1458
BytebuddyAgent [baseline] (701.257 ms) : 0, 701257
BytebuddyAgent [candidate] (692.909 ms) : 0, 692909
GlobalTracer [baseline] (244.498 ms) : 0, 244498
GlobalTracer [candidate] (243.241 ms) : 0, 243241
AppSec [baseline] (32.037 ms) : 0, 32037
AppSec [candidate] (32.194 ms) : 0, 32194
Debugger [baseline] (6.321 ms) : 0, 6321
Debugger [candidate] (6.28 ms) : 0, 6280
Remote Config [baseline] (686.408 µs) : 0, 686
Remote Config [candidate] (680.183 µs) : 0, 680
Telemetry [baseline] (14.893 ms) : 0, 14893
Telemetry [candidate] (9.331 ms) : 0, 9331
Flare Poller [baseline] (5.648 ms) : 0, 5648
Flare Poller [candidate] (10.846 ms) : 0, 10846
section appsec
crashtracking [baseline] (1.471 ms) : 0, 1471
crashtracking [candidate] (1.454 ms) : 0, 1454
BytebuddyAgent [baseline] (727.182 ms) : 0, 727182
BytebuddyAgent [candidate] (720.829 ms) : 0, 720829
GlobalTracer [baseline] (236.831 ms) : 0, 236831
GlobalTracer [candidate] (235.286 ms) : 0, 235286
AppSec [baseline] (174.786 ms) : 0, 174786
AppSec [candidate] (174.537 ms) : 0, 174537
Debugger [baseline] (5.925 ms) : 0, 5925
Debugger [candidate] (6.112 ms) : 0, 6112
Remote Config [baseline] (622.426 µs) : 0, 622
Remote Config [candidate] (643.238 µs) : 0, 643
Telemetry [baseline] (8.47 ms) : 0, 8470
Telemetry [candidate] (9.313 ms) : 0, 9313
Flare Poller [baseline] (3.931 ms) : 0, 3931
Flare Poller [candidate] (3.904 ms) : 0, 3904
IAST [baseline] (25.088 ms) : 0, 25088
IAST [candidate] (24.929 ms) : 0, 24929
section iast
crashtracking [baseline] (1.457 ms) : 0, 1457
crashtracking [candidate] (1.459 ms) : 0, 1459
BytebuddyAgent [baseline] (822.002 ms) : 0, 822002
BytebuddyAgent [candidate] (819.75 ms) : 0, 819750
GlobalTracer [baseline] (233.663 ms) : 0, 233663
GlobalTracer [candidate] (232.934 ms) : 0, 232934
AppSec [baseline] (30.621 ms) : 0, 30621
AppSec [candidate] (35.362 ms) : 0, 35362
Debugger [baseline] (6.142 ms) : 0, 6142
Debugger [candidate] (6.186 ms) : 0, 6186
Remote Config [baseline] (593.261 µs) : 0, 593
Remote Config [candidate] (613.424 µs) : 0, 613
Telemetry [baseline] (8.412 ms) : 0, 8412
Telemetry [candidate] (8.787 ms) : 0, 8787
Flare Poller [baseline] (4.179 ms) : 0, 4179
Flare Poller [candidate] (4.258 ms) : 0, 4258
IAST [baseline] (30.827 ms) : 0, 30827
IAST [candidate] (26.842 ms) : 0, 26842
section profiling
crashtracking [baseline] (1.453 ms) : 0, 1453
crashtracking [candidate] (1.455 ms) : 0, 1455
BytebuddyAgent [baseline] (725.739 ms) : 0, 725739
BytebuddyAgent [candidate] (723.157 ms) : 0, 723157
GlobalTracer [baseline] (220.308 ms) : 0, 220308
GlobalTracer [candidate] (219.691 ms) : 0, 219691
AppSec [baseline] (32.206 ms) : 0, 32206
AppSec [candidate] (32.373 ms) : 0, 32373
Debugger [baseline] (13.884 ms) : 0, 13884
Debugger [candidate] (6.636 ms) : 0, 6636
Remote Config [baseline] (1.473 ms) : 0, 1473
Remote Config [candidate] (694.492 µs) : 0, 694
Telemetry [baseline] (8.218 ms) : 0, 8218
Telemetry [candidate] (15.231 ms) : 0, 15231
Flare Poller [baseline] (4.09 ms) : 0, 4090
Flare Poller [candidate] (4.988 ms) : 0, 4988
ProfilingAgent [baseline] (109.247 ms) : 0, 109247
ProfilingAgent [candidate] (109.735 ms) : 0, 109735
Profiling [baseline] (109.862 ms) : 0, 109862
Profiling [candidate] (110.387 ms) : 0, 110387
LoadParameters
See matching parameters
SummaryFound 4 performance improvements and 1 performance regressions! Performance is the same for 7 metrics, 12 unstable metrics.
Request duration reports for petclinicgantt
title petclinic - request duration [CI 0.99] : candidate=1.55.0-SNAPSHOT~487b8ddca4, baseline=1.55.0-SNAPSHOT~f42a6e9909
dateFormat X
axisFormat %s
section baseline
no_agent (36.999 ms) : 36702, 37295
. : milestone, 36999,
appsec (47.286 ms) : 46864, 47707
. : milestone, 47286,
code_origins (45.172 ms) : 44768, 45575
. : milestone, 45172,
iast (43.766 ms) : 43387, 44144
. : milestone, 43766,
profiling (48.908 ms) : 48452, 49364
. : milestone, 48908,
tracing (44.97 ms) : 44574, 45366
. : milestone, 44970,
section candidate
no_agent (37.314 ms) : 37014, 37613
. : milestone, 37314,
appsec (48.2 ms) : 47765, 48636
. : milestone, 48200,
code_origins (43.097 ms) : 42709, 43485
. : milestone, 43097,
iast (45.317 ms) : 44936, 45699
. : milestone, 45317,
profiling (46.744 ms) : 46333, 47155
. : milestone, 46744,
tracing (43.449 ms) : 43082, 43816
. : milestone, 43449,
Request duration reports for insecure-bankgantt
title insecure-bank - request duration [CI 0.99] : candidate=1.55.0-SNAPSHOT~487b8ddca4, baseline=1.55.0-SNAPSHOT~f42a6e9909
dateFormat X
axisFormat %s
section baseline
no_agent (4.327 ms) : 4274, 4381
. : milestone, 4327,
iast (9.282 ms) : 9119, 9445
. : milestone, 9282,
iast_FULL (14.756 ms) : 14458, 15054
. : milestone, 14756,
iast_GLOBAL (11.022 ms) : 10820, 11223
. : milestone, 11022,
profiling (9.116 ms) : 8967, 9264
. : milestone, 9116,
tracing (7.768 ms) : 7657, 7880
. : milestone, 7768,
section candidate
no_agent (4.253 ms) : 4203, 4304
. : milestone, 4253,
iast (9.591 ms) : 9427, 9754
. : milestone, 9591,
iast_FULL (13.877 ms) : 13600, 14154
. : milestone, 13877,
iast_GLOBAL (11.286 ms) : 11079, 11494
. : milestone, 11286,
profiling (9.113 ms) : 8968, 9259
. : milestone, 9113,
tracing (7.945 ms) : 7832, 8058
. : milestone, 7945,
DacapoParameters
See matching parameters
SummaryFound 0 performance improvements and 0 performance regressions! Performance is the same for 11 metrics, 1 unstable metrics. Execution time for tomcatgantt
title tomcat - execution time [CI 0.99] : candidate=1.55.0-SNAPSHOT~487b8ddca4, baseline=1.55.0-SNAPSHOT~f42a6e9909
dateFormat X
axisFormat %s
section baseline
no_agent (1.469 ms) : 1457, 1480
. : milestone, 1469,
appsec (2.455 ms) : 2403, 2506
. : milestone, 2455,
iast (2.209 ms) : 2144, 2273
. : milestone, 2209,
iast_GLOBAL (2.251 ms) : 2186, 2315
. : milestone, 2251,
profiling (2.053 ms) : 2002, 2105
. : milestone, 2053,
tracing (2.016 ms) : 1966, 2067
. : milestone, 2016,
section candidate
no_agent (1.476 ms) : 1464, 1488
. : milestone, 1476,
appsec (3.714 ms) : 3497, 3930
. : milestone, 3714,
iast (2.202 ms) : 2138, 2266
. : milestone, 2202,
iast_GLOBAL (2.245 ms) : 2181, 2309
. : milestone, 2245,
profiling (2.066 ms) : 2013, 2119
. : milestone, 2066,
tracing (2.027 ms) : 1977, 2076
. : milestone, 2027,
Execution time for biojavagantt
title biojava - execution time [CI 0.99] : candidate=1.55.0-SNAPSHOT~487b8ddca4, baseline=1.55.0-SNAPSHOT~f42a6e9909
dateFormat X
axisFormat %s
section baseline
no_agent (15.511 s) : 15511000, 15511000
. : milestone, 15511000,
appsec (14.901 s) : 14901000, 14901000
. : milestone, 14901000,
iast (18.472 s) : 18472000, 18472000
. : milestone, 18472000,
iast_GLOBAL (18.083 s) : 18083000, 18083000
. : milestone, 18083000,
profiling (15.875 s) : 15875000, 15875000
. : milestone, 15875000,
tracing (15.251 s) : 15251000, 15251000
. : milestone, 15251000,
section candidate
no_agent (14.818 s) : 14818000, 14818000
. : milestone, 14818000,
appsec (14.879 s) : 14879000, 14879000
. : milestone, 14879000,
iast (18.582 s) : 18582000, 18582000
. : milestone, 18582000,
iast_GLOBAL (18.109 s) : 18109000, 18109000
. : milestone, 18109000,
profiling (15.575 s) : 15575000, 15575000
. : milestone, 15575000,
tracing (15.083 s) : 15083000, 15083000
. : milestone, 15083000,
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM (from someone who doesn't know the details about bootstrap and premain). All of the context is really helpful!
f945dbd
to
487b8dd
Compare
Thanks for the review and feedback 🙏 |
What Does This Do
This PR adds documentation about pitfalls and guideline implementation the agent bootstrap.
It also includes an addition about logging guidelines for instrumentations.
Motivation
The goal is to capture the knowledge so it would make it easier for contributors to avoid common pitfalls that might not be caught by testing.
Additional Notes
Refers to the discussions from both internal Slack channel and #9780
cc @mcculls who's the most knowledgeable about this part.
I would like to make sure I get it right. Feel free to edit the PR or add comment for me to amend the doc 🙏
Contributor Checklist
type:
and (comp:
orinst:
) labels in addition to any useful labelsclose
,fix
or any linking keywords when referencing an issue.Use
solves
instead, and assign the PR milestone to the issueJira ticket: [PROJ-IDENT]