-
Notifications
You must be signed in to change notification settings - Fork 293
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
[docs] improve setup of dev env on Windows #8180
base: master
Are you sure you want to change the base?
Conversation
edab42a
to
49b945c
Compare
BenchmarksStartupParameters
See matching parameters
SummaryFound 0 performance improvements and 0 performance regressions! Performance is the same for 52 metrics, 11 unstable metrics. Startup time reports for insecure-bankgantt
title insecure-bank - global startup overhead: candidate=1.46.0-SNAPSHOT~edd3667fb4, baseline=1.46.0-SNAPSHOT~51fc9b9eba
dateFormat X
axisFormat %s
section tracing
Agent [baseline] (1.054 s) : 0, 1054165
Total [baseline] (8.668 s) : 0, 8667794
Agent [candidate] (1.04 s) : 0, 1040207
Total [candidate] (8.644 s) : 0, 8644030
section iast
Agent [baseline] (1.175 s) : 0, 1174534
Total [baseline] (9.235 s) : 0, 9234852
Agent [candidate] (1.17 s) : 0, 1169738
Total [candidate] (9.256 s) : 0, 9256245
section iast_HARDCODED_SECRET_DISABLED
Agent [baseline] (1.168 s) : 0, 1168085
Total [baseline] (9.204 s) : 0, 9203695
Agent [candidate] (1.17 s) : 0, 1170145
Total [candidate] (9.186 s) : 0, 9186365
section iast_TELEMETRY_OFF
Agent [baseline] (1.165 s) : 0, 1165312
Total [baseline] (9.264 s) : 0, 9264382
Agent [candidate] (1.169 s) : 0, 1168643
Total [candidate] (9.222 s) : 0, 9221514
gantt
title insecure-bank - break down per module: candidate=1.46.0-SNAPSHOT~edd3667fb4, baseline=1.46.0-SNAPSHOT~51fc9b9eba
dateFormat X
axisFormat %s
section tracing
BytebuddyAgent [baseline] (725.462 ms) : 0, 725462
BytebuddyAgent [candidate] (716.657 ms) : 0, 716657
GlobalTracer [baseline] (242.748 ms) : 0, 242748
GlobalTracer [candidate] (240.159 ms) : 0, 240159
AppSec [baseline] (55.992 ms) : 0, 55992
AppSec [candidate] (55.241 ms) : 0, 55241
Remote Config [baseline] (718.135 µs) : 0, 718
Remote Config [candidate] (719.406 µs) : 0, 719
Telemetry [baseline] (13.739 ms) : 0, 13739
Telemetry [candidate] (12.116 ms) : 0, 12116
section iast
BytebuddyAgent [baseline] (838.184 ms) : 0, 838184
BytebuddyAgent [candidate] (834.612 ms) : 0, 834612
GlobalTracer [baseline] (231.727 ms) : 0, 231727
GlobalTracer [candidate] (230.972 ms) : 0, 230972
AppSec [baseline] (54.818 ms) : 0, 54818
AppSec [candidate] (54.547 ms) : 0, 54547
Remote Config [baseline] (624.847 µs) : 0, 625
Remote Config [candidate] (606.254 µs) : 0, 606
Telemetry [baseline] (8.77 ms) : 0, 8770
Telemetry [candidate] (8.749 ms) : 0, 8749
IAST [baseline] (25.029 ms) : 0, 25029
IAST [candidate] (24.961 ms) : 0, 24961
section iast_HARDCODED_SECRET_DISABLED
BytebuddyAgent [baseline] (833.572 ms) : 0, 833572
BytebuddyAgent [candidate] (834.529 ms) : 0, 834529
GlobalTracer [baseline] (230.429 ms) : 0, 230429
GlobalTracer [candidate] (231.27 ms) : 0, 231270
AppSec [baseline] (52.272 ms) : 0, 52272
AppSec [candidate] (56.266 ms) : 0, 56266
Remote Config [baseline] (615.077 µs) : 0, 615
Remote Config [candidate] (620.871 µs) : 0, 621
Telemetry [baseline] (8.697 ms) : 0, 8697
Telemetry [candidate] (8.746 ms) : 0, 8746
IAST [baseline] (27.175 ms) : 0, 27175
IAST [candidate] (23.303 ms) : 0, 23303
section iast_TELEMETRY_OFF
BytebuddyAgent [baseline] (830.736 ms) : 0, 830736
BytebuddyAgent [candidate] (835.096 ms) : 0, 835096
GlobalTracer [baseline] (230.375 ms) : 0, 230375
GlobalTracer [candidate] (230.343 ms) : 0, 230343
AppSec [baseline] (54.53 ms) : 0, 54530
AppSec [candidate] (54.381 ms) : 0, 54381
Remote Config [baseline] (625.502 µs) : 0, 626
Remote Config [candidate] (616.217 µs) : 0, 616
Telemetry [baseline] (8.722 ms) : 0, 8722
Telemetry [candidate] (8.521 ms) : 0, 8521
IAST [baseline] (25.024 ms) : 0, 25024
IAST [candidate] (24.26 ms) : 0, 24260
Startup time reports for petclinicgantt
title petclinic - global startup overhead: candidate=1.46.0-SNAPSHOT~edd3667fb4, baseline=1.46.0-SNAPSHOT~51fc9b9eba
dateFormat X
axisFormat %s
section tracing
Agent [baseline] (1.046 s) : 0, 1046104
Total [baseline] (10.496 s) : 0, 10495665
Agent [candidate] (1.051 s) : 0, 1050942
Total [candidate] (10.556 s) : 0, 10556278
section appsec
Agent [baseline] (1.184 s) : 0, 1184181
Total [baseline] (10.778 s) : 0, 10777695
Agent [candidate] (1.181 s) : 0, 1180936
Total [candidate] (10.776 s) : 0, 10775601
section iast
Agent [baseline] (1.173 s) : 0, 1172693
Total [baseline] (10.991 s) : 0, 10991039
Agent [candidate] (1.173 s) : 0, 1173200
Total [candidate] (10.984 s) : 0, 10983951
section profiling
Agent [baseline] (1.262 s) : 0, 1261609
Total [baseline] (10.952 s) : 0, 10951899
Agent [candidate] (1.261 s) : 0, 1260738
Total [candidate] (10.94 s) : 0, 10939720
gantt
title petclinic - break down per module: candidate=1.46.0-SNAPSHOT~edd3667fb4, baseline=1.46.0-SNAPSHOT~51fc9b9eba
dateFormat X
axisFormat %s
section tracing
BytebuddyAgent [baseline] (720.82 ms) : 0, 720820
BytebuddyAgent [candidate] (722.062 ms) : 0, 722062
GlobalTracer [baseline] (241.947 ms) : 0, 241947
GlobalTracer [candidate] (242.595 ms) : 0, 242595
AppSec [baseline] (55.672 ms) : 0, 55672
AppSec [candidate] (55.877 ms) : 0, 55877
Remote Config [baseline] (716.88 µs) : 0, 717
Remote Config [candidate] (714.856 µs) : 0, 715
Telemetry [baseline] (11.518 ms) : 0, 11518
Telemetry [candidate] (14.366 ms) : 0, 14366
section appsec
BytebuddyAgent [baseline] (735.302 ms) : 0, 735302
BytebuddyAgent [candidate] (731.953 ms) : 0, 731953
GlobalTracer [baseline] (238.288 ms) : 0, 238288
GlobalTracer [candidate] (237.319 ms) : 0, 237319
AppSec [baseline] (175.513 ms) : 0, 175513
AppSec [candidate] (176.008 ms) : 0, 176008
Remote Config [baseline] (643.753 µs) : 0, 644
Remote Config [candidate] (660.786 µs) : 0, 661
Telemetry [baseline] (8.279 ms) : 0, 8279
Telemetry [candidate] (8.961 ms) : 0, 8961
IAST [baseline] (21.626 ms) : 0, 21626
IAST [candidate] (21.561 ms) : 0, 21561
section iast
BytebuddyAgent [baseline] (836.253 ms) : 0, 836253
BytebuddyAgent [candidate] (836.542 ms) : 0, 836542
GlobalTracer [baseline] (231.685 ms) : 0, 231685
GlobalTracer [candidate] (231.968 ms) : 0, 231968
AppSec [baseline] (54.311 ms) : 0, 54311
AppSec [candidate] (54.877 ms) : 0, 54877
Remote Config [baseline] (619.692 µs) : 0, 620
Remote Config [candidate] (618.578 µs) : 0, 619
Telemetry [baseline] (8.75 ms) : 0, 8750
Telemetry [candidate] (8.752 ms) : 0, 8752
IAST [baseline] (25.651 ms) : 0, 25651
IAST [candidate] (25.028 ms) : 0, 25028
section profiling
ProfilingAgent [baseline] (96.297 ms) : 0, 96297
ProfilingAgent [candidate] (96.099 ms) : 0, 96099
BytebuddyAgent [baseline] (707.566 ms) : 0, 707566
BytebuddyAgent [candidate] (705.397 ms) : 0, 705397
GlobalTracer [baseline] (350.483 ms) : 0, 350483
GlobalTracer [candidate] (352.438 ms) : 0, 352438
AppSec [baseline] (55.07 ms) : 0, 55070
AppSec [candidate] (54.813 ms) : 0, 54813
Remote Config [baseline] (698.875 µs) : 0, 699
Remote Config [candidate] (716.335 µs) : 0, 716
Telemetry [baseline] (8.823 ms) : 0, 8823
Telemetry [candidate] (8.933 ms) : 0, 8933
Profiling [baseline] (96.322 ms) : 0, 96322
Profiling [candidate] (96.124 ms) : 0, 96124
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 petclinicgantt
title petclinic - request duration [CI 0.99] : candidate=1.46.0-SNAPSHOT~edd3667fb4, baseline=1.46.0-SNAPSHOT~51fc9b9eba
dateFormat X
axisFormat %s
section baseline
no_agent (1.35 ms) : 1330, 1369
. : milestone, 1350,
appsec (1.754 ms) : 1731, 1776
. : milestone, 1754,
appsec_no_iast (1.78 ms) : 1756, 1805
. : milestone, 1780,
iast (1.512 ms) : 1487, 1537
. : milestone, 1512,
profiling (1.515 ms) : 1492, 1539
. : milestone, 1515,
tracing (1.503 ms) : 1479, 1528
. : milestone, 1503,
section candidate
no_agent (1.356 ms) : 1337, 1376
. : milestone, 1356,
appsec (1.762 ms) : 1738, 1785
. : milestone, 1762,
appsec_no_iast (1.749 ms) : 1724, 1773
. : milestone, 1749,
iast (1.524 ms) : 1500, 1547
. : milestone, 1524,
profiling (1.521 ms) : 1498, 1544
. : milestone, 1521,
tracing (1.462 ms) : 1437, 1487
. : milestone, 1462,
Request duration reports for insecure-bankgantt
title insecure-bank - request duration [CI 0.99] : candidate=1.46.0-SNAPSHOT~edd3667fb4, baseline=1.46.0-SNAPSHOT~51fc9b9eba
dateFormat X
axisFormat %s
section baseline
no_agent (387.918 µs) : 368, 408
. : milestone, 388,
iast (513.257 µs) : 490, 537
. : milestone, 513,
iast_FULL (743.268 µs) : 720, 766
. : milestone, 743,
iast_GLOBAL (553.097 µs) : 530, 576
. : milestone, 553,
iast_HARDCODED_SECRET_DISABLED (521.231 µs) : 498, 544
. : milestone, 521,
iast_INACTIVE (463.874 µs) : 441, 486
. : milestone, 464,
iast_TELEMETRY_OFF (503.101 µs) : 480, 527
. : milestone, 503,
tracing (456.27 µs) : 435, 477
. : milestone, 456,
section candidate
no_agent (380.05 µs) : 360, 400
. : milestone, 380,
iast (510.723 µs) : 488, 534
. : milestone, 511,
iast_FULL (753.991 µs) : 732, 776
. : milestone, 754,
iast_GLOBAL (554.789 µs) : 533, 576
. : milestone, 555,
iast_HARDCODED_SECRET_DISABLED (509.556 µs) : 487, 532
. : milestone, 510,
iast_INACTIVE (465.034 µs) : 443, 487
. : milestone, 465,
iast_TELEMETRY_OFF (497.513 µs) : 475, 520
. : milestone, 498,
tracing (462.739 µs) : 442, 483
. : milestone, 463,
DacapoParameters
See matching parameters
SummaryFound 0 performance improvements and 0 performance regressions! Performance is the same for 12 metrics, 0 unstable metrics. Execution time for tomcatgantt
title tomcat - execution time [CI 0.99] : candidate=1.46.0-SNAPSHOT~edd3667fb4, baseline=1.46.0-SNAPSHOT~51fc9b9eba
dateFormat X
axisFormat %s
section baseline
no_agent (1.466 ms) : 1455, 1478
. : milestone, 1466,
appsec (2.349 ms) : 2306, 2392
. : milestone, 2349,
iast (2.1 ms) : 2046, 2155
. : milestone, 2100,
iast_GLOBAL (2.136 ms) : 2081, 2190
. : milestone, 2136,
profiling (1.963 ms) : 1920, 2006
. : milestone, 1963,
tracing (1.939 ms) : 1896, 1981
. : milestone, 1939,
section candidate
no_agent (1.464 ms) : 1453, 1475
. : milestone, 1464,
appsec (2.339 ms) : 2296, 2382
. : milestone, 2339,
iast (2.109 ms) : 2053, 2164
. : milestone, 2109,
iast_GLOBAL (2.145 ms) : 2089, 2201
. : milestone, 2145,
profiling (1.968 ms) : 1924, 2012
. : milestone, 1968,
tracing (1.945 ms) : 1903, 1988
. : milestone, 1945,
Execution time for biojavagantt
title biojava - execution time [CI 0.99] : candidate=1.46.0-SNAPSHOT~edd3667fb4, baseline=1.46.0-SNAPSHOT~51fc9b9eba
dateFormat X
axisFormat %s
section baseline
no_agent (15.475 s) : 15475000, 15475000
. : milestone, 15475000,
appsec (15.162 s) : 15162000, 15162000
. : milestone, 15162000,
iast (18.579 s) : 18579000, 18579000
. : milestone, 18579000,
iast_GLOBAL (18.131 s) : 18131000, 18131000
. : milestone, 18131000,
profiling (15.217 s) : 15217000, 15217000
. : milestone, 15217000,
tracing (14.729 s) : 14729000, 14729000
. : milestone, 14729000,
section candidate
no_agent (14.877 s) : 14877000, 14877000
. : milestone, 14877000,
appsec (15.224 s) : 15224000, 15224000
. : milestone, 15224000,
iast (18.705 s) : 18705000, 18705000
. : milestone, 18705000,
iast_GLOBAL (18.062 s) : 18062000, 18062000
. : milestone, 18062000,
profiling (15.073 s) : 15073000, 15073000
. : milestone, 15073000,
tracing (14.85 s) : 14850000, 14850000
. : milestone, 14850000,
|
ba49891
to
81367a6
Compare
cf26bab
to
48f7af5
Compare
Hi! 👋 Thanks for your pull request! 🎉 To help us review it, please make sure to:
If you need help, please check our contributing guidelines. |
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.
Nice addition for Windows! I only cared about making it buildable but having documentation / onboarding will definitely help too! 💪
BUILDING.md
Outdated
|
||
### Build the project | ||
> [!NOTE] |
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.
This block is broken (missing a line break?)
48f7af5
to
410adfc
Compare
55eeed2
to
5d757df
Compare
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! 👍 (I didn’t get update notification from your changes 😞 )
I only added the GraalVM version too (as it is no more the latest LTS version)
### Install the required JDKs | ||
|
||
**On MacOS:** | ||
Download and install Eclipse Temurin JDK versions 8, 11, 17 and 21, and GraalVM. |
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.
Download and install Eclipse Temurin JDK versions 8, 11, 17 and 21, and GraalVM. | |
Download and install Eclipse Temurin JDK versions 8, 11, 17 and 21, and GraalVM 17. |
|
||
* 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/). | ||
* 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/). |
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.
* 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/). | |
* Download and extract JDK 8, 11, 17, and 21 from [Eclipse Temurin releases](https://adoptium.net/temurin/releases/) and GraalVM 17 from [Oracle downloads](https://www.graalvm.org/downloads/). |
What Does This Do
Try to improve the steps to set up the
dd-trace-java
development environment on Windows:setup.ps1
for quick check (same assetup.sh
)tooling/install-jdks-windows.ps1
to install required SDKs and environment variablesBUILDING.md
, previewMotivation
I am working with
dd-trace-java
for the first time, and I have a Windows laptop, so I'm trying to cover some of the onboarding gaps for the next engineer 😅Additional Notes
These changes only cover docs and scripts to set up dev env on Windows. No code changes to the library itself. (i.e. tests required)
Contributor Checklist
type:
and (comp:
orinst:
) labels in addition to any usefull labelsclose
,fix
or any linking keywords when referencing an issue.Use
solves
instead, and assign the PR milestone to the issueJira ticket: [PROJ-IDENT]