Go to file
Łukasz Mierzwa fdb6916baf
Set CI=true when running UI tests (#10394)
At the moment when I run make to build Prometheus npm tests are run as part of the process.
By default jest will run in interactive mode, unless CI env variable is set, meaning that it will run forever watching for file changes. This means that to build the binary I need to wait for jest to start and then press Q to exit it, which seems unnecessary.
Set CI=true for npm scripts so it always run in as a single run instead of watch mode.

Signed-off-by: Łukasz Mierzwa <l.mierzwa@gmail.com>
2022-03-09 19:15:04 +01:00
.circleci Replace vfsgen with embed for static web assets (#10220) 2022-03-09 10:21:31 +01:00
.github Run required checks always (#10405) 2022-03-07 11:25:08 +01:00
cmd cmd: use os.MkdirTemp instead of ioutil.TempDir (#10320) 2022-03-08 14:08:53 +01:00
config Followup on tracing (#10338) 2022-02-22 21:44:36 +01:00
console_libraries Make React UI the default, keep old UI under /classic (#8142) 2020-11-03 14:51:48 +01:00
consoles Cleaned up a little bit of HTML 2021-07-28 20:12:06 -04:00
discovery Use containers labels instead of task labels from Docker Swarm SD (#9187) (#10311) 2022-03-08 14:49:20 +01:00
docs Use containers labels instead of task labels from Docker Swarm SD (#9187) (#10311) 2022-03-08 14:49:20 +01:00
documentation Run gofumpt on all files (#10392) 2022-03-03 17:21:05 +01:00
model Specify type in metadata parser errors (#10269) 2022-03-08 08:04:11 -05:00
notifier Move packages out of deprecated pkg directory 2021-11-09 08:03:10 +01:00
prompb github action: Add buf-lint, fix buf (#10307) 2022-02-18 00:07:12 +01:00
promql Run gofumpt on all files (#10392) 2022-03-03 17:21:05 +01:00
rules Tracing: Migrate to OpenTelemetry library (#9724) 2022-01-25 11:08:04 +01:00
scrape scrape: allow providing a custom Dialer for scraping (#10415) 2022-03-09 00:48:47 +01:00
scripts Replace vfsgen with embed for static web assets (#10220) 2022-03-09 10:21:31 +01:00
storage Merge branch 'release-2.33' into beorn7/release 2022-03-08 17:42:49 +01:00
template Switch to grafana/regexp everywhere (#10268) 2022-02-13 00:58:27 +01:00
tracing Followup on tracing (#10338) 2022-02-22 21:44:36 +01:00
tsdb Enable misspell check in golangci-lint (#10393) 2022-03-03 18:11:19 +01:00
util Replace vfsgen with embed for static web assets (#10220) 2022-03-09 10:21:31 +01:00
web Fix DataTable tests and missing value key warning (#10422) 2022-03-09 17:19:45 +01:00
.dockerignore
.gitignore Replace vfsgen with embed for static web assets (#10220) 2022-03-09 10:21:31 +01:00
.gitpod.Dockerfile add gitpod dockerfile to upgrade node and npm version 2021-09-27 18:59:41 +02: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 misspell check in golangci-lint (#10393) 2022-03-03 18:11:19 +01:00
.promu.yml Build with Go 1.17 2021-08-27 00:32:49 +02:00
.yamllint Switch golangci-lint to GitHub Actions (#9232) 2021-09-10 16:30:18 +02:00
CHANGELOG.md Merge branch 'release-2.33' into beorn7/release 2022-03-08 17:42:49 +01:00
CODE_OF_CONDUCT.md
CONTRIBUTING.md Change channel to `prometheus-dev` 2021-09-09 08:13:57 -04:00
Dockerfile Dockerfile: Optimize and consolidate steps (#9180) 2021-09-30 11:13:44 +02:00
LICENSE
MAINTAINERS.md update email 2021-11-24 08:27:46 -08:00
Makefile Set CI=true when running UI tests (#10394) 2022-03-09 19:15:04 +01:00
Makefile.common Run gofumpt on all files (#10392) 2022-03-03 17:21:05 +01:00
NOTICE Add license notice for code adapted from Go 2021-12-05 09:01:52 +01:00
README.md Update minimum Go version 2021-12-31 17:29:00 +01:00
RELEASE.md Merge pull request #10110 from prometheus/beorn7/release2 2022-01-06 18:03:00 +01:00
SECURITY.md Add SECURITY.md file (#8292) 2021-01-09 09:58:53 +01:00
VERSION Cut 2.34.0-rc.0 (#10347) 2022-02-28 08:19:29 -07:00
go.mod Replace vfsgen with embed for static web assets (#10220) 2022-03-09 10:21:31 +01:00
go.sum Replace vfsgen with embed for static web assets (#10220) 2022-03-09 10:21:31 +01:00

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

  • The source code is periodically indexed, but due to an issue with versioning, the "latest" docs shown on Godoc are outdated. Instead, you can use the docs for v2.31.1.
  • You will find a CircleCI configuration in .circleci/config.yml.
  • 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.