The Prometheus monitoring system and time series database.
Find a file
dependabot[bot] 8b716e3f34
Some checks are pending
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 (0) (push) Waiting to run
CI / Build Prometheus for common architectures (1) (push) Waiting to run
CI / Build Prometheus for common architectures (2) (push) Waiting to run
CI / Build Prometheus for all architectures (0) (push) Waiting to run
CI / Build Prometheus for all architectures (1) (push) Waiting to run
CI / Build Prometheus for all architectures (10) (push) Waiting to run
CI / Build Prometheus for all architectures (11) (push) Waiting to run
CI / Build Prometheus for all architectures (2) (push) Waiting to run
CI / Build Prometheus for all architectures (3) (push) Waiting to run
CI / Build Prometheus for all architectures (4) (push) Waiting to run
CI / Build Prometheus for all architectures (5) (push) Waiting to run
CI / Build Prometheus for all architectures (6) (push) Waiting to run
CI / Build Prometheus for all architectures (7) (push) Waiting to run
CI / Build Prometheus for all architectures (8) (push) Waiting to run
CI / Build Prometheus for all architectures (9) (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
chore(deps-dev): bump vitest from 2.1.1 to 2.1.8 in /web/ui (#15591)
Bumps [vitest](https://github.com/vitest-dev/vitest/tree/HEAD/packages/vitest) from 2.1.1 to 2.1.8.
- [Release notes](https://github.com/vitest-dev/vitest/releases)
- [Commits](https://github.com/vitest-dev/vitest/commits/v2.1.8/packages/vitest)

---
updated-dependencies:
- dependency-name: vitest
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2024-12-11 15:41:17 +01:00
.circleci Move to github actions (#11235) 2022-09-05 23:09:41 +02:00
.github Add old UI to dependabot 2024-12-10 17:12:06 +01:00
cmd Merge pull request #15371 from bboreham/main-naming 2024-11-24 17:55:10 +00:00
config Lint fix 2024-11-29 15:19:45 +01:00
discovery Merge pull request #15227 from aniketnk/i15185_1 2024-12-05 10:48:26 +01:00
docs Merge pull request #15532 from machine424/nomad 2024-12-04 13:47:27 +01:00
documentation chore(deps): bump github.com/influxdata/influxdb (#15490) 2024-12-03 12:54:44 +01:00
model promql: Fix various UTF-8 bugs related to quoting 2024-12-04 14:18:59 -05:00
notifier notifier: fix increment of metric prometheus_notifications_errors_total 2024-11-26 15:50:02 +01:00
plugins remove obsolete build tag 2024-01-17 22:26:32 +08:00
prompb regenerate pb files with new comment 2024-08-01 12:41:55 -07:00
promql Merge pull request #15531 from prometheus/owilliams/promqltest 2024-12-10 17:45:10 +01:00
rules rules.NewGroup: Fix when no logger is passed (#15356) 2024-11-21 16:53:06 +01:00
scrape Merge pull request #15563 from GiedriusS/fix_setting_field 2024-12-10 15:33:56 +00:00
scripts Upgrade to golangci-lint v1.62.0 (#15424) 2024-11-20 17:22:20 +01:00
storage OTLP receiver: Use stdlib for splitting metric name in classical mode (#15573) 2024-12-11 15:12:53 +01:00
template lint: Revamp our linting rules, mostly around doc comments 2024-08-22 17:36:11 +02:00
tracing chore!: adopt log/slog, remove go-kit/log 2024-10-07 15:58:50 -04:00
tsdb docs: Added native histogram WAL record documentation. 2024-12-09 11:47:28 +00:00
util fix(deduper): use ptr to sync.RWMutex, fix panic during concurrent use 2024-12-10 02:51:46 -05:00
web chore(deps-dev): bump vitest from 2.1.1 to 2.1.8 in /web/ui (#15591) 2024-12-11 15:41:17 +01:00
.dockerignore Add image build for ppc64le architecture 2020-04-06 18:03:58 -03:00
.gitignore ui build: create requires web/ui/static dir ad hoc 2024-09-09 18:30:00 +02:00
.gitpod.Dockerfile .gitpod.Dockerfile: Auto-fetch Go and goyacc vers 2024-05-24 09:17:18 +03:00
.gitpod.yml fix gitpod by using custome dockerfile and accurate npm ui path 2021-09-27 18:59:41 +02:00
.golangci.yml enable errorf rule from perfsprint linter 2024-11-06 16:50:36 +01:00
.promu.yml Merge branch 'main' into 3.0-main-sync-24-09-09 2024-09-09 15:44:22 +02:00
.yamllint Update linting (#15369) 2024-11-12 13:27:39 +01:00
CHANGELOG.md Merge pull request #15428 from prometheus/beorn7/metrics 2024-11-26 17:38:59 +01:00
CODE_OF_CONDUCT.md Update link for referenced CNCF code of conduct (#10664) 2022-05-03 18:32:23 +02:00
CONTRIBUTING.md Merge branch 'main' into mcarl/lint 2024-05-24 14:56:51 +02:00
Dockerfile Add image source label to dockerfiles 2024-10-08 11:53:51 +02:00
go.mod chore(deps): bump google.golang.org/grpc from 1.67.1 to 1.68.1 (#15576) 2024-12-11 01:32:31 +01:00
go.sum chore(deps): bump google.golang.org/grpc from 1.67.1 to 1.68.1 (#15576) 2024-12-11 01:32:31 +01:00
LICENSE Clean up license issues. 2015-01-21 20:07:45 +01:00
MAINTAINERS.md MAINTAINERS: Add Arthur as an otlptranslator maintainer (#15024) 2024-10-01 15:15:21 +02:00
Makefile makefile: Add support for skipping UI build when prebuilt assets are provided 2024-09-12 12:20:24 +02:00
Makefile.common Upgrade to golangci-lint v1.62.0 (#15424) 2024-11-20 17:22:20 +01:00
NOTICE Add license notice for code adapted from Go 2021-12-05 09:01:52 +01:00
plugins.yml fix: The automatically generated file is inconsistent with the file in the code warehouse 2023-11-20 17:57:43 +08:00
README.md docs: update README with v3 tagging update (#15361) 2024-11-20 16:46:11 +01:00
RELEASE.md RELEASE.md: schedule 3.[1,2,3,4] releases 2024-12-09 19:25:17 +01:00
SECURITY-INSIGHTS.yml chore: provide OSSF security insight 2024-07-31 06:36:02 +00:00
SECURITY.md fix markdown lint issues (#10591) 2022-05-03 10:59:09 +02:00
ui-commits promql: rename holt_winters to double_exponential_smoothing 2024-09-19 15:29:01 +02:00
VERSION prepare release 3.0.0 2024-11-13 15:41:05 +01:00

Prometheus
Prometheus

Visit prometheus.io for the full documentation, examples and guides.

CI Docker Repository on Quay Docker Pulls Go Report Card CII Best Practices OpenSSF Scorecard CLOMonitor Gitpod ready-to-code Fuzzing Status

Prometheus, a Cloud Native Computing Foundation project, is a systems and service monitoring system. It collects metrics from configured targets at given intervals, evaluates rule expressions, displays the results, and can trigger alerts when specified conditions are observed.

The features that distinguish Prometheus from other metrics and monitoring systems are:

  • A multi-dimensional data model (time series defined by metric name and set of key/value dimensions)
  • PromQL, a powerful and flexible query language to leverage this dimensionality
  • No dependency on distributed storage; single server nodes are autonomous
  • An HTTP pull model for time series collection
  • Pushing time series is supported via an intermediary gateway for batch jobs
  • Targets are discovered via service discovery or static configuration
  • Multiple modes of graphing and dashboarding support
  • Support for hierarchical and horizontal federation

Architecture overview

Architecture overview

Install

There are various ways of installing Prometheus.

Precompiled binaries

Precompiled binaries for released versions are available in the download section on prometheus.io. Using the latest production release binary is the recommended way of installing Prometheus. See the Installing chapter in the documentation for all the details.

Docker images

Docker images are available on Quay.io or Docker Hub.

You can launch a Prometheus container for trying it out with

docker run --name prometheus -d -p 127.0.0.1:9090:9090 prom/prometheus

Prometheus will now be reachable at http://localhost:9090/.

Building from source

To build Prometheus from source code, You need:

Start by cloning the repository:

git clone https://github.com/prometheus/prometheus.git
cd prometheus

You can use the go tool to build and install the prometheus and promtool binaries into your GOPATH:

GO111MODULE=on go install github.com/prometheus/prometheus/cmd/...
prometheus --config.file=your_config.yml

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 web/ui/templates. In order for these assets to be found, you will have to run Prometheus from the root of the cloned repository. Note also that these directories do not include the React UI unless it has been built explicitly using make assets or make build.

An example of the above configuration file can be found here.

You can also build using make build, which will compile in the web assets so that Prometheus can be run from anywhere:

make build
./prometheus --config.file=your_config.yml

The Makefile provides several targets:

  • build: build the prometheus and promtool binaries (includes building and compiling in web assets)
  • test: run the tests
  • test-short: run the short tests
  • format: format the source code
  • vet: check the source code for common errors
  • assets: build the React UI

Service discovery plugins

Prometheus is bundled with many service discovery plugins. When building Prometheus from source, you can edit the plugins.yml file to disable some service discoveries. The file is a yaml-formatted list of go import path that will be built into the Prometheus binary.

After you have changed the file, you need to run make build again.

If you are using another method to compile Prometheus, make plugins will generate the plugins file accordingly.

If you add out-of-tree plugins, which we do not endorse at the moment, additional steps might be needed to adjust the go.mod and go.sum files. As always, be extra careful when loading third party code.

Building the Docker image

The make docker target is designed for use in our CI system. You can build a docker image locally with the following commands:

make promu
promu crossbuild -p linux/amd64
make npm_licenses
make common-docker-amd64

Using Prometheus as a Go Library

Remote Write

We are publishing our Remote Write protobuf independently at buf.build.

You can use that as a library:

go get buf.build/gen/go/prometheus/prometheus/protocolbuffers/go@latest

This is experimental.

Prometheus code base

In order to comply with go mod rules, Prometheus release number do not exactly match Go module releases.

For the Prometheus v3.y.z releases, we are publishing equivalent v0.3y.z tags. The y in v0.3y.z is always padded to two digits, with a leading zero if needed.

Therefore, a user that would want to use Prometheus v3.0.0 as a library could do:

go get github.com/prometheus/prometheus@v0.300.0

For the Prometheus v2.y.z releases, we published the equivalent v0.y.z tags.

Therefore, a user that would want to use Prometheus v2.35.0 as a library could do:

go get github.com/prometheus/prometheus@v0.35.0

This solution makes it clear that we might break our internal Go APIs between minor user-facing releases, as breaking changes are allowed in major version zero.

React UI Development

For more information on building, running, and developing on the React-based UI, see the React app's README.md.

More information

  • Godoc documentation is available via pkg.go.dev. Due to peculiarities of Go Modules, v3.y.z will be displayed as v0.3y.z (the y in v0.3y.z is always padded to two digits, with a leading zero if needed), while v2.y.z will be displayed as v0.y.z.
  • See the Community page for how to reach the Prometheus developers and users on various communication channels.

Contributing

Refer to CONTRIBUTING.md

License

Apache License 2.0, see LICENSE.