Adding Config Registry Linter to Ensure Alias Keys Are Documented#10068
Adding Config Registry Linter to Ensure Alias Keys Are Documented#10068
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. |
BenchmarksStartupParameters
See matching parameters
SummaryFound 16 performance improvements and 20 performance regressions! Performance is the same for 17 metrics, 12 unstable metrics.
Startup time reports for petclinicgantt
title petclinic - global startup overhead: candidate=1.57.0-SNAPSHOT~f907aa74c8, baseline=1.57.0-SNAPSHOT~6836076eba
dateFormat X
axisFormat %s
section tracing
Agent [baseline] (1.08 s) : 0, 1079977
Total [baseline] (10.809 s) : 0, 10809259
Agent [candidate] (1.068 s) : 0, 1068228
Total [candidate] (10.747 s) : 0, 10746886
section appsec
Agent [baseline] (1.284 s) : 0, 1284353
Total [baseline] (11.15 s) : 0, 11149831
Agent [candidate] (1.231 s) : 0, 1230661
Total [candidate] (10.971 s) : 0, 10971451
section iast
Agent [baseline] (1.234 s) : 0, 1233966
Total [baseline] (11.179 s) : 0, 11179000
Agent [candidate] (1.194 s) : 0, 1193747
Total [candidate] (11.193 s) : 0, 11193262
section profiling
Agent [baseline] (1.205 s) : 0, 1205046
Total [baseline] (11.03 s) : 0, 11029952
Agent [candidate] (1.203 s) : 0, 1202958
Total [candidate] (10.963 s) : 0, 10962789
gantt
title petclinic - break down per module: candidate=1.57.0-SNAPSHOT~f907aa74c8, baseline=1.57.0-SNAPSHOT~6836076eba
dateFormat X
axisFormat %s
section tracing
crashtracking [baseline] (1.206 ms) : 0, 1206
crashtracking [candidate] (1.504 ms) : 0, 1504
BytebuddyAgent [baseline] (648.746 ms) : 0, 648746
BytebuddyAgent [candidate] (717.953 ms) : 0, 717953
GlobalTracer [baseline] (281.178 ms) : 0, 281178
GlobalTracer [candidate] (253.014 ms) : 0, 253014
AppSec [baseline] (32.318 ms) : 0, 32318
AppSec [candidate] (32.8 ms) : 0, 32800
Debugger [baseline] (67.799 ms) : 0, 67799
Debugger [candidate] (6.612 ms) : 0, 6612
Remote Config [baseline] (634.88 µs) : 0, 635
Remote Config [candidate] (691.819 µs) : 0, 692
Telemetry [baseline] (8.974 ms) : 0, 8974
Telemetry [candidate] (14.84 ms) : 0, 14840
Flare Poller [baseline] (3.63 ms) : 0, 3630
Flare Poller [candidate] (5.618 ms) : 0, 5618
section appsec
crashtracking [baseline] (1.227 ms) : 0, 1227
crashtracking [candidate] (1.48 ms) : 0, 1480
BytebuddyAgent [baseline] (700.994 ms) : 0, 700994
BytebuddyAgent [candidate] (731.964 ms) : 0, 731964
GlobalTracer [baseline] (263.31 ms) : 0, 263310
GlobalTracer [candidate] (242.103 ms) : 0, 242103
AppSec [baseline] (176.816 ms) : 0, 176816
AppSec [candidate] (175.912 ms) : 0, 175912
Debugger [baseline] (67.192 ms) : 0, 67192
Debugger [candidate] (6.336 ms) : 0, 6336
Remote Config [baseline] (718.432 µs) : 0, 718
Remote Config [candidate] (681.01 µs) : 0, 681
Telemetry [baseline] (9.065 ms) : 0, 9065
Telemetry [candidate] (8.21 ms) : 0, 8210
Flare Poller [baseline] (3.986 ms) : 0, 3986
Flare Poller [candidate] (4.059 ms) : 0, 4059
IAST [baseline] (25.134 ms) : 0, 25134
IAST [candidate] (24.9 ms) : 0, 24900
section iast
crashtracking [baseline] (1.241 ms) : 0, 1241
crashtracking [candidate] (1.479 ms) : 0, 1479
BytebuddyAgent [baseline] (797.662 ms) : 0, 797662
BytebuddyAgent [candidate] (832.269 ms) : 0, 832269
GlobalTracer [baseline] (258.17 ms) : 0, 258170
GlobalTracer [candidate] (237.73 ms) : 0, 237730
AppSec [baseline] (35.39 ms) : 0, 35390
AppSec [candidate] (29.502 ms) : 0, 29502
Debugger [baseline] (66.201 ms) : 0, 66201
Debugger [candidate] (6.068 ms) : 0, 6068
Remote Config [baseline] (556.556 µs) : 0, 557
Remote Config [candidate] (614.498 µs) : 0, 614
Telemetry [baseline] (8.482 ms) : 0, 8482
Telemetry [candidate] (8.046 ms) : 0, 8046
Flare Poller [baseline] (3.5 ms) : 0, 3500
Flare Poller [candidate] (11.127 ms) : 0, 11127
IAST [baseline] (27.146 ms) : 0, 27146
IAST [candidate] (32.003 ms) : 0, 32003
section profiling
crashtracking [baseline] (1.184 ms) : 0, 1184
crashtracking [candidate] (1.433 ms) : 0, 1433
BytebuddyAgent [baseline] (701.501 ms) : 0, 701501
BytebuddyAgent [candidate] (736.821 ms) : 0, 736821
GlobalTracer [baseline] (220.733 ms) : 0, 220733
GlobalTracer [candidate] (223.656 ms) : 0, 223656
AppSec [baseline] (32.355 ms) : 0, 32355
AppSec [candidate] (32.202 ms) : 0, 32202
Debugger [baseline] (68.365 ms) : 0, 68365
Debugger [candidate] (6.765 ms) : 0, 6765
Remote Config [baseline] (639.272 µs) : 0, 639
Remote Config [candidate] (673.357 µs) : 0, 673
Telemetry [baseline] (8.982 ms) : 0, 8982
Telemetry [candidate] (16.432 ms) : 0, 16432
Flare Poller [baseline] (3.73 ms) : 0, 3730
Flare Poller [candidate] (4.184 ms) : 0, 4184
ProfilingAgent [baseline] (97.944 ms) : 0, 97944
ProfilingAgent [candidate] (111.358 ms) : 0, 111358
Profiling [baseline] (98.522 ms) : 0, 98522
Profiling [candidate] (112.0 ms) : 0, 112000
Startup time reports for insecure-bankgantt
title insecure-bank - global startup overhead: candidate=1.57.0-SNAPSHOT~f907aa74c8, baseline=1.57.0-SNAPSHOT~6836076eba
dateFormat X
axisFormat %s
section tracing
Agent [baseline] (1.085 s) : 0, 1084943
Total [baseline] (8.766 s) : 0, 8766052
Agent [candidate] (1.052 s) : 0, 1051807
Total [candidate] (8.704 s) : 0, 8703708
section iast
Agent [baseline] (1.222 s) : 0, 1222487
Total [baseline] (9.492 s) : 0, 9492324
Agent [candidate] (1.196 s) : 0, 1195575
Total [candidate] (9.323 s) : 0, 9322898
gantt
title insecure-bank - break down per module: candidate=1.57.0-SNAPSHOT~f907aa74c8, baseline=1.57.0-SNAPSHOT~6836076eba
dateFormat X
axisFormat %s
section tracing
crashtracking [baseline] (1.199 ms) : 0, 1199
crashtracking [candidate] (1.485 ms) : 0, 1485
BytebuddyAgent [baseline] (650.943 ms) : 0, 650943
BytebuddyAgent [candidate] (707.034 ms) : 0, 707034
GlobalTracer [baseline] (283.807 ms) : 0, 283807
GlobalTracer [candidate] (248.92 ms) : 0, 248920
AppSec [baseline] (32.611 ms) : 0, 32611
AppSec [candidate] (31.98 ms) : 0, 31980
Debugger [baseline] (67.332 ms) : 0, 67332
Debugger [candidate] (6.41 ms) : 0, 6410
Remote Config [baseline] (641.399 µs) : 0, 641
Remote Config [candidate] (676.398 µs) : 0, 676
Telemetry [baseline] (9.038 ms) : 0, 9038
Telemetry [candidate] (16.282 ms) : 0, 16282
Flare Poller [baseline] (3.695 ms) : 0, 3695
Flare Poller [candidate] (4.145 ms) : 0, 4145
section iast
crashtracking [baseline] (1.196 ms) : 0, 1196
crashtracking [candidate] (1.499 ms) : 0, 1499
BytebuddyAgent [baseline] (790.898 ms) : 0, 790898
BytebuddyAgent [candidate] (833.368 ms) : 0, 833368
GlobalTracer [baseline] (255.696 ms) : 0, 255696
GlobalTracer [candidate] (238.437 ms) : 0, 238437
AppSec [baseline] (35.455 ms) : 0, 35455
AppSec [candidate] (29.627 ms) : 0, 29627
Debugger [baseline] (64.38 ms) : 0, 64380
Debugger [candidate] (6.116 ms) : 0, 6116
Remote Config [baseline] (547.344 µs) : 0, 547
Remote Config [candidate] (617.408 µs) : 0, 617
Telemetry [baseline] (8.428 ms) : 0, 8428
Telemetry [candidate] (8.022 ms) : 0, 8022
Flare Poller [baseline] (3.464 ms) : 0, 3464
Flare Poller [candidate] (11.053 ms) : 0, 11053
IAST [baseline] (26.907 ms) : 0, 26907
IAST [candidate] (31.923 ms) : 0, 31923
LoadParameters
See matching parameters
SummaryFound 0 performance improvements and 3 performance regressions! Performance is the same for 17 metrics, 16 unstable metrics.
Request duration reports for insecure-bankgantt
title insecure-bank - request duration [CI 0.99] : candidate=1.57.0-SNAPSHOT~f907aa74c8, baseline=1.57.0-SNAPSHOT~6836076eba
dateFormat X
axisFormat %s
section baseline
no_agent (1.198 ms) : 1185, 1211
. : milestone, 1198,
iast (3.096 ms) : 3063, 3128
. : milestone, 3096,
iast_FULL (5.796 ms) : 5738, 5855
. : milestone, 5796,
iast_GLOBAL (3.662 ms) : 3602, 3723
. : milestone, 3662,
profiling (2.061 ms) : 2043, 2078
. : milestone, 2061,
tracing (1.782 ms) : 1768, 1797
. : milestone, 1782,
section candidate
no_agent (1.207 ms) : 1196, 1219
. : milestone, 1207,
iast (3.286 ms) : 3241, 3331
. : milestone, 3286,
iast_FULL (6.055 ms) : 5993, 6117
. : milestone, 6055,
iast_GLOBAL (3.718 ms) : 3648, 3788
. : milestone, 3718,
profiling (1.964 ms) : 1946, 1981
. : milestone, 1964,
tracing (1.796 ms) : 1782, 1811
. : milestone, 1796,
Request duration reports for petclinicgantt
title petclinic - request duration [CI 0.99] : candidate=1.57.0-SNAPSHOT~f907aa74c8, baseline=1.57.0-SNAPSHOT~6836076eba
dateFormat X
axisFormat %s
section baseline
no_agent (19.412 ms) : 19213, 19610
. : milestone, 19412,
appsec (18.71 ms) : 18519, 18901
. : milestone, 18710,
code_origins (17.958 ms) : 17779, 18137
. : milestone, 17958,
iast (17.784 ms) : 17608, 17960
. : milestone, 17784,
profiling (18.625 ms) : 18441, 18808
. : milestone, 18625,
tracing (18.425 ms) : 18238, 18613
. : milestone, 18425,
section candidate
no_agent (19.621 ms) : 19419, 19823
. : milestone, 19621,
appsec (18.678 ms) : 18492, 18864
. : milestone, 18678,
code_origins (18.116 ms) : 17936, 18296
. : milestone, 18116,
iast (18.49 ms) : 18303, 18677
. : milestone, 18490,
profiling (18.623 ms) : 18435, 18811
. : milestone, 18623,
tracing (18.733 ms) : 18545, 18920
. : milestone, 18733,
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 biojavagantt
title biojava - execution time [CI 0.99] : candidate=1.57.0-SNAPSHOT~f907aa74c8, baseline=1.57.0-SNAPSHOT~6836076eba
dateFormat X
axisFormat %s
section baseline
no_agent (14.849 s) : 14849000, 14849000
. : milestone, 14849000,
appsec (14.58 s) : 14580000, 14580000
. : milestone, 14580000,
iast (17.577 s) : 17577000, 17577000
. : milestone, 17577000,
iast_GLOBAL (17.311 s) : 17311000, 17311000
. : milestone, 17311000,
profiling (13.852 s) : 13852000, 13852000
. : milestone, 13852000,
tracing (14.26 s) : 14260000, 14260000
. : milestone, 14260000,
section candidate
no_agent (15.321 s) : 15321000, 15321000
. : milestone, 15321000,
appsec (14.065 s) : 14065000, 14065000
. : milestone, 14065000,
iast (17.765 s) : 17765000, 17765000
. : milestone, 17765000,
iast_GLOBAL (17.466 s) : 17466000, 17466000
. : milestone, 17466000,
profiling (13.948 s) : 13948000, 13948000
. : milestone, 13948000,
tracing (14.476 s) : 14476000, 14476000
. : milestone, 14476000,
Execution time for tomcatgantt
title tomcat - execution time [CI 0.99] : candidate=1.57.0-SNAPSHOT~f907aa74c8, baseline=1.57.0-SNAPSHOT~6836076eba
dateFormat X
axisFormat %s
section baseline
no_agent (1.494 ms) : 1482, 1506
. : milestone, 1494,
appsec (2.811 ms) : 2726, 2896
. : milestone, 2811,
iast (2.593 ms) : 2491, 2696
. : milestone, 2593,
iast_GLOBAL (2.64 ms) : 2538, 2743
. : milestone, 2640,
profiling (2.42 ms) : 2334, 2506
. : milestone, 2420,
tracing (2.39 ms) : 2307, 2474
. : milestone, 2390,
section candidate
no_agent (1.49 ms) : 1478, 1502
. : milestone, 1490,
appsec (2.805 ms) : 2720, 2890
. : milestone, 2805,
iast (2.594 ms) : 2491, 2696
. : milestone, 2594,
iast_GLOBAL (2.642 ms) : 2539, 2745
. : milestone, 2642,
profiling (2.424 ms) : 2337, 2511
. : milestone, 2424,
tracing (2.392 ms) : 2307, 2476
. : milestone, 2392,
|
bric3
left a comment
There was a problem hiding this comment.
Some suggestions, although it looks good.
|
|
||
| // token check that uses the generated class instead of JSON | ||
| target.tasks.register("logEnvVarUsages") { | ||
| group = "verification" |
There was a problem hiding this comment.
suggestion: By the way you may use this constant org.gradle.language.base.plugins.LifecycleBasePlugin#VERIFICATION_GROUP.
| /** Registers `checkEnvironmentVariablesUsage` (forbid EnvironmentVariables.get(...)). */ | ||
| private fun registerCheckEnvironmentVariablesUsage(project: Project) { | ||
| project.tasks.register("checkEnvironmentVariablesUsage") { | ||
| group = "verification" |
There was a problem hiding this comment.
suggestion: By the way you may use this constant org.gradle.language.base.plugins.LifecycleBasePlugin#VERIFICATION_GROUP.
| val generatedFile = extension.className | ||
|
|
||
| project.tasks.register("checkConfigStrings") { | ||
| group = "verification" |
There was a problem hiding this comment.
suggestion: By the way you may use this constant org.gradle.language.base.plugins.LifecycleBasePlugin#VERIFICATION_GROUP.
| val generatedFile = extension.className | ||
|
|
||
| project.tasks.register("verifyAliasKeysAreSupported") { | ||
| group = "verification" |
There was a problem hiding this comment.
suggestion: By the way you may use this constant org.gradle.language.base.plugins.LifecycleBasePlugin#VERIFICATION_GROUP.
| .extensions.getByType<SourceSetContainer>() | ||
| .named(SourceSet.MAIN_SOURCE_SET_NAME) | ||
| .map { main -> main.output } | ||
| } |
There was a problem hiding this comment.
nitpick: It's possible to unwrap the nested value with a flatMap.
| } | |
| val mainSourceSetOutput = ownerPath.flatMap { | |
| project.project(it) | |
| .extensions.getByType<SourceSetContainer>() | |
| .named(SourceSet.MAIN_SOURCE_SET_NAME) | |
| }.map { it.output } |
35b1206 to
f907aa7
Compare
|
This pull request has been marked as stale because it has not had activity over the past quarter. It will be closed in 7 days if no further activity occurs. Feel free to reopen the PR if you are still working on it. |
What Does This Do
This PR adds a new Gradle task to ensure that all alias keys in the
supported-configurations.jsonfile are also defined and documented in thesupportedConfigurationskey.Motivation
Additional Notes
Contributor Checklist
type:and (comp:orinst:) labels in addition to any useful labelsclose,fixor any linking keywords when referencing an issue.Use
solvesinstead, and assign the PR milestone to the issueJira ticket: [PROJ-IDENT]