README.md 3.96 KB
Newer Older
1
# Prometheus
Matt T. Proud's avatar
Matt T. Proud committed
2

3
4
Bedecke deinen Himmel, Zeus!  A new kid is in town.

Matt T. Proud's avatar
Matt T. Proud committed
5
6
7
Prometheus is a generic time series collection and computation server that is
useful in the following fields:

8
9
10
* Industrial Experimentation / Real-Time Behavioral Validation / Software Release Qualification
* Econometric and Natural Sciences
* Operational Concerns and Monitoring
Matt T. Proud's avatar
Matt T. Proud committed
11
12
13
14

The system is designed to collect telemetry from named targets on given
intervals, evaluate rule expressions, display the results, and trigger an
action if some condition is observed to be true.
15

16
## Prerequisites
17
18
If you read below in the _Getting Started_ section, the build infrastructure
will take care of the following things for you in most cases:
19

Matt T. Proud's avatar
Matt T. Proud committed
20
  1. Go 1.1.
Matt T. Proud's avatar
Matt T. Proud committed
21
22
23
24
25
26
27
  2. LevelDB: [https://code.google.com/p/leveldb/](https://code.google.com/p/leveldb/).
  3. Protocol Buffers Compiler: [http://code.google.com/p/protobuf/](http://code.google.com/p/protobuf/).
  4. goprotobuf: the code generator and runtime library: [http://code.google.com/p/goprotobuf/](http://code.google.com/p/goprotobuf/).
  5. Levigo, a Go-wrapper around LevelDB's C library: [https://github.com/jmhodges/levigo](https://github.com/jmhodges/levigo).
  6. GoRest, a RESTful style web-services framework: [http://code.google.com/p/gorest/](http://code.google.com/p/gorest/).
  7. Prometheus Client, Prometheus in Prometheus [https://github.com/prometheus/client_golang](https://github.com/prometheus/client_golang).
  8. Snappy, a compression library for LevelDB and Levigo [http://code.google.com/p/snappy/](http://code.google.com/p/snappy/).
28

29
## Getting Started
30
31
32

For basic help how to get started:

33
  * The source code is periodically indexed: [Prometheus Core](http://godoc.org/github.com/prometheus/prometheus).
34
  * For UNIX-like environment users, please consult the Travis CI configuration in _.travis.yml_ and _Makefile_.
35
  * All of the core developers are accessible via the [Prometheus Developers Mailinglist](https://groups.google.com/forum/?fromgroups#!forum/prometheus-developers).
36

37
38
39
40
41
### General

For first time users, simply run the following:

    $ make
42
43
44
45
46
    $ ARGUMENTS="-configFile=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.
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73

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
    $ find build/package

``build/package`` will be sufficient for whatever archiving mechanism you
choose.  The important thing to note is that Go presently does not
staticly link against C dependency libraries, so including the ``lib``
directory is paramount.  Providing ``LD_LIBRARY_PATH`` or
``DYLD_LIBRARY_PATH`` in a scaffolding shell script is advised.


### Problems
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
not the latest-whiz bang releases; thusly, we ask you to provide ample
architecture and release identification remarks for us.

Matt T. Proud's avatar
Matt T. Proud committed
74
75
## Testing

76
77
    $ make test

78
79
80
81
## Packaging

    $ make package

82
83
### Race Detector

Matt T. Proud's avatar
Matt T. Proud committed
84
85
86
Go 1.1 includes a [race detector](http://tip.golang.org/doc/articles/race_detector.html)
which can be enabled at build time. Here's how to use it with Prometheus
(assumes that you've already run a successful build).
87
88
89
90
91
92
93
94
95
96

To run the tests with race detection:

    $ GORACE="log_path=/tmp/foo" go test -race ./...

To run the server with race detection:

    $ go build -race .
    $ GORACE="log_path=/tmp/foo" ./prometheus

Matt T. Proud's avatar
Matt T. Proud committed
97
98
[![Build Status](https://travis-ci.org/prometheus/prometheus.png)](https://travis-ci.org/prometheus/prometheus)

99
100
## Contributing

101
Refer to [CONTRIBUTING.md](CONTRIBUTING.md)
102

103
## License
104
105

Apache License 2.0