Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 43 additions & 0 deletions content/docs/introduction/design-doc.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
title: Design Documents
sort_rank: 7
---

# Design documents

When contributing large changes or features to the Prometheus ecosystem, design
documents are written by individuals or groups. Those documents are proposed for
review and approval to the community.

This page is a list of the design documents we know of. If you create a new
design document, or some documents are not listed, please open a [pull
request](https://github.com/prometheus/docs/) to add it to this list.

Design docs do not always reflect exactly what has been implemented, and
implementation details might have changed since a feature was merged. Design
docs are not considered documentation and can not define a standard.

If you want to pick a design doc in `TODO` or implement a proposed design doc,
please reach out to the [developers mailing list](/community) first to make sure
no one else has picked that task already, and the design doc is approved and
still relevant.

| Document | Initial date | Status | Pull requests |
| -------- | ------------ | ------ | ------------- |
| [Secure Alertmanager cluster traffic](https://github.com/prometheus/alertmanager/blob/master/doc/design/secure-cluster-traffic.md) | 2019‑02‑21 | Approved | [alertmanager#2237](https://github.com/prometheus/alertmanager/pull/2237) |
| TSDB Head Improvements ([part1](https://docs.google.com/document/d/184urkLQnM7rqLmGvS66I15jU2pyPk_qwd8v_qDlXczo/edit#heading=h.ow34omg0frla) - [part 2](https://docs.google.com/document/d/1pnEsxB0CDLOxQipGw_vhkJpoDZfZPs_KjqCriumDAXQ/edit#heading=h.qsf5sgqoqemc)) | 2019‑12‑09 | Partially implemented | |
| [Persist Retroactive Rules](https://docs.google.com/document/d/16s_-RxYwQYcb4G4mvpmjPolEbD24o54a1LPqJ538Vhc/edit) | 2020‑06‑12 | Partially implemented | [#7675](https://github.com/prometheus/prometheus/pull/7675) |
| [topk/bottomk aggregation over time](https://docs.google.com/document/d/1uSbD3T2beM-iX4-Hp7V074bzBRiRNlqUdcWP6JTDQSs/edit) | 2020‑09‑30 | Implemented | [#8121](https://github.com/prometheus/prometheus/pull/8121) [#8425](https://github.com/prometheus/prometheus/pull/8425) |
| [http\_sd\_configs](https://docs.google.com/document/d/1tVeuzjpU4-TiYPNWJXKmcyIuZF6A2tUq270RbBT5zho/edit) | 2021‑02‑26 | Under review | [#8839](https://github.com/prometheus/prometheus/pull/8839) |
| [prometheus/client\_java & micrometer](https://docs.google.com/document/d/1vROky2aIw3kAllfi95gwDJy5P2DyWnCihsjPXGpLwwo/edit#) | 2021‑02‑26 | Under review | |
| [First-class network monitoring support in the Prometheus & Grafana ecosystem](https://docs.google.com/document/d/1oEpjiWfTHF352NCAOGolwij3EIkrprCkdQmaQMpjg4M/edit) | 2021‑02‑25 | Under review | |
| [Configuration handling in exporters and Prometheus 3.x](https://docs.google.com/document/d/1BK_Gc3ixoWyxr9F5qGC07HEcfDPtb6z96mfqoGyz52Y/edit#heading=h.zcana55kzmxi) | 2021‑03‑29 | Under review | |
| [Prometheus Agent](https://docs.google.com/document/d/1cCcoFgjDFwU2n823tKuMvrIhzHty4UDyn0IcfUHiyyI/edit) | 2021‑01‑27 | Approved | [#8785](https://github.com/prometheus/prometheus/pull/8785) |
| [Sparse high-resolution histograms](https://docs.google.com/document/d/1cLNv3aufPZb3fNfaJgdaRBZsInZKKIHo9E6HinJVbpM/edit) | 2021‑02‑10 | Approved | |
| [Prometheus timezones support](https://docs.google.com/document/d/1xfw1Lb1GIRZB_-4iFVGkgwnpwuBemWfxYqFdBm7APsE/edit#) | 2021‑05‑29 | Proposed | |
| [Moving to goreleaser](https://docs.google.com/document/d/16LOT2wK-jntlU-EFADfaEF3YbKH81U9Zl_PvSu4qVwo/edit#heading=h.bupciudrwmna) | 2021‑06‑05 | Proposed |
| [Alertmanager Log Receiver](https://docs.google.com/document/d/1Oevu2stHVGAupzmc9C7_wW5nTb_CJ6Ut72viXfve6zI/edit?usp=sharing) | 2021‑06‑10 | Proposed |
| [Metadata](https://docs.google.com/document/d/1XiZePSjwU4X5iaIgCIvLzljJzl8lRAdvputuborUcaQ/edit) | | TODO | |
| OpenMetrics transition | | TODO | |
| Semantics of muting in Alertmanager | | TODO | |
| Extrapolation in range selectors (xrange) | | TODO | |
2 changes: 1 addition & 1 deletion content/docs/introduction/glossary.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Glossary
sort_rank: 8
sort_rank: 9
---

# Glossary
Expand Down
2 changes: 1 addition & 1 deletion content/docs/introduction/media.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Media
sort_rank: 7
sort_rank: 8
---

# Media
Expand Down