Improve environment setup documentation#6942
Merged
PerfectSlayer merged 2 commits intomasterfrom Apr 29, 2024
Merged
Conversation
1510eeb to
26788e9
Compare
BenchmarksStartupParameters
See matching parameters
SummaryFound 0 performance improvements and 0 performance regressions! Performance is the same for 48 metrics, 15 unstable metrics. Startup time reports for petclinicgantt
title petclinic - global startup overhead: candidate=1.34.0-SNAPSHOT~1abb7833fd, baseline=1.34.0-SNAPSHOT~ae1c4c9475
dateFormat X
axisFormat %s
section tracing
Agent [baseline] (1.077 s) : 0, 1077146
Total [baseline] (10.456 s) : 0, 10456038
Agent [candidate] (1.09 s) : 0, 1090011
Total [candidate] (10.404 s) : 0, 10404330
section appsec
Agent [baseline] (1.193 s) : 0, 1192608
Total [baseline] (10.47 s) : 0, 10469919
Agent [candidate] (1.19 s) : 0, 1190396
Total [candidate] (10.468 s) : 0, 10468088
section iast
Agent [baseline] (1.199 s) : 0, 1199124
Total [baseline] (10.748 s) : 0, 10748092
Agent [candidate] (1.209 s) : 0, 1208731
Total [candidate] (10.796 s) : 0, 10796110
section profiling
Agent [baseline] (1.268 s) : 0, 1267846
Total [baseline] (10.647 s) : 0, 10646694
Agent [candidate] (1.269 s) : 0, 1268681
Total [candidate] (10.61 s) : 0, 10610006
gantt
title petclinic - break down per module: candidate=1.34.0-SNAPSHOT~1abb7833fd, baseline=1.34.0-SNAPSHOT~ae1c4c9475
dateFormat X
axisFormat %s
section tracing
BytebuddyAgent [baseline] (674.637 ms) : 0, 674637
BytebuddyAgent [candidate] (683.335 ms) : 0, 683335
GlobalTracer [baseline] (309.969 ms) : 0, 309969
GlobalTracer [candidate] (313.673 ms) : 0, 313673
AppSec [baseline] (49.827 ms) : 0, 49827
AppSec [candidate] (49.836 ms) : 0, 49836
Remote Config [baseline] (655.522 µs) : 0, 656
Remote Config [candidate] (675.632 µs) : 0, 676
Telemetry [baseline] (7.614 ms) : 0, 7614
Telemetry [candidate] (7.622 ms) : 0, 7622
section appsec
BytebuddyAgent [baseline] (698.222 ms) : 0, 698222
BytebuddyAgent [candidate] (695.8 ms) : 0, 695800
GlobalTracer [baseline] (292.538 ms) : 0, 292538
GlobalTracer [candidate] (291.928 ms) : 0, 291928
AppSec [baseline] (149.855 ms) : 0, 149855
AppSec [candidate] (149.405 ms) : 0, 149405
Remote Config [baseline] (624.72 µs) : 0, 625
Remote Config [candidate] (619.9 µs) : 0, 620
Telemetry [baseline] (7.22 ms) : 0, 7220
Telemetry [candidate] (8.505 ms) : 0, 8505
IAST [baseline] (19.265 ms) : 0, 19265
IAST [candidate] (19.334 ms) : 0, 19334
section iast
BytebuddyAgent [baseline] (794.844 ms) : 0, 794844
BytebuddyAgent [candidate] (800.852 ms) : 0, 800852
GlobalTracer [baseline] (287.715 ms) : 0, 287715
GlobalTracer [candidate] (290.148 ms) : 0, 290148
AppSec [baseline] (49.42 ms) : 0, 49420
AppSec [candidate] (49.825 ms) : 0, 49825
Remote Config [baseline] (572.025 µs) : 0, 572
Remote Config [candidate] (574.493 µs) : 0, 574
Telemetry [baseline] (8.098 ms) : 0, 8098
Telemetry [candidate] (8.138 ms) : 0, 8138
IAST [baseline] (24.154 ms) : 0, 24154
IAST [candidate] (24.537 ms) : 0, 24537
section profiling
ProfilingAgent [baseline] (95.36 ms) : 0, 95360
ProfilingAgent [candidate] (95.954 ms) : 0, 95954
BytebuddyAgent [baseline] (677.209 ms) : 0, 677209
BytebuddyAgent [candidate] (677.659 ms) : 0, 677659
GlobalTracer [baseline] (380.466 ms) : 0, 380466
GlobalTracer [candidate] (380.469 ms) : 0, 380469
AppSec [baseline] (50.22 ms) : 0, 50220
AppSec [candidate] (50.064 ms) : 0, 50064
Remote Config [baseline] (708.719 µs) : 0, 709
Remote Config [candidate] (713.241 µs) : 0, 713
Telemetry [baseline] (7.483 ms) : 0, 7483
Telemetry [candidate] (7.435 ms) : 0, 7435
Profiling [baseline] (95.384 ms) : 0, 95384
Profiling [candidate] (95.978 ms) : 0, 95978
Startup time reports for insecure-bankgantt
title insecure-bank - global startup overhead: candidate=1.34.0-SNAPSHOT~1abb7833fd, baseline=1.34.0-SNAPSHOT~ae1c4c9475
dateFormat X
axisFormat %s
section tracing
Agent [baseline] (1.075 s) : 0, 1075345
Total [baseline] (8.589 s) : 0, 8589409
Agent [candidate] (1.076 s) : 0, 1075718
Total [candidate] (8.597 s) : 0, 8597324
section iast
Agent [baseline] (1.2 s) : 0, 1199790
Total [baseline] (9.015 s) : 0, 9015404
Agent [candidate] (1.199 s) : 0, 1199202
Total [candidate] (9.043 s) : 0, 9042620
section iast_HARDCODED_SECRET_DISABLED
Agent [baseline] (1.202 s) : 0, 1201871
Total [baseline] (9.011 s) : 0, 9011241
Agent [candidate] (1.209 s) : 0, 1208544
Total [candidate] (9.01 s) : 0, 9009801
section iast_TELEMETRY_OFF
Agent [baseline] (1.196 s) : 0, 1196075
Total [baseline] (8.988 s) : 0, 8988383
Agent [candidate] (1.195 s) : 0, 1194615
Total [candidate] (9.0 s) : 0, 8999725
gantt
title insecure-bank - break down per module: candidate=1.34.0-SNAPSHOT~1abb7833fd, baseline=1.34.0-SNAPSHOT~ae1c4c9475
dateFormat X
axisFormat %s
section tracing
BytebuddyAgent [baseline] (673.235 ms) : 0, 673235
BytebuddyAgent [candidate] (674.274 ms) : 0, 674274
GlobalTracer [baseline] (309.881 ms) : 0, 309881
GlobalTracer [candidate] (309.708 ms) : 0, 309708
AppSec [baseline] (49.701 ms) : 0, 49701
AppSec [candidate] (49.215 ms) : 0, 49215
Remote Config [baseline] (654.02 µs) : 0, 654
Remote Config [candidate] (656.373 µs) : 0, 656
Telemetry [baseline] (7.543 ms) : 0, 7543
Telemetry [candidate] (7.501 ms) : 0, 7501
section iast
BytebuddyAgent [baseline] (795.584 ms) : 0, 795584
BytebuddyAgent [candidate] (794.473 ms) : 0, 794473
GlobalTracer [baseline] (288.168 ms) : 0, 288168
GlobalTracer [candidate] (288.099 ms) : 0, 288099
AppSec [baseline] (49.376 ms) : 0, 49376
AppSec [candidate] (50.192 ms) : 0, 50192
Remote Config [baseline] (567.357 µs) : 0, 567
Remote Config [candidate] (574.567 µs) : 0, 575
Telemetry [baseline] (6.618 ms) : 0, 6618
Telemetry [candidate] (7.35 ms) : 0, 7350
IAST [baseline] (25.061 ms) : 0, 25061
IAST [candidate] (24.054 ms) : 0, 24054
section iast_HARDCODED_SECRET_DISABLED
BytebuddyAgent [baseline] (795.09 ms) : 0, 795090
BytebuddyAgent [candidate] (800.82 ms) : 0, 800820
GlobalTracer [baseline] (290.027 ms) : 0, 290027
GlobalTracer [candidate] (290.282 ms) : 0, 290282
AppSec [baseline] (51.654 ms) : 0, 51654
AppSec [candidate] (50.517 ms) : 0, 50517
Remote Config [baseline] (588.499 µs) : 0, 588
Remote Config [candidate] (569.494 µs) : 0, 569
Telemetry [baseline] (6.65 ms) : 0, 6650
Telemetry [candidate] (6.616 ms) : 0, 6616
IAST [baseline] (23.453 ms) : 0, 23453
IAST [candidate] (25.117 ms) : 0, 25117
section iast_TELEMETRY_OFF
BytebuddyAgent [baseline] (792.688 ms) : 0, 792688
BytebuddyAgent [candidate] (791.017 ms) : 0, 791017
GlobalTracer [baseline] (288.441 ms) : 0, 288441
GlobalTracer [candidate] (287.682 ms) : 0, 287682
AppSec [baseline] (50.713 ms) : 0, 50713
AppSec [candidate] (50.809 ms) : 0, 50809
Remote Config [baseline] (591.335 µs) : 0, 591
Remote Config [candidate] (568.382 µs) : 0, 568
Telemetry [baseline] (6.628 ms) : 0, 6628
Telemetry [candidate] (7.269 ms) : 0, 7269
IAST [baseline] (22.661 ms) : 0, 22661
IAST [candidate] (22.73 ms) : 0, 22730
LoadParameters
See matching parameters
SummaryFound 0 performance improvements and 0 performance regressions! Performance is the same for 12 metrics, 16 unstable metrics. Request duration reports for insecure-bankgantt
title insecure-bank - request duration [CI 0.99] : candidate=1.34.0-SNAPSHOT~1abb7833fd, baseline=1.34.0-SNAPSHOT~ae1c4c9475
dateFormat X
axisFormat %s
section baseline
no_agent (368.251 µs) : 348, 388
. : milestone, 368,
iast (479.703 µs) : 458, 501
. : milestone, 480,
iast_FULL (546.605 µs) : 525, 568
. : milestone, 547,
iast_GLOBAL (514.843 µs) : 492, 537
. : milestone, 515,
iast_HARDCODED_SECRET_DISABLED (477.506 µs) : 457, 498
. : milestone, 478,
iast_INACTIVE (454.304 µs) : 434, 475
. : milestone, 454,
iast_TELEMETRY_OFF (476.868 µs) : 456, 498
. : milestone, 477,
tracing (449.894 µs) : 429, 471
. : milestone, 450,
section candidate
no_agent (379.878 µs) : 360, 400
. : milestone, 380,
iast (479.769 µs) : 459, 501
. : milestone, 480,
iast_FULL (546.66 µs) : 525, 568
. : milestone, 547,
iast_GLOBAL (501.834 µs) : 480, 524
. : milestone, 502,
iast_HARDCODED_SECRET_DISABLED (472.616 µs) : 451, 494
. : milestone, 473,
iast_INACTIVE (458.664 µs) : 437, 480
. : milestone, 459,
iast_TELEMETRY_OFF (474.258 µs) : 454, 495
. : milestone, 474,
tracing (448.731 µs) : 428, 470
. : milestone, 449,
Request duration reports for petclinicgantt
title petclinic - request duration [CI 0.99] : candidate=1.34.0-SNAPSHOT~1abb7833fd, baseline=1.34.0-SNAPSHOT~ae1c4c9475
dateFormat X
axisFormat %s
section baseline
no_agent (1.337 ms) : 1317, 1357
. : milestone, 1337,
appsec (1.724 ms) : 1699, 1748
. : milestone, 1724,
appsec_no_iast (1.73 ms) : 1706, 1755
. : milestone, 1730,
iast (1.502 ms) : 1479, 1525
. : milestone, 1502,
profiling (1.512 ms) : 1487, 1538
. : milestone, 1512,
tracing (1.493 ms) : 1469, 1517
. : milestone, 1493,
section candidate
no_agent (1.337 ms) : 1318, 1357
. : milestone, 1337,
appsec (1.747 ms) : 1723, 1771
. : milestone, 1747,
appsec_no_iast (1.734 ms) : 1711, 1758
. : milestone, 1734,
iast (1.5 ms) : 1477, 1523
. : milestone, 1500,
profiling (1.499 ms) : 1474, 1524
. : milestone, 1499,
tracing (1.486 ms) : 1462, 1509
. : milestone, 1486,
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 biojavagantt
title biojava - execution time [CI 0.99] : candidate=1.34.0-SNAPSHOT~1abb7833fd, baseline=1.34.0-SNAPSHOT~ae1c4c9475
dateFormat X
axisFormat %s
section baseline
no_agent (15.36 s) : 15360000, 15360000
. : milestone, 15360000,
appsec (15.221 s) : 15221000, 15221000
. : milestone, 15221000,
iast (18.74 s) : 18740000, 18740000
. : milestone, 18740000,
iast_GLOBAL (17.995 s) : 17995000, 17995000
. : milestone, 17995000,
profiling (15.549 s) : 15549000, 15549000
. : milestone, 15549000,
tracing (14.986 s) : 14986000, 14986000
. : milestone, 14986000,
section candidate
no_agent (15.66 s) : 15660000, 15660000
. : milestone, 15660000,
appsec (14.955 s) : 14955000, 14955000
. : milestone, 14955000,
iast (19.081 s) : 19081000, 19081000
. : milestone, 19081000,
iast_GLOBAL (18.033 s) : 18033000, 18033000
. : milestone, 18033000,
profiling (15.324 s) : 15324000, 15324000
. : milestone, 15324000,
tracing (14.953 s) : 14953000, 14953000
. : milestone, 14953000,
Execution time for tomcatgantt
title tomcat - execution time [CI 0.99] : candidate=1.34.0-SNAPSHOT~1abb7833fd, baseline=1.34.0-SNAPSHOT~ae1c4c9475
dateFormat X
axisFormat %s
section baseline
no_agent (1.459 ms) : 1448, 1470
. : milestone, 1459,
appsec (2.185 ms) : 2151, 2218
. : milestone, 2185,
iast (1.867 ms) : 1833, 1902
. : milestone, 1867,
iast_GLOBAL (1.913 ms) : 1878, 1948
. : milestone, 1913,
profiling (2.318 ms) : 2140, 2495
. : milestone, 2318,
tracing (1.824 ms) : 1792, 1856
. : milestone, 1824,
section candidate
no_agent (1.462 ms) : 1450, 1473
. : milestone, 1462,
appsec (2.203 ms) : 2169, 2237
. : milestone, 2203,
iast (1.865 ms) : 1830, 1899
. : milestone, 1865,
iast_GLOBAL (1.912 ms) : 1877, 1947
. : milestone, 1912,
profiling (1.847 ms) : 1813, 1881
. : milestone, 1847,
tracing (1.833 ms) : 1800, 1865
. : milestone, 1833,
|
26788e9 to
1f35ebc
Compare
1f35ebc to
1abb783
Compare
am312
approved these changes
Apr 29, 2024
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What Does This Do
This PR improves the documentation to get starting contributing to the project.
It updates and splits the original contributing guidelines into two documents:
It also introduces a script to quickly check its environment development.
Motivation
This should improve the onboarding experience for new contributors.
Additional Notes
This PR also introduces a new formatting setting for Markdown files to allow line-breaking sequence (two trailing spaces).
Jira ticket: [PROJ-IDENT]