Skip to content

Commit 7d2b79c

Browse files
author
beorn7
committed
Add documentation about TTL and GH issues
- Add an issue template similar to other repos. - Add TTL for metrics as a non-goal. Signed-off-by: beorn7 <[email protected]>
1 parent 0c09aab commit 7d2b79c

File tree

2 files changed

+61
-0
lines changed

2 files changed

+61
-0
lines changed

.github/ISSUE_TEMPLATE.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
<!--
2+
3+
Note that we use GitHub issues for bugs and (uncontroversial) feature
4+
requests (see below for details).
5+
6+
Please do *NOT* ask usage questions in GitHub issues. Usage questions make
7+
most sense on the users mailing list, where more people are available to
8+
potentially respond to your question, and the whole community can benefit
9+
from the answers provided (perhaps your question has already been answered,
10+
search the archive to find out):
11+
https://groups.google.com/forum/#!forum/prometheus-users
12+
13+
While a GitHub issue is fine to track progress on an uncontroversial
14+
feature request, many feature requests touch the best practices and
15+
concepts of Prometheus as a whole and need to be discussed with the wider
16+
developer community first. This is in particular true for a request to
17+
reconsider a prior rejection of a feature request or any of the declared
18+
non-goals (see README.md). Those overarching discussions happen on the
19+
developer mailing list (GitHub issues, in particular closed ones, are not
20+
tracked by the wider developer community and thus inadequate):
21+
https://groups.google.com/forum/#!forum/prometheus-developers
22+
23+
You can find more information at: https://prometheus.io/community/
24+
25+
-->
26+
27+
## Feature request
28+
**Use case. Why is this important?**
29+
30+
*Nice to have' is not a good use case :)*
31+
32+
## Bug Report
33+
**What did you do?**
34+
35+
**What did you expect to see?**
36+
37+
**What did you see instead? Under which circumstances?**
38+
39+
**Environment**
40+
41+
* System information:
42+
43+
insert output of `uname -srm` here
44+
45+
* Pushgateway version:
46+
47+
insert output of `pushgateway --version` here
48+
49+
* Pushgateway command line:
50+
51+
insert full command line
52+
53+
* Logs:
54+
```
55+
insert Puhsgateway logs relevant to the issue here
56+
```

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,11 @@ source for
2929
[Grafana annotations](http://docs.grafana.org/reference/annotations/), tracking
3030
something like release events has to happen with some event-logging framework.
3131

32+
A while ago, we
33+
[decided to not implement a “timeout” or TTL for pushed metrics](https://github.com/prometheus/pushgateway/issues/19)
34+
because almost all proposed use cases turned out to be anti-patterns we
35+
strongly discourage.
36+
3237
## Run it
3338

3439
Download binary releases for your platform from the

0 commit comments

Comments
 (0)