The Prometheus monitoring system and time series database.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
Bryan Boreham 95b3c49836
[TESTS] remote-write: fix slice init length (#14702)
3 months ago
.circleci Move to github actions (#11235) 2 years ago
.github Upgrade golangci-lint to v1.60.2 3 months ago
cmd Upgrade golangci-lint to v1.60.1 3 months ago
config feat(utf8): utf8 content negotation and flags 3 months ago
console_libraries Make React UI the default, keep old UI under /classic (#8142) 4 years ago
consoles consoles: exclude iowait and steal from CPU Utilisation 3 years ago
discovery Upgrade golangci-lint to v1.60.1 3 months ago
docs Merge pull request #14673 from machine424/docdoccc 3 months ago
documentation fix: fixed the vulnerability 3 months ago
model textparse: Implement `CreatedTimestamp()` in `openmetricsparse.go` (#14356) 4 months ago
notifier Merge pull request #14661 from prymitive/TestHangingNotifier 3 months ago
plugins remove obsolete build tag 10 months ago
prompb regenerate pb files with new comment 4 months ago
promql Merge pull request #14655 from suntala/suntala/sort-by-label-enhancement 3 months ago
rules feat: add Google cloud roundtripper for remote write (#14346) 4 months ago
scrape Include test CA text info (#14699) 3 months ago
scripts Upgrade golangci-lint to v1.60.2 3 months ago
storage [TESTS] remote-write: fix slice init length (#14702) 3 months ago
template Upgrade golangci-lint to v1.60.2 3 months ago
tracing Include test CA text info (#14699) 3 months ago
tsdb [BUGFIX] TSDB: Fix query overlapping in-order and ooo head (#14693) 3 months ago
util Upgrade golangci-lint to v1.60.1 3 months ago
web Update web/web.go 3 months ago
.dockerignore Add image build for ppc64le architecture 5 years ago
.gitignore Merge pull request #12057 from hdost/add-parser-documentation 2 years ago
.gitpod.Dockerfile .gitpod.Dockerfile: Auto-fetch Go and goyacc vers 6 months ago
.gitpod.yml fix gitpod by using custome dockerfile and accurate npm ui path 3 years ago
.golangci.yml golangci-lint: Don't use deprecated config params 4 months ago
.promu.yml chore(ci): Run all tests on the oldest golang version 9 months ago
.yamllint Fix yaml file format and clear ci errors 8 months ago
CHANGELOG.md OTLP receiver: Warn when encountering invalid exponential histograms 3 months ago
CODE_OF_CONDUCT.md Update link for referenced CNCF code of conduct (#10664) 3 years ago
CONTRIBUTING.md Merge branch 'main' into mcarl/lint 6 months ago
Dockerfile Dockerfile: Optimize and consolidate steps (#9180) 3 years ago
LICENSE Clean up license issues. 10 years ago
MAINTAINERS.md MAINTAINERS.md: Added Nico and Alex as remote/storage owners. (#14352) 5 months ago
Makefile Fix @goyacc invocation (#14324) 5 months ago
Makefile.common Upgrade golangci-lint to v1.60.2 3 months ago
NOTICE Add license notice for code adapted from Go 3 years ago
README.md chore: provide OSSF security insight 4 months ago
RELEASE.md 2.54: Propose Bryan Boreham as release shepherd (#14453) 4 months ago
SECURITY-INSIGHTS.yml chore: provide OSSF security insight 4 months ago
SECURITY.md fix markdown lint issues (#10591) 3 years ago
VERSION Prepare release 2.54.0-rc.1 (#14593) 4 months ago
go.mod Merge pull request #14553 from prometheus/dependabot/go_modules/github.com/aws/aws-sdk-go-1.55.5 3 months ago
go.sum Merge pull request #14553 from prometheus/dependabot/go_modules/github.com/aws/aws-sdk-go-1.55.5 3 months ago
plugins.yml fix: The automatically generated file is inconsistent with the file in the code warehouse 1 year ago

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-formated 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.