README.md

    Prometheus

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

    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, first ensure that have a working Go environment with version 1.14 or greater installed. You also need Node.js and Yarn installed in order to build the frontend assets.

    You can directly use the go tool to download and install the prometheus and promtool binaries into your GOPATH:

    $ go get github.com/prometheus/prometheus/cmd/...
    $ prometheus --config.file=your_config.yml

    However, when using go get 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
    • docker: build a docker container for the current HEAD
    • assets: build the new experimental React UI

    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.

    项目简介

    🚀 Github 镜像仓库 🚀

    源项目地址

    https://github.com/prometheus/prometheus

    发行版本 123

    2.32.0-beta.0 / 2021-11-16

    全部发行版

    贡献者 352

    全部贡献者

    开发语言

    • Go 89.0 %
    • TypeScript 6.1 %
    • JavaScript 1.8 %
    • HTML 1.5 %
    • Yacc 0.7 %