Improve onboarding documentation #7020

PerfectSlayer · 2024-05-13T12:01:02Z

What Does This Do

This PR improves the project onboarding and documentation.

The README now has a list of documentation to improve discoverability,
The setup documentation now has MacOS, Linux and Windows guidelines,
The test document is introduced.

Motivation

This should improve the overall onboarding experience.

Additional Notes

The test document could include an how to write tests section but it will require some more time.
The next documentation should be about how to setup IntelliJ IDEA and how to troubleshoot build/gradle issues.

Jira ticket: [PROJ-IDENT]

pr-commenter · 2024-05-13T12:42:14Z

Benchmarks

Startup

Parameters

	Baseline	Candidate
baseline_or_candidate	baseline	candidate
git_branch	master	bbujon/documentation
git_commit_date	1715599092	1715601070
git_commit_sha	`ad042ce`	`2ae0255`
release_version	1.35.0-SNAPSHOT~ad042ce4a2	1.35.0-SNAPSHOT~2ae0255b14

See matching parameters

	Baseline	Candidate
application	insecure-bank	insecure-bank
ci_job_date	1715604426	1715604426
ci_job_id	509901296	509901296
ci_pipeline_id	34127489	34127489
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 49 metrics, 14 unstable metrics.

Startup time reports for petclinic

gantt
    title petclinic - global startup overhead: candidate=1.35.0-SNAPSHOT~2ae0255b14, baseline=1.35.0-SNAPSHOT~ad042ce4a2

    dateFormat X
    axisFormat %s
section tracing
Agent [baseline] (1.081 s) : 0, 1081390
Total [baseline] (10.423 s) : 0, 10423211
Agent [candidate] (1.111 s) : 0, 1111485
Total [candidate] (10.621 s) : 0, 10621000
section appsec
Agent [baseline] (1.198 s) : 0, 1197871
Total [baseline] (10.466 s) : 0, 10466035
Agent [candidate] (1.195 s) : 0, 1195203
Total [candidate] (10.492 s) : 0, 10492338
section iast
Agent [baseline] (1.202 s) : 0, 1202419
Total [baseline] (10.718 s) : 0, 10718180
Agent [candidate] (1.205 s) : 0, 1204578
Total [candidate] (10.739 s) : 0, 10739394
section profiling
Agent [baseline] (1.272 s) : 0, 1272009
Total [baseline] (10.577 s) : 0, 10577493
Agent [candidate] (1.278 s) : 0, 1278291
Total [candidate] (10.632 s) : 0, 10631970

baseline results

Module	Variant	Duration	Δ tracing
Agent	tracing	1.081 s	-
Agent	appsec	1.198 s	116.481 ms (10.8%)
Agent	iast	1.202 s	121.03 ms (11.2%)
Agent	profiling	1.272 s	190.62 ms (17.6%)
Total	tracing	10.423 s	-
Total	appsec	10.466 s	42.825 ms (0.4%)
Total	iast	10.718 s	294.97 ms (2.8%)
Total	profiling	10.577 s	154.283 ms (1.5%)

candidate results

Module	Variant	Duration	Δ tracing
Agent	tracing	1.111 s	-
Agent	appsec	1.195 s	83.718 ms (7.5%)
Agent	iast	1.205 s	93.093 ms (8.4%)
Agent	profiling	1.278 s	166.806 ms (15.0%)
Total	tracing	10.621 s	-
Total	appsec	10.492 s	-128.662 ms (-1.2%)
Total	iast	10.739 s	118.395 ms (1.1%)
Total	profiling	10.632 s	10.971 ms (0.1%)

gantt
    title petclinic - break down per module: candidate=1.35.0-SNAPSHOT~2ae0255b14, baseline=1.35.0-SNAPSHOT~ad042ce4a2

    dateFormat X
    axisFormat %s
section tracing
BytebuddyAgent [baseline] (675.913 ms) : 0, 675913
BytebuddyAgent [candidate] (695.214 ms) : 0, 695214
GlobalTracer [baseline] (312.736 ms) : 0, 312736
GlobalTracer [candidate] (321.46 ms) : 0, 321460
AppSec [baseline] (49.884 ms) : 0, 49884
AppSec [candidate] (50.863 ms) : 0, 50863
Remote Config [baseline] (673.045 µs) : 0, 673
Remote Config [candidate] (680.28 µs) : 0, 680
Telemetry [baseline] (7.651 ms) : 0, 7651
Telemetry [candidate] (7.8 ms) : 0, 7800
section appsec
BytebuddyAgent [baseline] (698.431 ms) : 0, 698431
BytebuddyAgent [candidate] (695.658 ms) : 0, 695658
GlobalTracer [baseline] (294.279 ms) : 0, 294279
GlobalTracer [candidate] (293.215 ms) : 0, 293215
AppSec [baseline] (152.575 ms) : 0, 152575
AppSec [candidate] (152.617 ms) : 0, 152617
Remote Config [baseline] (615.368 µs) : 0, 615
Remote Config [candidate] (619.336 µs) : 0, 619
Telemetry [baseline] (7.804 ms) : 0, 7804
Telemetry [candidate] (9.094 ms) : 0, 9094
IAST [baseline] (19.336 ms) : 0, 19336
IAST [candidate] (19.259 ms) : 0, 19259
section iast
BytebuddyAgent [baseline] (795.641 ms) : 0, 795641
BytebuddyAgent [candidate] (797.261 ms) : 0, 797261
GlobalTracer [baseline] (290.757 ms) : 0, 290757
GlobalTracer [candidate] (291.043 ms) : 0, 291043
AppSec [baseline] (51.404 ms) : 0, 51404
AppSec [candidate] (49.002 ms) : 0, 49002
Remote Config [baseline] (577.457 µs) : 0, 577
Remote Config [candidate] (582.773 µs) : 0, 583
Telemetry [baseline] (6.64 ms) : 0, 6640
Telemetry [candidate] (6.645 ms) : 0, 6645
IAST [baseline] (23.061 ms) : 0, 23061
IAST [candidate] (25.718 ms) : 0, 25718
section profiling
BytebuddyAgent [baseline] (679.574 ms) : 0, 679574
BytebuddyAgent [candidate] (684.434 ms) : 0, 684434
GlobalTracer [baseline] (381.899 ms) : 0, 381899
GlobalTracer [candidate] (382.369 ms) : 0, 382369
AppSec [baseline] (50.012 ms) : 0, 50012
AppSec [candidate] (50.395 ms) : 0, 50395
Remote Config [baseline] (748.655 µs) : 0, 749
Remote Config [candidate] (713.04 µs) : 0, 713
Telemetry [baseline] (7.472 ms) : 0, 7472
Telemetry [candidate] (7.546 ms) : 0, 7546
ProfilingAgent [baseline] (95.654 ms) : 0, 95654
ProfilingAgent [candidate] (95.857 ms) : 0, 95857
Profiling [baseline] (95.678 ms) : 0, 95678
Profiling [candidate] (95.882 ms) : 0, 95882

Startup time reports for insecure-bank

gantt
    title insecure-bank - global startup overhead: candidate=1.35.0-SNAPSHOT~2ae0255b14, baseline=1.35.0-SNAPSHOT~ad042ce4a2

    dateFormat X
    axisFormat %s
section tracing
Agent [baseline] (1.084 s) : 0, 1083640
Total [baseline] (8.541 s) : 0, 8541134
Agent [candidate] (1.087 s) : 0, 1087022
Total [candidate] (8.59 s) : 0, 8590067
section iast
Agent [baseline] (1.204 s) : 0, 1204138
Total [baseline] (9.022 s) : 0, 9021527
Agent [candidate] (1.205 s) : 0, 1205424
Total [candidate] (9.013 s) : 0, 9013325
section iast_HARDCODED_SECRET_DISABLED
Agent [baseline] (1.207 s) : 0, 1206697
Total [baseline] (8.996 s) : 0, 8996120
Agent [candidate] (1.205 s) : 0, 1205146
Total [candidate] (8.993 s) : 0, 8992974
section iast_TELEMETRY_OFF
Agent [baseline] (1.21 s) : 0, 1210341
Total [baseline] (9.006 s) : 0, 9005741
Agent [candidate] (1.204 s) : 0, 1204194
Total [candidate] (9.001 s) : 0, 9000547

baseline results

Module	Variant	Duration	Δ tracing
Agent	tracing	1.084 s	-
Agent	iast	1.204 s	120.498 ms (11.1%)
Agent	iast_HARDCODED_SECRET_DISABLED	1.207 s	123.058 ms (11.4%)
Agent	iast_TELEMETRY_OFF	1.21 s	126.701 ms (11.7%)
Total	tracing	8.541 s	-
Total	iast	9.022 s	480.393 ms (5.6%)
Total	iast_HARDCODED_SECRET_DISABLED	8.996 s	454.986 ms (5.3%)
Total	iast_TELEMETRY_OFF	9.006 s	464.607 ms (5.4%)

candidate results

Module	Variant	Duration	Δ tracing
Agent	tracing	1.087 s	-
Agent	iast	1.205 s	118.402 ms (10.9%)
Agent	iast_HARDCODED_SECRET_DISABLED	1.205 s	118.124 ms (10.9%)
Agent	iast_TELEMETRY_OFF	1.204 s	117.172 ms (10.8%)
Total	tracing	8.59 s	-
Total	iast	9.013 s	423.257 ms (4.9%)
Total	iast_HARDCODED_SECRET_DISABLED	8.993 s	402.906 ms (4.7%)
Total	iast_TELEMETRY_OFF	9.001 s	410.479 ms (4.8%)

gantt
    title insecure-bank - break down per module: candidate=1.35.0-SNAPSHOT~2ae0255b14, baseline=1.35.0-SNAPSHOT~ad042ce4a2

    dateFormat X
    axisFormat %s
section tracing
BytebuddyAgent [baseline] (678.816 ms) : 0, 678816
BytebuddyAgent [candidate] (680.172 ms) : 0, 680172
GlobalTracer [baseline] (312.522 ms) : 0, 312522
GlobalTracer [candidate] (313.803 ms) : 0, 313803
AppSec [baseline] (49.497 ms) : 0, 49497
AppSec [candidate] (49.965 ms) : 0, 49965
Remote Config [baseline] (653.58 µs) : 0, 654
Remote Config [candidate] (669.936 µs) : 0, 670
Telemetry [baseline] (7.469 ms) : 0, 7469
Telemetry [candidate] (7.672 ms) : 0, 7672
section iast
BytebuddyAgent [baseline] (797.938 ms) : 0, 797938
BytebuddyAgent [candidate] (797.909 ms) : 0, 797909
GlobalTracer [baseline] (290.5 ms) : 0, 290500
GlobalTracer [candidate] (290.926 ms) : 0, 290926
AppSec [baseline] (51.946 ms) : 0, 51946
AppSec [candidate] (49.403 ms) : 0, 49403
IAST [baseline] (22.306 ms) : 0, 22306
IAST [candidate] (25.653 ms) : 0, 25653
Remote Config [baseline] (568.003 µs) : 0, 568
Remote Config [candidate] (585.294 µs) : 0, 585
Telemetry [baseline] (6.58 ms) : 0, 6580
Telemetry [candidate] (6.601 ms) : 0, 6601
section iast_HARDCODED_SECRET_DISABLED
BytebuddyAgent [baseline] (798.662 ms) : 0, 798662
BytebuddyAgent [candidate] (797.339 ms) : 0, 797339
GlobalTracer [baseline] (291.475 ms) : 0, 291475
GlobalTracer [candidate] (291.494 ms) : 0, 291494
AppSec [baseline] (50.88 ms) : 0, 50880
AppSec [candidate] (53.138 ms) : 0, 53138
IAST [baseline] (23.163 ms) : 0, 23163
IAST [candidate] (21.588 ms) : 0, 21588
Remote Config [baseline] (590.536 µs) : 0, 591
Remote Config [candidate] (593.989 µs) : 0, 594
Telemetry [baseline] (7.378 ms) : 0, 7378
Telemetry [candidate] (6.633 ms) : 0, 6633
section iast_TELEMETRY_OFF
BytebuddyAgent [baseline] (800.884 ms) : 0, 800884
BytebuddyAgent [candidate] (795.269 ms) : 0, 795269
GlobalTracer [baseline] (293.367 ms) : 0, 293367
GlobalTracer [candidate] (292.449 ms) : 0, 292449
AppSec [baseline] (51.196 ms) : 0, 51196
AppSec [candidate] (50.15 ms) : 0, 50150
IAST [baseline] (23.085 ms) : 0, 23085
IAST [candidate] (24.576 ms) : 0, 24576
Remote Config [baseline] (600.947 µs) : 0, 601
Remote Config [candidate] (609.847 µs) : 0, 610
Telemetry [baseline] (6.545 ms) : 0, 6545
Telemetry [candidate] (6.557 ms) : 0, 6557

Load

Parameters

	Baseline	Candidate
baseline_or_candidate	baseline	candidate
end_time	2024-05-13T12:17:53	2024-05-13T12:24:42
git_branch	master	bbujon/documentation
git_commit_date	1715599092	1715601070
git_commit_sha	`ad042ce`	`2ae0255`
release_version	1.35.0-SNAPSHOT~ad042ce4a2	1.35.0-SNAPSHOT~2ae0255b14
start_time	2024-05-13T12:17:39	2024-05-13T12:24:28

See matching parameters

	Baseline	Candidate
application	insecure-bank	insecure-bank
ci_job_date	1715603426	1715603426
ci_job_id	509901297	509901297
ci_pipeline_id	34127489	34127489
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 11 metrics, 17 unstable metrics.

Request duration reports for insecure-bank

gantt
    title insecure-bank - request duration [CI 0.99] : candidate=1.35.0-SNAPSHOT~2ae0255b14, baseline=1.35.0-SNAPSHOT~ad042ce4a2
    dateFormat X
    axisFormat %s
section baseline
no_agent (365.644 µs) : 345, 386
.   : milestone, 366,
iast (474.371 µs) : 453, 495
.   : milestone, 474,
iast_FULL (549.321 µs) : 528, 571
.   : milestone, 549,
iast_GLOBAL (505.28 µs) : 484, 527
.   : milestone, 505,
iast_HARDCODED_SECRET_DISABLED (480.468 µs) : 459, 502
.   : milestone, 480,
iast_INACTIVE (455.809 µs) : 434, 477
.   : milestone, 456,
iast_TELEMETRY_OFF (469.832 µs) : 448, 491
.   : milestone, 470,
tracing (435.812 µs) : 416, 456
.   : milestone, 436,
section candidate
no_agent (376.298 µs) : 357, 396
.   : milestone, 376,
iast (481.99 µs) : 461, 503
.   : milestone, 482,
iast_FULL (543.569 µs) : 522, 565
.   : milestone, 544,
iast_GLOBAL (495.419 µs) : 474, 516
.   : milestone, 495,
iast_HARDCODED_SECRET_DISABLED (479.898 µs) : 459, 501
.   : milestone, 480,
iast_INACTIVE (451.406 µs) : 430, 472
.   : milestone, 451,
iast_TELEMETRY_OFF (462.674 µs) : 442, 483
.   : milestone, 463,
tracing (442.788 µs) : 422, 463
.   : milestone, 443,

baseline results

Variant	Request duration [CI 0.99]	Δ no_agent
no_agent	365.644 µs [345.424 µs, 385.865 µs]	-
iast	474.371 µs [453.338 µs, 495.403 µs]	108.726 µs (29.7%)
iast_FULL	549.321 µs [527.638 µs, 571.004 µs]	183.677 µs (50.2%)
iast_GLOBAL	505.28 µs [483.963 µs, 526.597 µs]	139.636 µs (38.2%)
iast_HARDCODED_SECRET_DISABLED	480.468 µs [459.075 µs, 501.862 µs]	114.824 µs (31.4%)
iast_INACTIVE	455.809 µs [434.265 µs, 477.353 µs]	90.165 µs (24.7%)
iast_TELEMETRY_OFF	469.832 µs [448.182 µs, 491.482 µs]	104.188 µs (28.5%)
tracing	435.812 µs [415.563 µs, 456.062 µs]	70.168 µs (19.2%)

candidate results

Variant	Request duration [CI 0.99]	Δ no_agent
no_agent	376.298 µs [356.652 µs, 395.943 µs]	-
iast	481.99 µs [460.732 µs, 503.249 µs]	105.692 µs (28.1%)
iast_FULL	543.569 µs [522.129 µs, 565.01 µs]	167.272 µs (44.5%)
iast_GLOBAL	495.419 µs [474.425 µs, 516.413 µs]	119.121 µs (31.7%)
iast_HARDCODED_SECRET_DISABLED	479.898 µs [458.516 µs, 501.281 µs]	103.601 µs (27.5%)
iast_INACTIVE	451.406 µs [430.485 µs, 472.327 µs]	75.108 µs (20.0%)
iast_TELEMETRY_OFF	462.674 µs [442.01 µs, 483.338 µs]	86.376 µs (23.0%)
tracing	442.788 µs [422.422 µs, 463.155 µs]	66.49 µs (17.7%)

Request duration reports for petclinic

gantt
    title petclinic - request duration [CI 0.99] : candidate=1.35.0-SNAPSHOT~2ae0255b14, baseline=1.35.0-SNAPSHOT~ad042ce4a2
    dateFormat X
    axisFormat %s
section baseline
no_agent (1.352 ms) : 1333, 1372
.   : milestone, 1352,
appsec (1.711 ms) : 1687, 1736
.   : milestone, 1711,
appsec_no_iast (1.727 ms) : 1704, 1751
.   : milestone, 1727,
iast (1.451 ms) : 1429, 1474
.   : milestone, 1451,
profiling (1.511 ms) : 1485, 1536
.   : milestone, 1511,
tracing (1.469 ms) : 1445, 1493
.   : milestone, 1469,
section candidate
no_agent (1.338 ms) : 1319, 1357
.   : milestone, 1338,
appsec (1.727 ms) : 1704, 1751
.   : milestone, 1727,
appsec_no_iast (1.709 ms) : 1684, 1734
.   : milestone, 1709,
iast (1.487 ms) : 1464, 1509
.   : milestone, 1487,
profiling (1.521 ms) : 1495, 1547
.   : milestone, 1521,
tracing (1.449 ms) : 1424, 1474
.   : milestone, 1449,

baseline results

Variant	Request duration [CI 0.99]	Δ no_agent
no_agent	1.352 ms [1.333 ms, 1.372 ms]	-
appsec	1.711 ms [1.687 ms, 1.736 ms]	358.933 µs (26.5%)
appsec_no_iast	1.727 ms [1.704 ms, 1.751 ms]	374.991 µs (27.7%)
iast	1.451 ms [1.429 ms, 1.474 ms]	99.276 µs (7.3%)
profiling	1.511 ms [1.485 ms, 1.536 ms]	158.579 µs (11.7%)
tracing	1.469 ms [1.445 ms, 1.493 ms]	117.075 µs (8.7%)

candidate results

Variant	Request duration [CI 0.99]	Δ no_agent
no_agent	1.338 ms [1.319 ms, 1.357 ms]	-
appsec	1.727 ms [1.704 ms, 1.751 ms]	389.101 µs (29.1%)
appsec_no_iast	1.709 ms [1.684 ms, 1.734 ms]	370.769 µs (27.7%)
iast	1.487 ms [1.464 ms, 1.509 ms]	148.487 µs (11.1%)
profiling	1.521 ms [1.495 ms, 1.547 ms]	183.022 µs (13.7%)
tracing	1.449 ms [1.424 ms, 1.474 ms]	110.995 µs (8.3%)

Dacapo

Parameters

	Baseline	Candidate
baseline_or_candidate	baseline	candidate
git_branch	master	bbujon/documentation
git_commit_date	1715599092	1715601070
git_commit_sha	`ad042ce`	`2ae0255`
release_version	1.35.0-SNAPSHOT~ad042ce4a2	1.35.0-SNAPSHOT~2ae0255b14

See matching parameters

	Baseline	Candidate
application	biojava	biojava
ci_job_date	1715603955	1715603955
ci_job_id	509901298	509901298
ci_pipeline_id	34127489	34127489
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.35.0-SNAPSHOT~2ae0255b14, baseline=1.35.0-SNAPSHOT~ad042ce4a2
    dateFormat X
    axisFormat %s
section baseline
no_agent (14.957 s) : 14957000, 14957000
.   : milestone, 14957000,
appsec (15.229 s) : 15229000, 15229000
.   : milestone, 15229000,
iast (18.775 s) : 18775000, 18775000
.   : milestone, 18775000,
iast_GLOBAL (17.879 s) : 17879000, 17879000
.   : milestone, 17879000,
profiling (14.999 s) : 14999000, 14999000
.   : milestone, 14999000,
tracing (14.783 s) : 14783000, 14783000
.   : milestone, 14783000,
section candidate
no_agent (15.425 s) : 15425000, 15425000
.   : milestone, 15425000,
appsec (15.132 s) : 15132000, 15132000
.   : milestone, 15132000,
iast (18.669 s) : 18669000, 18669000
.   : milestone, 18669000,
iast_GLOBAL (17.887 s) : 17887000, 17887000
.   : milestone, 17887000,
profiling (14.978 s) : 14978000, 14978000
.   : milestone, 14978000,
tracing (14.822 s) : 14822000, 14822000
.   : milestone, 14822000,

baseline results

Variant	Execution Time [CI 0.99]	Δ no_agent
no_agent	14.957 s [14.957 s, 14.957 s]	-
appsec	15.229 s [15.229 s, 15.229 s]	272.0 ms (1.8%)
iast	18.775 s [18.775 s, 18.775 s]	3.818 s (25.5%)
iast_GLOBAL	17.879 s [17.879 s, 17.879 s]	2.922 s (19.5%)
profiling	14.999 s [14.999 s, 14.999 s]	42.0 ms (0.3%)
tracing	14.783 s [14.783 s, 14.783 s]	-174.0 ms (-1.2%)

candidate results

Variant	Execution Time [CI 0.99]	Δ no_agent
no_agent	15.425 s [15.425 s, 15.425 s]	-
appsec	15.132 s [15.132 s, 15.132 s]	-293.0 ms (-1.9%)
iast	18.669 s [18.669 s, 18.669 s]	3.244 s (21.0%)
iast_GLOBAL	17.887 s [17.887 s, 17.887 s]	2.462 s (16.0%)
profiling	14.978 s [14.978 s, 14.978 s]	-447.0 ms (-2.9%)
tracing	14.822 s [14.822 s, 14.822 s]	-603.0 ms (-3.9%)

Execution time for tomcat

gantt
    title tomcat - execution time [CI 0.99] : candidate=1.35.0-SNAPSHOT~2ae0255b14, baseline=1.35.0-SNAPSHOT~ad042ce4a2
    dateFormat X
    axisFormat %s
section baseline
no_agent (1.463 ms) : 1451, 1474
.   : milestone, 1463,
appsec (2.215 ms) : 2180, 2250
.   : milestone, 2215,
iast (1.965 ms) : 1923, 2006
.   : milestone, 1965,
iast_GLOBAL (1.994 ms) : 1953, 2035
.   : milestone, 1994,
profiling (1.848 ms) : 1815, 1881
.   : milestone, 1848,
tracing (1.84 ms) : 1807, 1872
.   : milestone, 1840,
section candidate
no_agent (1.457 ms) : 1446, 1468
.   : milestone, 1457,
appsec (2.209 ms) : 2174, 2244
.   : milestone, 2209,
iast (1.965 ms) : 1923, 2006
.   : milestone, 1965,
iast_GLOBAL (2.005 ms) : 1964, 2046
.   : milestone, 2005,
profiling (1.856 ms) : 1821, 1890
.   : milestone, 1856,
tracing (1.835 ms) : 1803, 1868
.   : milestone, 1835,

baseline results

Variant	Execution Time [CI 0.99]	Δ no_agent
no_agent	1.463 ms [1.451 ms, 1.474 ms]	-
appsec	2.215 ms [2.18 ms, 2.25 ms]	752.321 µs (51.4%)
iast	1.965 ms [1.923 ms, 2.006 ms]	501.863 µs (34.3%)
iast_GLOBAL	1.994 ms [1.953 ms, 2.035 ms]	530.814 µs (36.3%)
profiling	1.848 ms [1.815 ms, 1.881 ms]	385.103 µs (26.3%)
tracing	1.84 ms [1.807 ms, 1.872 ms]	376.694 µs (25.8%)

candidate results

Variant	Execution Time [CI 0.99]	Δ no_agent
no_agent	1.457 ms [1.446 ms, 1.468 ms]	-
appsec	2.209 ms [2.174 ms, 2.244 ms]	751.73 µs (51.6%)
iast	1.965 ms [1.923 ms, 2.006 ms]	507.576 µs (34.8%)
iast_GLOBAL	2.005 ms [1.964 ms, 2.046 ms]	547.797 µs (37.6%)
profiling	1.856 ms [1.821 ms, 1.89 ms]	398.775 µs (27.4%)
tracing	1.835 ms [1.803 ms, 1.868 ms]	378.494 µs (26.0%)

smola · 2024-05-14T06:48:42Z

setup.sh

@@ -105,7 +95,23 @@ function check-docker-server() {
    fi
 }

-echo "ℹ️  Checking shell configuration:"
-check-ulimit 1024
+echo "ℹ️  Checking Docker environment:"


Just a minor nitpick: these info headers have a two-space indent, while the nested items have one-space indent. So the nesting looks backwards. It should probably be 1 space for the info headers, and 2 spaces for each item.

I set two spaces as my shell failed to properly render the ℹ️ (it is swallowing the first space and I don’t know why 🤷 ).
I removed it but I am curious to know how it renders on your side if you could run it?

smola · 2024-05-14T06:51:40Z

BUILDING.md

+
+**On Linux:**
+
+* Download and extract JDK 8, 11, 17 and 21 from [Eclipse Temurin releases](https://adoptium.net/temurin/releases/) and GraalVM from [Oracle downloads](https://www.graalvm.org/downloads/),


We could add the instructions with https://sdkman.io/ just like we do with homebrew for macOS? Anyone using a different install method probably can still figure out how to use different paths.

I did not include it because it was not part of the original setup guide in confluence and it’s harder to use as you would need to list the Java version first, then install this specific version (you can’t just use an alias like 17-zulu for example).

SDK Man applies to all of the OS, so I might need to make a specific section for it.
But I would need to split it also when talking about the env vars... Not sure of the right way of documenting it without encumbering the document 🤷

But it’s the tool I use and the one I found the most convenient to deal with (especially the sdk use command).
We might also assume that people that already installed it themselves will know how to proceed with sdk instead?

BUILDING.md

docs/how_to_test.md

mcculls

Great work!

feat(doc): Remove ulimit check

f49cc11

PerfectSlayer added type: documentation tag: no release notes Changes to exclude from release notes labels May 13, 2024

PerfectSlayer requested a review from a team as a code owner May 13, 2024 12:01

PerfectSlayer requested review from mcculls and ygree May 13, 2024 12:01

smola reviewed May 14, 2024

View reviewed changes

PerfectSlayer force-pushed the bbujon/documentation branch from 2ae0255 to 1b56f9f Compare May 14, 2024 09:19

PerfectSlayer added 2 commits May 14, 2024 11:26

feat(doc): Improve building guide

10ae0e6

feat(doc): Add tests guide

77e44e4

PerfectSlayer force-pushed the bbujon/documentation branch from 1b56f9f to 77e44e4 Compare May 14, 2024 09:26

PerfectSlayer added 2 commits May 14, 2024 17:12

feat(doc): Add more tests documentation

153816f

fix: Remove extra spacing before info

be63a0b

mcculls approved these changes May 20, 2024

View reviewed changes

PerfectSlayer merged commit 79c19b1 into master May 21, 2024
76 of 79 checks passed

PerfectSlayer deleted the bbujon/documentation branch May 21, 2024 09:05

github-actions bot added this to the 1.35.0 milestone May 21, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improve onboarding documentation #7020

Improve onboarding documentation #7020

PerfectSlayer commented May 13, 2024 •

edited

pr-commenter bot commented May 13, 2024 •

edited

smola May 14, 2024

PerfectSlayer May 14, 2024

smola May 14, 2024

PerfectSlayer May 14, 2024

mcculls left a comment


		On Linux:

		* Download and extract JDK 8, 11, 17 and 21 from [Eclipse Temurin releases](https://adoptium.net/temurin/releases/) and GraalVM from [Oracle downloads](https://www.graalvm.org/downloads/),

Improve onboarding documentation #7020

Improve onboarding documentation #7020

Conversation

PerfectSlayer commented May 13, 2024 • edited

What Does This Do

Motivation

Additional Notes

pr-commenter bot commented May 13, 2024 • edited

Benchmarks

Startup

Parameters

Summary

Load

Parameters

Summary

Dacapo

Parameters

Summary

smola May 14, 2024

Choose a reason for hiding this comment

PerfectSlayer May 14, 2024

Choose a reason for hiding this comment

smola May 14, 2024

Choose a reason for hiding this comment

PerfectSlayer May 14, 2024

Choose a reason for hiding this comment

mcculls left a comment

Choose a reason for hiding this comment

PerfectSlayer commented May 13, 2024 •

edited

pr-commenter bot commented May 13, 2024 •

edited