README.md 1.87 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
8
9
10
11
12
13
14
Prometheus is a generic time series collection and computation server that is
useful in the following fields:

1. Industrial Experimentation / Real-Time Behavioral Validation / Software Release Qualification
2. Econometric and Natural Sciences
3. Operational Concerns and Monitoring

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

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

27
## Getting Started
28
29
30

For basic help how to get started:

31
32
  * The source code is periodically indexed: [Prometheus Core](http://godoc.org/github.com/prometheus/prometheus).
  * For Linux users, please consult the Travis CI configuration in _.travis.yml_ and _Makefile.TRAVIS_.
33
  * [Getting started on Mac OSX](documentation/guides/getting-started-osx.md)
34
  * All of the core developers are accessible via the [Prometheus Developers Mailinglist](https://groups.google.com/forum/?fromgroups#!forum/prometheus-developers).
35

Matt T. Proud's avatar
Matt T. Proud committed
36
37
38
39
## Testing

[![Build Status](https://travis-ci.org/prometheus/prometheus.png)](https://travis-ci.org/prometheus/prometheus)

40
## License
41
42

Apache License 2.0