Go to file
Oleg Zaytsev 280eaf33f0
Use global string map for MatchType.String() (#9237)
* Use global string map for MatchType.String()

We were unnecessarily creating a new map for each call of String().

This is a 10x improvement in MatchType.String() performance in time,
from 53ns to 4ns on my i7 laptop, and I guess that this method is being
called quite often so why throw out the resources.

I was surprised that benchmark says that there are no allocations made
in the old version.

I also tries using `//go:generate stringer` and the result is even
better, at about 2.8ns, but having to keep the generated code updated
isn't worth the change (at least it's bigger than a small change I was
intended to do)

Benchmark comparison:

    name \ time/op    old          global_map  stringer
    MatchType_String  53.6ns ± 1%  4.1ns ± 1%  2.8ns ± 1%

    name \ alloc/op   old          global_map  stringer
    MatchType_String   0.00B       0.00B       0.00B

    name \ allocs/op  old          global_map  stringer
    MatchType_String    0.00        0.00        0.00

Old benchmark:

    goos: darwin
    goarch: amd64
    pkg: github.com/prometheus/prometheus/pkg/labels
    cpu: Intel(R) Core(TM) i7-9750H CPU @ 2.60GHz
    BenchmarkMatchType_String 	21766578	        54.36 ns/op	       0 B/op	       0 allocs/op
    BenchmarkMatchType_String 	21742339	        53.28 ns/op	       0 B/op	       0 allocs/op
    BenchmarkMatchType_String 	21985470	        53.37 ns/op	       0 B/op	       0 allocs/op
    BenchmarkMatchType_String 	21676282	        53.50 ns/op	       0 B/op	       0 allocs/op
    BenchmarkMatchType_String 	22075573	        53.33 ns/op	       0 B/op	       0 allocs/op
    PASS
    ok  	github.com/prometheus/prometheus/pkg/labels	6.252s

New with global map:

    goos: darwin
    goarch: amd64
    pkg: github.com/prometheus/prometheus/pkg/labels
    cpu: Intel(R) Core(TM) i7-9750H CPU @ 2.60GHz
    BenchmarkMatchType_String 	283412692	         4.129 ns/op	       0 B/op	       0 allocs/op
    BenchmarkMatchType_String 	294859941	         4.091 ns/op	       0 B/op	       0 allocs/op
    BenchmarkMatchType_String 	295750158	         4.113 ns/op	       0 B/op	       0 allocs/op
    BenchmarkMatchType_String 	282827982	         4.072 ns/op	       0 B/op	       0 allocs/op
    BenchmarkMatchType_String 	292942393	         4.047 ns/op	       0 B/op	       0 allocs/op
    PASS
    ok  	github.com/prometheus/prometheus/pkg/labels	8.238s

Signed-off-by: Oleg Zaytsev <mail@olegzaytsev.com>

* Use array instead of map

Since MatchType is an iota type, we can safely use an array here.

This solution is even better:

    name \ time/op    old          global_map  stringer    array
    MatchType_String  53.6ns ± 1%  4.1ns ± 1%  2.8ns ± 1%  1.0ns ± 1%

    name \ alloc/op   old          global_map  stringer    array
    MatchType_String   0.00B       0.00B       0.00B       0.00B

    name \ allocs/op  old          global_map  stringer    array
    MatchType_String    0.00        0.00        0.00        0.00

Signed-off-by: Oleg Zaytsev <mail@olegzaytsev.com>

* Benchmark all MatchType values

Co-authored-by: Ganesh Vernekar <15064823+codesome@users.noreply.github.com>
Signed-off-by: Oleg Zaytsev <mail@olegzaytsev.com>

* Use constants for limits

Signed-off-by: Oleg Zaytsev <mail@olegzaytsev.com>

Co-authored-by: Ganesh Vernekar <15064823+codesome@users.noreply.github.com>

Co-authored-by: Ganesh Vernekar <15064823+codesome@users.noreply.github.com>
2021-08-24 11:26:16 +05:30
.circleci move codemirror-promql as a prometheus web module (#9188) 2021-08-20 11:39:07 +02:00
.github Merge pull request #8985 from prometheus/richih/pr_template 2021-07-26 18:03:30 +02:00
cmd Merge release 2.29 in main (#9196) 2021-08-12 18:38:06 +02:00
config HostNetworkHost -> HostNetworkingHost 2021-08-03 05:58:49 -06: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 Merge release 2.29 in main (#9196) 2021-08-12 18:38:06 +02:00
docs Merge release 2.29 in main (#9196) 2021-08-12 18:38:06 +02:00
documentation Merge pull request #9129 from PhilipGough/bz-1984365 2021-08-13 14:03:16 +02:00
notifier Fix: Use json.Unmarshal() instead of json.Decoder (#9033) 2021-07-02 09:38:14 +01:00
pkg Use global string map for MatchType.String() (#9237) 2021-08-24 11:26:16 +05:30
prompb Add Exemplar Remote Write support (#8296) 2021-05-06 13:53:52 -07:00
promql Merge release 2.29 in main (#9196) 2021-08-12 18:38:06 +02:00
rules fixes yamllint errors 2021-06-12 12:47:47 +02:00
scrape scrape: fix 'target_limit exceeded error' when reloading conf with 0 2021-07-27 17:34:22 +05:30
scripts replace yarn by npm (#9198) 2021-08-12 20:25:26 +02:00
storage Remove Individual Data Type Caps in Per-shard Buffering for Remote Write (#8921) 2021-08-09 15:20:53 -06:00
template Added external URL access 2021-05-30 23:35:26 -04:00
tsdb Speed up BenchmarkPostings_Stats (#9213) 2021-08-18 10:27:21 +01:00
util Extract and export GetFQDN() 2021-07-21 12:55:02 -04:00
web move codemirror-promql as a prometheus web module (#9188) 2021-08-20 11:39:07 +02:00
.dockerignore
.gitignore add changes per comments, fix tests 2021-03-20 12:38:30 -07:00
.gitpod.yml replace yarn by npm (#9198) 2021-08-12 20:25:26 +02:00
.golangci.yml Revert "Fix logging after the move to go-kit/log (#9021)" 2021-07-27 07:37:03 -04:00
.promu.yml Use CircleCI parallelism 2021-03-21 12:17:20 +01:00
.yamllint avoid glob pattern for key-duplicates 2021-06-12 13:12:47 +02:00
CHANGELOG.md Merge release 2.29 in main (#9196) 2021-08-12 18:38:06 +02:00
CODE_OF_CONDUCT.md
CONTRIBUTING.md Replace freenode with libera.chat 2021-06-13 00:36:28 +02:00
Dockerfile Fix docker image build 2020-12-16 21:21:22 +01:00
LICENSE
MAINTAINERS.md move codemirror-promql as a prometheus web module (#9188) 2021-08-20 11:39:07 +02:00
Makefile move codemirror-promql as a prometheus web module (#9188) 2021-08-20 11:39:07 +02:00
Makefile.common Only run if yamllint is installed 2021-06-25 08:03:58 -04:00
NOTICE Add new codemirror-promql-based expression editor (#8634) 2021-03-23 23:55:52 +01:00
README.md replace yarn by npm (#9198) 2021-08-12 20:25:26 +02:00
RELEASE.md replace yarn by npm (#9198) 2021-08-12 20:25:26 +02:00
SECURITY.md Add SECURITY.md file (#8292) 2021-01-09 09:58:53 +01:00
VERSION Merge release 2.29 in main (#9196) 2021-08-12 18:38:06 +02:00
go.mod Update Go dependencies 2021-07-29 09:11:04 +02:00
go.sum Update Go dependencies 2021-07-29 09:11:04 +02: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, first ensure that have a working Go environment with version 1.14 or greater installed. You also need Node.js and npm 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:

$ GO111MODULE=on 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
  • 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.