The Prometheus monitoring system and time series database.
Find a file
Jan Fajerski ddaddc2a7a
Replace vfsgen with embed for static web assets (#9719)
* remove vfsgen usages

Signed-off-by: Jan Fajerski <jfajersk@redhat.com>

* web: use embed package for static assets

This requires go 1.16.

Signed-off-by: Jan Fajerski <jfajersk@redhat.com>

* circleci: drop go generate in web/ui

Signed-off-by: Jan Fajerski <jfajersk@redhat.com>

* Makefile: compress web assets before build

This commit add compression before (and decompression after) prometheus
is build. This ensures that gzipped assets are embeded in the prometheus
binary, if the builtinassets build tag is passed. If the build tag is
not passed this step is still executed but has no effect.
All this is executed in a subshell so that we can run the decompress
step even if the build step fails, but retain the exit code of promu.
This cleanup could also cover interrupts, but I left that out for now.

Signed-off-by: Jan Fajerski <jfajersk@redhat.com>

* [FIXME]: add new module dependency on common/assets and temp replace

Signed-off-by: Jan Fajerski <jfajersk@redhat.com>
2021-11-25 15:04:51 +01:00
.circleci Replace vfsgen with embed for static web assets (#9719) 2021-11-25 15:04:51 +01:00
.github Bump actions/upload-artifact from 1 to 2.2.4 (#9731) 2021-11-15 17:07:31 +01:00
cmd cmd: use t.TempDir instead of ioutil.TempDir on tests (#9852) 2021-11-23 20:09:28 -05:00
config remote-write: slow down retries to avoid DDOS (#9634) 2021-11-09 14:08:24 -08: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 replace gopkg.in/fsnotify/fsnotify.v1 by github.com/fsnotify/fsnotify (#9781) 2021-11-17 13:07:14 +01:00
docs fixes wrong metric name in documentation (#9828) 2021-11-19 15:06:01 -05:00
documentation documentation: align kubernetes example with the prom operator and mixins 2021-11-22 11:13:47 +01:00
model Expose Error function for WrappedError (#9662) 2021-11-12 17:38:59 -05:00
notifier Move packages out of deprecated pkg directory 2021-11-09 08:03:10 +01:00
prompb Add Exemplar Remote Write support (#8296) 2021-05-06 13:53:52 -07:00
promql Revert "promql: Remove unused Point.MarshalJSON method (#9860)" (#9864) 2021-11-25 17:07:55 +05:30
rules Merge pull request #9478 from prometheus/beorn7/pkg-deprecation 2021-11-09 11:09:16 +01:00
scrape Move packages out of deprecated pkg directory 2021-11-09 08:03:10 +01:00
scripts Replace vfsgen with embed for static web assets (#9719) 2021-11-25 15:04:51 +01:00
storage storage/remote: use t.TempDir instead of ioutil.TempDir on tests (#9811) 2021-11-19 15:21:45 -05:00
template Update to return a float 2021-11-10 18:35:30 +01:00
tsdb Fix panic, out of order chunks, and race warning during WAL replay (#9856) 2021-11-25 13:36:14 +05:30
util Replace vfsgen with embed for static web assets (#9719) 2021-11-25 15:04:51 +01:00
web Replace vfsgen with embed for static web assets (#9719) 2021-11-25 15:04:51 +01:00
.dockerignore Add image build for ppc64le architecture 2020-04-06 18:03:58 -03:00
.gitignore Replace vfsgen with embed for static web assets (#9719) 2021-11-25 15:04:51 +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 .golangci.yml: sort output by default 2021-11-11 01:37:24 +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 Release Prometheus 2.32.0-beta.0 (#9747) 2021-11-16 11:58:34 +01:00
CODE_OF_CONDUCT.md Improve repo sync script 2020-06-17 17:12:36 +02:00
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
go.mod Replace vfsgen with embed for static web assets (#9719) 2021-11-25 15:04:51 +01:00
go.sum Replace vfsgen with embed for static web assets (#9719) 2021-11-25 15:04:51 +01:00
LICENSE Clean up license issues. 2015-01-21 20:07:45 +01:00
MAINTAINERS.md update email 2021-11-24 08:27:46 -08:00
Makefile Replace vfsgen with embed for static web assets (#9719) 2021-11-25 15:04:51 +01:00
Makefile.common Replace vfsgen with embed for static web assets (#9719) 2021-11-25 15:04:51 +01:00
NOTICE Add new codemirror-promql-based expression editor (#8634) 2021-03-23 23:55:52 +01:00
README.md Add basic initial developer docs for TSDB (#9451) 2021-11-17 15:51:27 +05:30
RELEASE.md update documentation around react-app (#9476) 2021-10-18 12:47:31 +02:00
SECURITY.md Add SECURITY.md file (#8292) 2021-01-09 09:58:53 +01:00
VERSION Release Prometheus 2.32.0-beta.0 (#9747) 2021-11-16 11:58:34 +01:00

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.