The Prometheus monitoring system and time series database.
Find a file
Robert Fratto 516579a97e
discovery/targetgroup: support marshaling to JSON (#10229)
* discovery/targetgroup: support marshaling to JSON

targetgroup.Group is able to be marshaled to and from YAML, but not with
JSON. JSON is used for the http_sd API representation, so users
implementing the API were required to implement their own type which is
expected by the JSON unmarshaler.

Signed-off-by: Robert Fratto <robertfratto@gmail.com>

* fix lint error

Signed-off-by: Robert Fratto <robertfratto@gmail.com>

* Update discovery/targetgroup/targetgroup.go

Co-authored-by: Julius Volz <julius.volz@gmail.com>
Signed-off-by: Robert Fratto <robertfratto@gmail.com>

* s/Json/JSON

Signed-off-by: Robert Fratto <robertfratto@gmail.com>

Co-authored-by: Julius Volz <julius.volz@gmail.com>
2022-02-02 17:20:18 +01:00
.circleci Split remote storage example in its own go mod (#10244) 2022-02-02 14:54:13 +01:00
.github move dependabot frequency running to monthly (#10144) 2022-01-10 23:26:24 +01:00
cmd Tracing: Migrate to OpenTelemetry library (#9724) 2022-01-25 11:08:04 +01:00
config Followup on OpenTelemetry migration (#10203) 2022-01-29 23:56:44 +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 discovery/targetgroup: support marshaling to JSON (#10229) 2022-02-02 17:20:18 +01:00
docs Followup on OpenTelemetry migration (#10203) 2022-01-29 23:56:44 +01:00
documentation Split remote storage example in its own go mod (#10244) 2022-02-02 14:54:13 +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 Merge pull request #10140 from David-N-Perkins/ISS-9910 2022-02-01 15:28:42 +01:00
rules Tracing: Migrate to OpenTelemetry library (#9724) 2022-01-25 11:08:04 +01:00
scrape Prefer 1.0.0 in the accept header for application/openmetrics-text (#9431) 2022-01-28 00:37:51 +01:00
scripts Revert "Replace vfsgen with embed for static web assets (#9719)" (#9870) 2021-11-26 10:11:26 +01:00
storage Tracing: Migrate to OpenTelemetry library (#9724) 2022-01-25 11:08:04 +01:00
template template: Fix failing tests on non-amd64 architectures (#10196) 2022-01-24 18:15:38 -05:00
tracing Followup on OpenTelemetry migration (#10203) 2022-01-29 23:56:44 +01:00
tsdb tsdb/wal: Move comment of w.writer.Append(...) to the WriteTo interface (#10198) 2022-01-30 22:14:16 -08:00
util Tracing: Migrate to OpenTelemetry library (#9724) 2022-01-25 11:08:04 +01:00
web Fix serving of Prometheus logo, move it into 'src/images' (#10236) 2022-02-02 14:53:30 +01:00
.dockerignore Add image build for ppc64le architecture 2020-04-06 18:03:58 -03:00
.gitignore Revert "Replace vfsgen with embed for static web assets (#9719)" (#9870) 2021-11-26 10:11:26 +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 Cut v2.33.0 2022-01-29 16:11:12 +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 build(deps): bump github.com/aws/aws-sdk-go from 1.42.31 to 1.42.44 (#10247) 2022-02-02 16:13:08 +01:00
go.sum build(deps): bump github.com/aws/aws-sdk-go from 1.42.31 to 1.42.44 (#10247) 2022-02-02 16:13:08 +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 Revert "Replace vfsgen with embed for static web assets (#9719)" (#9870) 2021-11-26 10:11:26 +01:00
Makefile.common Revert "Replace vfsgen with embed for static web assets (#9719)" (#9870) 2021-11-26 10:11:26 +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 v2.33.0 2022-01-29 16:11:12 +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.