@ -13,87 +13,67 @@ The system is designed to collect telemetry from named targets on given
intervals, evaluate rule expressions, display the results, and trigger an
intervals, evaluate rule expressions, display the results, and trigger an
action if some condition is observed to be true.
action if some condition is observed to be true.
## Prerequisites
TODO: The above description is somewhat esoteric. Rephrase it into
somethith that tells normal people how they will usually benefit from
using Prometheus.
In your `PATH`, you must have the following binaries available:
## Install
- `curl`
- `xxd`
- `sed`
- `gzip`
If you change any of the `*.proto` files, you need to install [`protoc`, the protobuf compiler](http://code.google.com/p/protobuf/](http://code.google.com/p/protobuf/), v2.5.0 or higher.
There are various ways of installing Prometheus.
TODO: lexer, golex
### Precompiled packages
## Getting Started
We plan to provide precompiled binaries for various platforms and even
packages for common Linux distribution soon. Once those are offered,
it will be the recommended way of installing Prometheus.
For basic help how to get started:
### Use `make`
* The source code is periodically indexed: [Prometheus Core](http://godoc.org/github.com/prometheus/prometheus).
In most cirumstances, the following should work:
* For UNIX-like environment users, please consult the Travis CI configuration in _.travis.yml_ and _Makefile_.
* All of the core developers are accessible via the [Prometheus Developers Mailinglist](https://groups.google.com/forum/?fromgroups#!forum/prometheus-developers).
### General
For first time users, simply run the following:
$ make
$ make
$ ARGUMENTS="-configFile=documentation/examples/prometheus.conf" make run
$ ARGUMENTS="-config.file=documentation/examples/prometheus.conf" make run
``${ARGUMENTS}`` is passed verbatim into the makefile and thusly Prometheus as
``$(ARGUMENTS)``. This is useful for quick one-off invocations and smoke
testing.
If you run into problems, try the following:
$ SILENCE_THIRD_PARTY_BUILDS=false make
Upon having a satisfactory build, it's possible to create an artifact for
end-user distribution:
$ make package
``${ARGUMENTS}`` is passed verbatim to the commandline starting the Prometheus binary.
$ find build/package
This is useful for quick one-off invocations and smoke testing.
``build/package`` will be sufficient for whatever archiving mechanism you
The above requires a number of common tools to be installed, namely
choose. The important thing to note is that Go presently does not
`curl`, `git`, `gzip`, `hg` (Mercurial CLI), `sed`, `xxd`. Should you
staticly link against C dependency libraries, so including the ``lib``
need to change any of the protocol buffer definition files
directory is paramount. Providing ``LD_LIBRARY_PATH`` or
(`*.proto`), you also need the protocol buffer compiler
``DYLD_LIBRARY_PATH`` in a scaffolding shell script is advised.
Everything else will be downloaded and installed into a staging
environment in the `.build` sub-directory. That includes a Go
development environment of the appropriate version.
### Problems
The `Makefile` offers a number of useful targets. Some examples:
If at any point you run into an error with the ``make`` build system in terms of
its not properly scaffolding things on a given environment, please file a bug or
open a pull request with your changes if you can fix it yourself.
Please note that we're explicitly shooting for stable runtime environments and
* `make test` runs tests.
not the latest-whiz bang releases; thusly, we ask you to provide ample
* `make tarball` creates a tar ball with the binary for distribution.
architecture and release identification remarks for us.
* `make race_condition_run` compiles and runs a binary with the race detector enabled.
## Testing
### Use your own Go development environment
$ make test
Using your own Go development environment with the usual tooling is
possible, too, but you have to take care of various generated files
(usually by running `make` in the respective sub-directory):
## Packaging
* Compiling the protocol buffer definitions in `config` (only if you have changed them).
* Generating the parser and lexer code in `rules` (only if you have changed `parser.y` or `lexer.l`).
* The `files.go` blob in `web/blob`, which embeds the static web content into the binary.
$ make package
Furthermore, the build info (see `build_info.go`) will not be
populated if you simply run `go build`. You have to pass in command
line flags as defined in `Makefile.INCLUDE` (see `${BUILDFLAGS}`) to
do that.
### Race Detector
## More information
Go 1.1 includes a [race detector](http://tip.golang.org/doc/articles/race_detector.html)
* The source code is periodically indexed: [Prometheus Core](http://godoc.org/github.com/prometheus/prometheus).
which can be enabled at build time. Here's how to use it with Prometheus
* You will find a Travis CI configuration in `.travis.yml`.
(assumes that you've already run a successful build).
* All of the core developers are accessible via the [Prometheus Developers Mailinglist](https://groups.google.com/forum/?fromgroups#!forum/prometheus-developers).
Bjoern Rabenstein
10 years ago