The Prometheus monitoring system and time series database.
 
 
 
 
 
 
Go to file
György Krajcsovits 8c1b5a6251 Merge branch 'main' into nhcb-scrape-impl 2024-10-21 11:00:41 +02:00
.circleci
.github Bump actions/checkout from 4.1.6 to 4.2.0 (#15064) 2024-10-06 20:01:57 +02:00
cmd test(cmd/prometheus): speed up test execution by t.Parallel() when possible 2024-10-18 17:52:59 +02:00
config Merge branch 'main' into nhcb-scrape-impl 2024-10-21 11:00:41 +02:00
discovery Merge pull request #15170 from machine424/awldi 2024-10-18 17:33:08 +02:00
docs Merge pull request #15164 from machine424/quantile 2024-10-19 21:13:03 +02:00
documentation chore!: adopt log/slog, remove go-kit/log 2024-10-07 15:58:50 -04:00
model Merge branch 'main' into nhcb-scrape-impl 2024-10-21 11:00:41 +02:00
notifier Disallowing configure AM with the v1 api (#13883) 2024-10-18 15:23:14 +02:00
plugins
prompb regenerate pb files with new comment 2024-08-01 12:41:55 -07:00
promql scrape: provide a fallback format (#15136) 2024-10-18 17:12:31 +02:00
rules chore!: adopt log/slog, remove go-kit/log 2024-10-07 15:58:50 -04:00
scrape Merge branch 'main' into nhcb-scrape-impl 2024-10-21 11:00:41 +02:00
scripts Bump actions/checkout from 4.1.7 to 4.2.0 in /scripts 2024-10-01 23:46:13 +00:00
storage Merge pull request #15092 from jan--f/clarify-storage-contract 2024-10-09 13:07:59 +02: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 Fix populateWithDelChunkSeriesIterator corrupting chunk meta 2024-10-18 10:34:22 +02:00
util Merge pull request #15159 from prometheus/nhcb-scrape-optimize1 2024-10-16 10:25:18 +02:00
web Prepare 3.0.0-beta.1 2024-10-08 17:27:10 +01:00
.dockerignore
.gitignore ui build: create requires web/ui/static dir ad hoc 2024-09-09 18:30:00 +02:00
.gitpod.Dockerfile
.gitpod.yml
.golangci.yml chore!: adopt log/slog, remove go-kit/log 2024-10-07 15:58:50 -04:00
.promu.yml Merge branch 'main' into 3.0-main-sync-24-09-09 2024-09-09 15:44:22 +02:00
.yamllint
CHANGELOG.md scrape: provide a fallback format (#15136) 2024-10-18 17:12:31 +02:00
CODE_OF_CONDUCT.md
CONTRIBUTING.md
Dockerfile Remove console static files 2024-09-02 13:59:29 +02:00
LICENSE
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 Add support for running govulncheck (#12654) 2024-09-16 23:13:04 +02:00
NOTICE
README.md chore: Fix typos (#14868) 2024-09-10 22:32:03 +02:00
RELEASE.md Merge remote-tracking branch 'origin/release-2.55' into merge-2.55-into-main 2024-09-22 17:49:34 +01:00
SECURITY-INSIGHTS.yml chore: provide OSSF security insight 2024-07-31 06:36:02 +00:00
SECURITY.md
VERSION Prepare 3.0.0-beta.1 2024-10-08 17:27:10 +01:00
go.mod chore(deps): update client_golang from 1.20.4 to 1.20.5 2024-10-16 15:02:13 +02:00
go.sum chore(deps): update client_golang from 1.20.4 to 1.20.5 2024-10-16 15:02:13 +02:00
plugins.yml
ui-commits promql: rename holt_winters to double_exponential_smoothing 2024-09-19 15:29:01 +02:00

README.md

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 v2.y.z releases, we are publishing 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, v2.x.y will be displayed as v0.x.y.
  • 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.