Switch to mandatory issue templates #8106

tlhunter · 2024-12-17T22:33:13Z

What Does This Do

standardizes the issue creation screen
standardizes the security policy document
makes issue templates mandatory
creates a bug report and feature request issue template

Motivation

standardizes the create issue screen across tracers

Additional Notes

here's an example of how it will look: https://github.com/DataDog/dd-trace-js/issues/new/choose

Contributor Checklist

Format the title according the contribution guidelines
Assign the type: and (comp: or inst:) labels in addition to any usefull labels
Don't use close, fix or any linking keywords when referencing an issue.
Use solves instead, and assign the PR milestone to the issue
Update the public documentation in case of new configuration flag or behavior

Jira ticket: AIDM-429

pr-commenter · 2024-12-17T23:12:04Z

Benchmarks

Startup

Load

Parameters

	Baseline	Candidate
baseline_or_candidate	baseline	candidate
end_time	2025-01-09T20:46:10	2025-01-09T20:53:10
git_branch	master	tlhunter/create-issue-standard
git_commit_date	1736444760	1736454897
git_commit_sha	`03478c8`	`e8df92d`
release_version	1.46.0-SNAPSHOT~03478c8e5c	1.46.0-SNAPSHOT~e8df92d7ff
start_time	2025-01-09T20:45:56	2025-01-09T20:52:56

See matching parameters

	Baseline	Candidate
application	insecure-bank	insecure-bank
ci_job_date	1736456345	1736456345
ci_job_id	761012502	761012502
ci_pipeline_id	52596992	52596992
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 petclinic

gantt
    title petclinic - request duration [CI 0.99] : candidate=1.46.0-SNAPSHOT~e8df92d7ff, baseline=1.46.0-SNAPSHOT~03478c8e5c
    dateFormat X
    axisFormat %s
section baseline
no_agent (1.337 ms) : 1318, 1357
.   : milestone, 1337,
appsec (1.747 ms) : 1721, 1773
.   : milestone, 1747,
appsec_no_iast (1.765 ms) : 1743, 1788
.   : milestone, 1765,
iast (1.523 ms) : 1499, 1546
.   : milestone, 1523,
profiling (1.51 ms) : 1486, 1534
.   : milestone, 1510,
tracing (1.498 ms) : 1473, 1523
.   : milestone, 1498,
section candidate
no_agent (1.373 ms) : 1353, 1393
.   : milestone, 1373,
appsec (1.779 ms) : 1756, 1803
.   : milestone, 1779,
appsec_no_iast (1.765 ms) : 1741, 1789
.   : milestone, 1765,
iast (1.507 ms) : 1484, 1530
.   : milestone, 1507,
profiling (1.495 ms) : 1471, 1519
.   : milestone, 1495,
tracing (1.493 ms) : 1467, 1518
.   : milestone, 1493,

baseline results

Variant	Request duration [CI 0.99]	Δ no_agent
no_agent	1.337 ms [1.318 ms, 1.357 ms]	-
appsec	1.747 ms [1.721 ms, 1.773 ms]	409.589 µs (30.6%)
appsec_no_iast	1.765 ms [1.743 ms, 1.788 ms]	428.024 µs (32.0%)
iast	1.523 ms [1.499 ms, 1.546 ms]	185.189 µs (13.8%)
profiling	1.51 ms [1.486 ms, 1.534 ms]	172.559 µs (12.9%)
tracing	1.498 ms [1.473 ms, 1.523 ms]	160.66 µs (12.0%)

candidate results

Variant	Request duration [CI 0.99]	Δ no_agent
no_agent	1.373 ms [1.353 ms, 1.393 ms]	-
appsec	1.779 ms [1.756 ms, 1.803 ms]	406.45 µs (29.6%)
appsec_no_iast	1.765 ms [1.741 ms, 1.789 ms]	391.99 µs (28.6%)
iast	1.507 ms [1.484 ms, 1.53 ms]	134.013 µs (9.8%)
profiling	1.495 ms [1.471 ms, 1.519 ms]	121.922 µs (8.9%)
tracing	1.493 ms [1.467 ms, 1.518 ms]	119.558 µs (8.7%)

Request duration reports for insecure-bank

gantt
    title insecure-bank - request duration [CI 0.99] : candidate=1.46.0-SNAPSHOT~e8df92d7ff, baseline=1.46.0-SNAPSHOT~03478c8e5c
    dateFormat X
    axisFormat %s
section baseline
no_agent (383.939 µs) : 364, 404
.   : milestone, 384,
iast (502.85 µs) : 481, 525
.   : milestone, 503,
iast_FULL (659.123 µs) : 638, 681
.   : milestone, 659,
iast_GLOBAL (529.008 µs) : 507, 551
.   : milestone, 529,
iast_HARDCODED_SECRET_DISABLED (503.664 µs) : 482, 525
.   : milestone, 504,
iast_INACTIVE (457.288 µs) : 436, 479
.   : milestone, 457,
iast_TELEMETRY_OFF (483.383 µs) : 462, 505
.   : milestone, 483,
tracing (456.275 µs) : 435, 477
.   : milestone, 456,
section candidate
no_agent (381.762 µs) : 361, 402
.   : milestone, 382,
iast (504.405 µs) : 483, 526
.   : milestone, 504,
iast_FULL (660.017 µs) : 638, 682
.   : milestone, 660,
iast_GLOBAL (530.909 µs) : 509, 553
.   : milestone, 531,
iast_HARDCODED_SECRET_DISABLED (495.468 µs) : 474, 517
.   : milestone, 495,
iast_INACTIVE (457.563 µs) : 436, 479
.   : milestone, 458,
iast_TELEMETRY_OFF (484.739 µs) : 463, 506
.   : milestone, 485,
tracing (457.594 µs) : 436, 479
.   : milestone, 458,

baseline results

Variant	Request duration [CI 0.99]	Δ no_agent
no_agent	383.939 µs [363.806 µs, 404.072 µs]	-
iast	502.85 µs [480.605 µs, 525.096 µs]	118.911 µs (31.0%)
iast_FULL	659.123 µs [637.61 µs, 680.636 µs]	275.184 µs (71.7%)
iast_GLOBAL	529.008 µs [506.884 µs, 551.132 µs]	145.069 µs (37.8%)
iast_HARDCODED_SECRET_DISABLED	503.664 µs [481.91 µs, 525.418 µs]	119.725 µs (31.2%)
iast_INACTIVE	457.288 µs [435.786 µs, 478.789 µs]	73.349 µs (19.1%)
iast_TELEMETRY_OFF	483.383 µs [462.046 µs, 504.719 µs]	99.444 µs (25.9%)
tracing	456.275 µs [435.363 µs, 477.187 µs]	72.336 µs (18.8%)

candidate results

Variant	Request duration [CI 0.99]	Δ no_agent
no_agent	381.762 µs [361.45 µs, 402.073 µs]	-
iast	504.405 µs [482.73 µs, 526.079 µs]	122.643 µs (32.1%)
iast_FULL	660.017 µs [638.219 µs, 681.815 µs]	278.255 µs (72.9%)
iast_GLOBAL	530.909 µs [508.702 µs, 553.115 µs]	149.147 µs (39.1%)
iast_HARDCODED_SECRET_DISABLED	495.468 µs [473.974 µs, 516.963 µs]	113.707 µs (29.8%)
iast_INACTIVE	457.563 µs [436.205 µs, 478.921 µs]	75.802 µs (19.9%)
iast_TELEMETRY_OFF	484.739 µs [463.289 µs, 506.189 µs]	102.977 µs (27.0%)
tracing	457.594 µs [435.995 µs, 479.193 µs]	75.832 µs (19.9%)

Dacapo

Parameters

	Baseline	Candidate
baseline_or_candidate	baseline	candidate
git_branch	master	tlhunter/create-issue-standard
git_commit_date	1736444760	1736454897
git_commit_sha	`03478c8`	`e8df92d`
release_version	1.46.0-SNAPSHOT~03478c8e5c	1.46.0-SNAPSHOT~e8df92d7ff

See matching parameters

	Baseline	Candidate
application	biojava	biojava
ci_job_date	1736456906	1736456906
ci_job_id	761012503	761012503
ci_pipeline_id	52596992	52596992
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.46.0-SNAPSHOT~e8df92d7ff, baseline=1.46.0-SNAPSHOT~03478c8e5c
    dateFormat X
    axisFormat %s
section baseline
no_agent (15.226 s) : 15226000, 15226000
.   : milestone, 15226000,
appsec (14.967 s) : 14967000, 14967000
.   : milestone, 14967000,
iast (18.834 s) : 18834000, 18834000
.   : milestone, 18834000,
iast_GLOBAL (17.711 s) : 17711000, 17711000
.   : milestone, 17711000,
profiling (15.664 s) : 15664000, 15664000
.   : milestone, 15664000,
tracing (15.051 s) : 15051000, 15051000
.   : milestone, 15051000,
section candidate
no_agent (15.456 s) : 15456000, 15456000
.   : milestone, 15456000,
appsec (15.09 s) : 15090000, 15090000
.   : milestone, 15090000,
iast (19.149 s) : 19149000, 19149000
.   : milestone, 19149000,
iast_GLOBAL (17.973 s) : 17973000, 17973000
.   : milestone, 17973000,
profiling (15.017 s) : 15017000, 15017000
.   : milestone, 15017000,
tracing (14.733 s) : 14733000, 14733000
.   : milestone, 14733000,

baseline results

Variant	Execution Time [CI 0.99]	Δ no_agent
no_agent	15.226 s [15.226 s, 15.226 s]	-
appsec	14.967 s [14.967 s, 14.967 s]	-259.0 ms (-1.7%)
iast	18.834 s [18.834 s, 18.834 s]	3.608 s (23.7%)
iast_GLOBAL	17.711 s [17.711 s, 17.711 s]	2.485 s (16.3%)
profiling	15.664 s [15.664 s, 15.664 s]	438.0 ms (2.9%)
tracing	15.051 s [15.051 s, 15.051 s]	-175.0 ms (-1.1%)

candidate results

Variant	Execution Time [CI 0.99]	Δ no_agent
no_agent	15.456 s [15.456 s, 15.456 s]	-
appsec	15.09 s [15.09 s, 15.09 s]	-366.0 ms (-2.4%)
iast	19.149 s [19.149 s, 19.149 s]	3.693 s (23.9%)
iast_GLOBAL	17.973 s [17.973 s, 17.973 s]	2.517 s (16.3%)
profiling	15.017 s [15.017 s, 15.017 s]	-439.0 ms (-2.8%)
tracing	14.733 s [14.733 s, 14.733 s]	-723.0 ms (-4.7%)

Execution time for tomcat

gantt
    title tomcat - execution time [CI 0.99] : candidate=1.46.0-SNAPSHOT~e8df92d7ff, baseline=1.46.0-SNAPSHOT~03478c8e5c
    dateFormat X
    axisFormat %s
section baseline
no_agent (1.467 ms) : 1455, 1478
.   : milestone, 1467,
appsec (2.341 ms) : 2298, 2383
.   : milestone, 2341,
iast (2.095 ms) : 2041, 2148
.   : milestone, 2095,
iast_GLOBAL (2.139 ms) : 2084, 2193
.   : milestone, 2139,
profiling (1.965 ms) : 1922, 2008
.   : milestone, 1965,
tracing (1.937 ms) : 1896, 1979
.   : milestone, 1937,
section candidate
no_agent (1.464 ms) : 1452, 1475
.   : milestone, 1464,
appsec (2.347 ms) : 2304, 2390
.   : milestone, 2347,
iast (2.09 ms) : 2036, 2143
.   : milestone, 2090,
iast_GLOBAL (2.14 ms) : 2086, 2194
.   : milestone, 2140,
profiling (1.981 ms) : 1936, 2025
.   : milestone, 1981,
tracing (1.947 ms) : 1906, 1989
.   : milestone, 1947,

baseline results

Variant	Execution Time [CI 0.99]	Δ no_agent
no_agent	1.467 ms [1.455 ms, 1.478 ms]	-
appsec	2.341 ms [2.298 ms, 2.383 ms]	874.122 µs (59.6%)
iast	2.095 ms [2.041 ms, 2.148 ms]	627.929 µs (42.8%)
iast_GLOBAL	2.139 ms [2.084 ms, 2.193 ms]	671.884 µs (45.8%)
profiling	1.965 ms [1.922 ms, 2.008 ms]	498.46 µs (34.0%)
tracing	1.937 ms [1.896 ms, 1.979 ms]	470.624 µs (32.1%)

candidate results

Variant	Execution Time [CI 0.99]	Δ no_agent
no_agent	1.464 ms [1.452 ms, 1.475 ms]	-
appsec	2.347 ms [2.304 ms, 2.39 ms]	883.248 µs (60.3%)
iast	2.09 ms [2.036 ms, 2.143 ms]	625.866 µs (42.8%)
iast_GLOBAL	2.14 ms [2.086 ms, 2.194 ms]	676.064 µs (46.2%)
profiling	1.981 ms [1.936 ms, 2.025 ms]	516.753 µs (35.3%)
tracing	1.947 ms [1.906 ms, 1.989 ms]	483.569 µs (33.0%)

.github/ISSUE_TEMPLATE/bug_report.yaml

.github/ISSUE_TEMPLATE/feature_request.yaml

PerfectSlayer · 2024-12-18T10:30:26Z

.github/ISSUE_TEMPLATE/bug_report.yaml

@@ -0,0 +1,34 @@
+name: "Bug Report (Low Priority)"


Was the low / high priority wording approved as a public facing support level?

We came up with it during the ideation phase a quarter ago, I believe the OSS team looked it over, and the Node.js tracer has been using it for months.

.github/ISSUE_TEMPLATE/bug_report.yaml

PerfectSlayer · 2024-12-18T10:35:03Z

.github/ISSUE_TEMPLATE/config.yml

@@ -1,8 +1,8 @@
-blank_issues_enabled: true
+blank_issues_enabled: false


What about all the other types of issue? Performance discussions, questions, help requests?

I can add additional templates for them. Other tracers either don't support freeform discussion or use the discussions tab. Are those three topics the finite list that you would like supported? Also, what default tags would you want applied?

I would say it’s mainly performance related, or a question / help request.
I don’t know how the other tracers are handling it using GitHub?

.github/ISSUE_TEMPLATE/config.yml

.github/ISSUE_TEMPLATE/feature_request.yaml

SECURITY.md

ygree

LGTM

tlhunter added type: documentation tag: no release notes Changes to exclude from release notes labels Dec 17, 2024

tlhunter requested a review from a team as a code owner December 17, 2024 22:33

tlhunter requested a review from amarziali December 17, 2024 22:33

PerfectSlayer self-requested a review December 18, 2024 07:31

amarziali reviewed Dec 18, 2024

View reviewed changes

.github/ISSUE_TEMPLATE/bug_report.yaml Outdated Show resolved Hide resolved

amarziali reviewed Dec 18, 2024

View reviewed changes

.github/ISSUE_TEMPLATE/feature_request.yaml Outdated Show resolved Hide resolved

PerfectSlayer reviewed Dec 18, 2024

View reviewed changes

PerfectSlayer changed the title ~~repo: mandatory issue templates (AIDM-429)~~ Switch to mandatory issue templates Dec 18, 2024

tlhunter force-pushed the tlhunter/create-issue-standard branch from 4a073d2 to e20b4cf Compare December 18, 2024 23:32

ygree approved these changes Jan 6, 2025

View reviewed changes

tlhunter enabled auto-merge (squash) January 6, 2025 23:57

tlhunter added 5 commits January 6, 2025 15:57

repo: mandatory issue templates

1222afe

apply feedback from Bruce

43ae120

apply more feedback from Bruce

5d4ea1c

add dropdown for jvm vendor

30f46b7

update text

9d5f457

tlhunter force-pushed the tlhunter/create-issue-standard branch from 6014e5c to 9d5f457 Compare January 6, 2025 23:57

tlhunter and others added 2 commits January 9, 2025 09:21

Merge branch 'master' into tlhunter/create-issue-standard

e1da7e5

Merge branch 'master' into tlhunter/create-issue-standard

e8df92d

ygree disabled auto-merge January 9, 2025 21:53

tlhunter closed this Jan 9, 2025

tlhunter deleted the tlhunter/create-issue-standard branch January 9, 2025 23:32

tlhunter mentioned this pull request Jan 9, 2025

repo: mandatory issue templates #8177

Closed

PerfectSlayer restored the tlhunter/create-issue-standard branch January 10, 2025 08:29

PerfectSlayer reopened this Jan 10, 2025

PerfectSlayer merged commit f4139b0 into master Jan 10, 2025
177 of 178 checks passed

PerfectSlayer deleted the tlhunter/create-issue-standard branch January 10, 2025 08:30

github-actions bot added this to the 1.46.0 milestone Jan 10, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Switch to mandatory issue templates #8106

Switch to mandatory issue templates #8106

tlhunter commented Dec 17, 2024 •

edited by jira bot

Loading

pr-commenter bot commented Dec 17, 2024 •

edited

Loading

PerfectSlayer Dec 18, 2024

tlhunter Dec 18, 2024

PerfectSlayer Dec 18, 2024

tlhunter Dec 18, 2024

PerfectSlayer Dec 23, 2024

ygree left a comment

		@@ -1,8 +1,8 @@
		blank_issues_enabled: true
		blank_issues_enabled: false

Switch to mandatory issue templates #8106

Switch to mandatory issue templates #8106

Conversation

tlhunter commented Dec 17, 2024 • edited by jira bot Loading

What Does This Do

Motivation

Additional Notes

Contributor Checklist

pr-commenter bot commented Dec 17, 2024 • edited Loading

Benchmarks

Startup

Load

Parameters

Summary

Dacapo

Parameters

Summary

PerfectSlayer Dec 18, 2024

Choose a reason for hiding this comment

tlhunter Dec 18, 2024

Choose a reason for hiding this comment

PerfectSlayer Dec 18, 2024

Choose a reason for hiding this comment

tlhunter Dec 18, 2024

Choose a reason for hiding this comment

PerfectSlayer Dec 23, 2024

Choose a reason for hiding this comment

ygree left a comment

Choose a reason for hiding this comment

tlhunter commented Dec 17, 2024 •

edited by jira bot

Loading

pr-commenter bot commented Dec 17, 2024 •

edited

Loading