Skip to content

Commit a278550

Browse files
committed
.github: issue template for telemetry proposals
This uses the github's newer template syntax. https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms See https://github.com/hyangah/go/issues/new?assignees=&labels=Telemetry-Proposal&projects=hyangah%2F3&template=12-telemetry.yml&title=x%2Ftelemetryconfig%3A+ for demo. Change-Id: I13105711b1fe97680b505eefa1f0e7082e76e92c Reviewed-on: https://go-review.googlesource.com/c/go/+/528357 Run-TryBot: Hyang-Ah Hana Kim <[email protected]> TryBot-Result: Gopher Robot <[email protected]> Reviewed-by: Robert Findley <[email protected]>
1 parent e356aa6 commit a278550

File tree

1 file changed

+68
-0
lines changed

1 file changed

+68
-0
lines changed
+68
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
name: Go Telemetry Proposals
2+
description: New telemetry counter or update on an existing one
3+
title: "x/telemetry/config: "
4+
labels: ["Telemetry-Proposal"]
5+
projects: ["golang/29"]
6+
body:
7+
- type: textarea
8+
attributes:
9+
label: Counter names
10+
description: Names of counters to add or update.
11+
validations:
12+
required: true
13+
- type: textarea
14+
attributes:
15+
label: Description
16+
description: What do these counters measure?
17+
validations:
18+
required: true
19+
- type: textarea
20+
attributes:
21+
label: Rationale
22+
description: |
23+
Why is the counter important?
24+
For example, what new insights will it provide, and how will that information be used?
25+
If this is about updating existing counters, why is the change necessary?
26+
validations:
27+
required: true
28+
- type: textarea
29+
attributes:
30+
label: Do the counters carry sensitive user information?
31+
validations:
32+
required: true
33+
- type: textarea
34+
attributes:
35+
label: How?
36+
description: |
37+
How do we plan to compute the info?
38+
If available, include the code location or cl that uses the golang.org/x/telemetry/counter API.
39+
validations:
40+
required: true
41+
- type: textarea
42+
attributes:
43+
label: Proposed Graph Config
44+
description: |
45+
Approved telemetry counters are maintained as [Go Telemetry Graph Config](https://golang.org/x/telemetry/internal/graphconfig) records.
46+
Please draft the record entry for your proposal here.
47+
If multiple records need to be included, separate them with `---` lines.
48+
You can check the list of the approved counters and their current configuration in [config.txt](https://go.googlesource.com/telemetry/+/master/internal/configgen/config.txt).
49+
render: Text
50+
value: |
51+
counter: gopls/bug
52+
title: Gopls bug reports
53+
description: Stacks of bugs encountered on the gopls server.
54+
type: partition, histogram, stack # choose only one.
55+
program: golang.org/x/tools/gopls
56+
counter: gopls/bug
57+
depth: 16 # only if type is stack.
58+
version: v0.13.0 # the first binary version containing this counter.
59+
validations:
60+
required: true
61+
- type: dropdown
62+
attributes:
63+
label: New or Update
64+
description: Is this a new counter? See [config.txt](https://go.googlesource.com/telemetry/+/master/internal/configgen/config.txt) for the list of approved counters.
65+
options:
66+
- New
67+
- Update
68+
default: 0

0 commit comments

Comments
 (0)