mirror of
https://github.com/prometheus/prometheus.git
synced 2026-02-03 20:39:32 -05:00
docs: Fix inaccuracies in root markdown files (#17433)
Some checks failed
buf.build / lint and publish (push) Waiting to run
CI / Go tests (push) Waiting to run
CI / More Go tests (push) Waiting to run
CI / Go tests with previous Go version (push) Waiting to run
CI / UI tests (push) Waiting to run
CI / Go tests on Windows (push) Waiting to run
CI / Mixins tests (push) Waiting to run
CI / Build Prometheus for common architectures (push) Waiting to run
CI / Build Prometheus for all architectures (push) Waiting to run
CI / Report status of build Prometheus for all architectures (push) Blocked by required conditions
CI / Check generated parser (push) Waiting to run
CI / golangci-lint (push) Waiting to run
CI / fuzzing (push) Waiting to run
CI / codeql (push) Waiting to run
CI / Publish main branch artifacts (push) Blocked by required conditions
CI / Publish release artefacts (push) Blocked by required conditions
CI / Publish UI on npm Registry (push) Blocked by required conditions
Scorecards supply-chain security / Scorecards analysis (push) Waiting to run
Push README to Docker Hub / Push README to Docker Hub (push) Has been cancelled
Push README to Docker Hub / Push README to quay.io (push) Has been cancelled
Some checks failed
buf.build / lint and publish (push) Waiting to run
CI / Go tests (push) Waiting to run
CI / More Go tests (push) Waiting to run
CI / Go tests with previous Go version (push) Waiting to run
CI / UI tests (push) Waiting to run
CI / Go tests on Windows (push) Waiting to run
CI / Mixins tests (push) Waiting to run
CI / Build Prometheus for common architectures (push) Waiting to run
CI / Build Prometheus for all architectures (push) Waiting to run
CI / Report status of build Prometheus for all architectures (push) Blocked by required conditions
CI / Check generated parser (push) Waiting to run
CI / golangci-lint (push) Waiting to run
CI / fuzzing (push) Waiting to run
CI / codeql (push) Waiting to run
CI / Publish main branch artifacts (push) Blocked by required conditions
CI / Publish release artefacts (push) Blocked by required conditions
CI / Publish UI on npm Registry (push) Blocked by required conditions
Scorecards supply-chain security / Scorecards analysis (push) Waiting to run
Push README to Docker Hub / Push README to Docker Hub (push) Has been cancelled
Push README to Docker Hub / Push README to quay.io (push) Has been cancelled
* docs: Fix inaccuracies in root markdown files - Update npm requirement from v8 to v10 in README - Remove obsolete GO111MODULE references - Correct formatting issues and typos in CHANGELOG - Fix maintainer entry formatting in MAINTAINERS - Update outdated URLs in CONTRIBUTING --------- Signed-off-by: Joshua Shanks <jjshanks@gmail.com> Co-authored-by: Arve Knudsen <arve.knudsen@gmail.com>
This commit is contained in:
parent
48e6f6a751
commit
ec539d0929
4 changed files with 14 additions and 15 deletions
10
CHANGELOG.md
10
CHANGELOG.md
|
|
@ -240,7 +240,7 @@
|
||||||
|
|
||||||
## 3.2.1 / 2025-02-25
|
## 3.2.1 / 2025-02-25
|
||||||
|
|
||||||
* [BUGFIX] Don't send Accept` header `escape=allow-utf-8` when `metric_name_validation_scheme: legacy` is configured. #16061
|
* [BUGFIX] Don't send `Accept` header `escape=allow-utf-8` when `metric_name_validation_scheme: legacy` is configured. #16061
|
||||||
|
|
||||||
## 3.2.0 / 2025-02-17
|
## 3.2.0 / 2025-02-17
|
||||||
|
|
||||||
|
|
@ -251,10 +251,10 @@
|
||||||
* [ENHANCEMENT] scrape: Add metadata for automatic metrics to WAL for `metadata-wal-records` feature. #15837
|
* [ENHANCEMENT] scrape: Add metadata for automatic metrics to WAL for `metadata-wal-records` feature. #15837
|
||||||
* [ENHANCEMENT] promtool: Support linting of scrape interval, through lint option `too-long-scrape-interval`. #15719
|
* [ENHANCEMENT] promtool: Support linting of scrape interval, through lint option `too-long-scrape-interval`. #15719
|
||||||
* [ENHANCEMENT] promtool: Add --ignore-unknown-fields option. #15706
|
* [ENHANCEMENT] promtool: Add --ignore-unknown-fields option. #15706
|
||||||
* [ENHANCEMENT] ui: Make "hide empty rules" and hide empty rules" persistent #15807
|
* [ENHANCEMENT] ui: Make "hide empty rules" and "hide empty rules" persistent #15807
|
||||||
* [ENHANCEMENT] web/api: Add a limit parameter to `/query` and `/query_range`. #15552
|
* [ENHANCEMENT] web/api: Add a limit parameter to `/query` and `/query_range`. #15552
|
||||||
* [ENHANCEMENT] api: Add fields Node and ServerTime to `/status`. #15784
|
* [ENHANCEMENT] api: Add fields Node and ServerTime to `/status`. #15784
|
||||||
* [PERF] Scraping: defer computing labels for dropped targets until they are needed by the UI. #15261
|
* [PERF] Scraping: defer computing labels for dropped targets until they are needed by the UI. #15261
|
||||||
* [BUGFIX] remotewrite2: Fix invalid metadata bug for metrics without metadata. #15829
|
* [BUGFIX] remotewrite2: Fix invalid metadata bug for metrics without metadata. #15829
|
||||||
* [BUGFIX] remotewrite2: Fix the unit field propagation. #15825
|
* [BUGFIX] remotewrite2: Fix the unit field propagation. #15825
|
||||||
* [BUGFIX] scrape: Fix WAL metadata for histograms and summaries. #15832
|
* [BUGFIX] scrape: Fix WAL metadata for histograms and summaries. #15832
|
||||||
|
|
@ -271,9 +271,9 @@
|
||||||
* [ENHANCEMENT] TSDB: Improve calculation of space used by labels. #13880
|
* [ENHANCEMENT] TSDB: Improve calculation of space used by labels. #13880
|
||||||
* [ENHANCEMENT] Rules: new metric rule_group_last_rule_duration_sum_seconds. #15672
|
* [ENHANCEMENT] Rules: new metric rule_group_last_rule_duration_sum_seconds. #15672
|
||||||
* [ENHANCEMENT] Observability: Export 'go_sync_mutex_wait_total_seconds_total' metric. #15339
|
* [ENHANCEMENT] Observability: Export 'go_sync_mutex_wait_total_seconds_total' metric. #15339
|
||||||
* [ENHANCEMEN] Remote-Write: optionally use a DNS resolver that picks a random IP. #15329
|
* [ENHANCEMENT] Remote-Write: optionally use a DNS resolver that picks a random IP. #15329
|
||||||
* [PERF] Optimize `l=~".+"` matcher. #15474, #15684
|
* [PERF] Optimize `l=~".+"` matcher. #15474, #15684
|
||||||
* [PERF] TSDB: Cache all symbols for compaction . #15455
|
* [PERF] TSDB: Cache all symbols for compaction. #15455
|
||||||
* [PERF] TSDB: MemPostings: keep a map of label values slices. #15426
|
* [PERF] TSDB: MemPostings: keep a map of label values slices. #15426
|
||||||
* [PERF] Remote-Write: Remove interning hook. #15456
|
* [PERF] Remote-Write: Remove interning hook. #15456
|
||||||
* [PERF] Scrape: optimize string manipulation for experimental native histograms with custom buckets. #15453
|
* [PERF] Scrape: optimize string manipulation for experimental native histograms with custom buckets. #15453
|
||||||
|
|
|
||||||
|
|
@ -14,7 +14,7 @@ Prometheus uses GitHub to manage reviews of pull requests.
|
||||||
of inspiration. Also please see our [non-goals issue](https://github.com/prometheus/docs/issues/149) on areas that the Prometheus community doesn't plan to work on.
|
of inspiration. Also please see our [non-goals issue](https://github.com/prometheus/docs/issues/149) on areas that the Prometheus community doesn't plan to work on.
|
||||||
|
|
||||||
* Relevant coding style guidelines are the [Go Code Review
|
* Relevant coding style guidelines are the [Go Code Review
|
||||||
Comments](https://code.google.com/p/go-wiki/wiki/CodeReviewComments)
|
Comments](https://go.dev/wiki/CodeReviewComments)
|
||||||
and the _Formatting and style_ section of Peter Bourgon's [Go: Best
|
and the _Formatting and style_ section of Peter Bourgon's [Go: Best
|
||||||
Practices for Production
|
Practices for Production
|
||||||
Environments](https://peter.bourgon.org/go-in-production/#formatting-and-style).
|
Environments](https://peter.bourgon.org/go-in-production/#formatting-and-style).
|
||||||
|
|
@ -78,8 +78,7 @@ go get example.com/some/module/pkg@vX.Y.Z
|
||||||
Tidy up the `go.mod` and `go.sum` files:
|
Tidy up the `go.mod` and `go.sum` files:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# The GO111MODULE variable can be omitted when the code isn't located in GOPATH.
|
go mod tidy
|
||||||
GO111MODULE=on go mod tidy
|
|
||||||
```
|
```
|
||||||
|
|
||||||
You have to commit the changes to `go.mod` and `go.sum` before submitting the pull request.
|
You have to commit the changes to `go.mod` and `go.sum` before submitting the pull request.
|
||||||
|
|
|
||||||
|
|
@ -18,12 +18,12 @@ Maintainers for specific parts of the codebase:
|
||||||
* `model/histogram` and other code related to native histograms: Björn Rabenstein (<beorn@grafana.com> / @beorn7),
|
* `model/histogram` and other code related to native histograms: Björn Rabenstein (<beorn@grafana.com> / @beorn7),
|
||||||
George Krajcsovits (<gyorgy.krajcsovits@grafana.com> / @krajorama)
|
George Krajcsovits (<gyorgy.krajcsovits@grafana.com> / @krajorama)
|
||||||
* `storage`
|
* `storage`
|
||||||
* `remote`: Callum Styan (<callumstyan@gmail.com> / @cstyan), Bartłomiej Płotka (<bwplotka@gmail.com> / @bwplotka), Tom Wilkie (tom.wilkie@gmail.com / @tomwilkie), Nicolás Pazos ( <npazosmendez@gmail.com> / @npazosmendez), Alex Greenbank ( <alexgreenbank@yahoo.com> / @alexgreenbank)
|
* `remote`: Callum Styan (<callumstyan@gmail.com> / @cstyan), Bartłomiej Płotka (<bwplotka@gmail.com> / @bwplotka), Tom Wilkie (tom.wilkie@gmail.com / @tomwilkie), Nicolás Pazos (<npazosmendez@gmail.com> / @npazosmendez), Alex Greenbank (<alexgreenbank@yahoo.com> / @alexgreenbank)
|
||||||
* `otlptranslator`: Arthur Silva Sens (<arthursens2005@gmail.com> / @ArthurSens), Arve Knudsen (<arve.knudsen@gmail.com> / @aknuds1), Jesús Vázquez (<jesus.vazquez@grafana.com> / @jesusvazquez)
|
* `otlptranslator`: Arthur Silva Sens (<arthursens2005@gmail.com> / @ArthurSens), Arve Knudsen (<arve.knudsen@gmail.com> / @aknuds1), Jesús Vázquez (<jesus.vazquez@grafana.com> / @jesusvazquez)
|
||||||
* `tsdb`: Ganesh Vernekar (<ganesh@grafana.com> / @codesome), Bartłomiej Płotka (<bwplotka@gmail.com> / @bwplotka), Jesús Vázquez (<jesus.vazquez@grafana.com> / @jesusvazquez), George Krajcsovits (<gyorgy.krajcsovits@grafana.com> / @krajorama)
|
* `tsdb`: Ganesh Vernekar (<ganesh@grafana.com> / @codesome), Bartłomiej Płotka (<bwplotka@gmail.com> / @bwplotka), Jesús Vázquez (<jesus.vazquez@grafana.com> / @jesusvazquez), George Krajcsovits (<gyorgy.krajcsovits@grafana.com> / @krajorama)
|
||||||
* `web`
|
* `web`
|
||||||
* `ui`: Julius Volz (<julius.volz@gmail.com> / @juliusv)
|
* `ui`: Julius Volz (<julius.volz@gmail.com> / @juliusv)
|
||||||
* `module`: Augustin Husson (<husson.augustin@gmail.com> @nexucis)
|
* `module`: Augustin Husson (<husson.augustin@gmail.com> / @nexucis)
|
||||||
* `Makefile` and related build configuration: Simon Pasquier (<pasquier.simon@gmail.com> / @simonpasquier), Ben Kochie (<superq@gmail.com> / @SuperQ)
|
* `Makefile` and related build configuration: Simon Pasquier (<pasquier.simon@gmail.com> / @simonpasquier), Ben Kochie (<superq@gmail.com> / @SuperQ)
|
||||||
|
|
||||||
For the sake of brevity, not all subtrees are explicitly listed. Due to the
|
For the sake of brevity, not all subtrees are explicitly listed. Due to the
|
||||||
|
|
|
||||||
10
README.md
10
README.md
|
|
@ -69,7 +69,7 @@ To build Prometheus from source code, You need:
|
||||||
|
|
||||||
* Go: Version specified in [go.mod](./go.mod) or greater.
|
* Go: Version specified in [go.mod](./go.mod) or greater.
|
||||||
* NodeJS: Version specified in [.nvmrc](./web/ui/.nvmrc) or greater.
|
* NodeJS: Version specified in [.nvmrc](./web/ui/.nvmrc) or greater.
|
||||||
* npm: Version 8 or greater (check with `npm --version` and [here](https://www.npmjs.com/)).
|
* npm: Version 10 or greater (check with `npm --version` and [here](https://www.npmjs.com/)).
|
||||||
|
|
||||||
Start by cloning the repository:
|
Start by cloning the repository:
|
||||||
|
|
||||||
|
|
@ -87,10 +87,10 @@ prometheus --config.file=your_config.yml
|
||||||
```
|
```
|
||||||
|
|
||||||
*However*, when using `go install` to build Prometheus, Prometheus will expect to be able to
|
*However*, when using `go install` to build Prometheus, Prometheus will expect to be able to
|
||||||
read its web assets from local filesystem directories under `web/ui/static` and
|
read its web assets from local filesystem directories under `web/ui/static`. In order for
|
||||||
`web/ui/templates`. In order for these assets to be found, you will have to run Prometheus
|
these assets to be found, you will have to run Prometheus from the root of the cloned
|
||||||
from the root of the cloned repository. Note also that these directories do not include the
|
repository. Note also that this directory does not include the React UI unless it has been
|
||||||
React UI unless it has been built explicitly using `make assets` or `make build`.
|
built explicitly using `make assets` or `make build`.
|
||||||
|
|
||||||
An example of the above configuration file can be found [here.](https://github.com/prometheus/prometheus/blob/main/documentation/examples/prometheus.yml)
|
An example of the above configuration file can be found [here.](https://github.com/prometheus/prometheus/blob/main/documentation/examples/prometheus.yml)
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue