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.
 
 
 
 
 
Go to file
lzhfromustc 9da5382103
storage/remote: Prevent two goroutines from endless loop (#8967)
3 years ago
.circleci Use Go 1.16+ install for mixin tests 3 years ago
.github Address golint failures from revive 3 years ago
cmd Initial draft of prometheus-agent (#8785) 3 years ago
config Enable tls_config in oauth2 (#9550) 3 years ago
console_libraries
consoles
discovery test:Fix two potential goroutine leaks (#8964) 3 years ago
docs Add scrape_body_size_bytes metric (#9569) 3 years ago
documentation Use Go 1.16+ install for mixin tests 3 years ago
notifier Expose TargetsFromGroup/AlertmanagerFromGroup func and reuse this for (#9343) 3 years ago
pkg
prompb
promql Merge pull request #9553 from prometheus/beorn7/histogram 3 years ago
rules Rule alerts/series limit updates (#9541) 3 years ago
scrape Expose TargetsFromGroup/AlertmanagerFromGroup func and reuse this for (#9343) 3 years ago
scripts
storage storage/remote: Prevent two goroutines from endless loop (#8967) 3 years ago
template
tsdb Initial draft of prometheus-agent (#8785) 3 years ago
util
web Initial draft of prometheus-agent (#8785) 3 years ago
.dockerignore
.gitignore Initial draft of prometheus-agent (#8785) 3 years ago
.gitpod.Dockerfile
.gitpod.yml
.golangci.yml Replace deprecated linter (#9571) 3 years ago
.promu.yml
.yamllint
CHANGELOG.md
CODE_OF_CONDUCT.md
CONTRIBUTING.md
Dockerfile
LICENSE
MAINTAINERS.md
Makefile
Makefile.common Use download mode for update-go-deps 3 years ago
NOTICE
README.md Fix link to React App's README (#9532) 3 years ago
RELEASE.md update documentation around react-app (#9476) 3 years ago
SECURITY.md
VERSION
go.mod Bump indirect modules (#9562) 3 years ago
go.sum Bump indirect modules (#9562) 3 years ago

README.md

Prometheus

CircleCI Docker Repository on Quay Docker Pulls Go Report Card CII Best Practices Gitpod ready-to-code Fuzzing Status

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

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

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:

You can directly use the go tool to download 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 new experimental 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 clone the repository yourself and build using make build, which will compile in the web assets so that Prometheus can be run from anywhere:

$ mkdir -p $GOPATH/src/github.com/prometheus
$ cd $GOPATH/src/github.com/prometheus
$ git clone https://github.com/prometheus/prometheus.git
$ cd prometheus
$ 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 new experimental React UI

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

NB if you are on a Mac, you will need gnu-tar.

React UI Development

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

More information

Contributing

Refer to CONTRIBUTING.md

License

Apache License 2.0, see LICENSE.