More updates for first time users.

- Modified sample conf so it is useable by default, also added some
      comments from the 'hello world' configuration.
    - Updated README so there's a clear two step start for newbies.
    - Added extra vim swap files to gitignore.

Change-Id: I76203973db4a7b332014662fcfb2ce5e7d137bd8
This commit is contained in:
Conor Hennessy 2013-10-15 12:08:29 +02:00
parent 986adfa557
commit 2d2c434d48
3 changed files with 29 additions and 22 deletions

5
.gitignore vendored
View file

@ -9,8 +9,13 @@
*.pyc *.pyc
*.rej *.rej
*.so *.so
# Editor files #
################
*~ *~
.*.swp .*.swp
.*.swo
.DS_Store .DS_Store
._* ._*
.nfs.* .nfs.*

View file

@ -39,6 +39,11 @@ For basic help how to get started:
For first time users, simply run the following: For first time users, simply run the following:
$ make $ make
$ 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.
If you run into problems, try the following: If you run into problems, try the following:
@ -56,13 +61,6 @@ staticly link against C dependency libraries, so including the ``lib``
directory is paramount. Providing ``LD_LIBRARY_PATH`` or directory is paramount. Providing ``LD_LIBRARY_PATH`` or
``DYLD_LIBRARY_PATH`` in a scaffolding shell script is advised. ``DYLD_LIBRARY_PATH`` in a scaffolding shell script is advised.
Executing the following target will start up Prometheus for lazy users:
$ ARGUMENTS="-foo -bar -baz" 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.
### Problems ### Problems
If at any point you run into an error with the ``make`` build system in terms of If at any point you run into an error with the ``make`` build system in terms of

View file

@ -1,26 +1,30 @@
# Global default settings.
global { global {
scrape_interval: "1s" scrape_interval: "15s" # By default, scrape targets every 15 seconds.
evaluation_interval: "1s" evaluation_interval: "15s" # By default, evaluate rules every 15 seconds.
labels {
label { # Attach these extra labels to all timeseries collected by this Prometheus instance.
name: "owner" labels: {
value: "test" label: {
name: "monitor"
value: "codelab-monitor"
} }
} }
rule_file: "prometheus.rules"
}
job { # Load and evaluate rules in this file every 'evaluation_interval' seconds. This field may be repeated.
#rule_file: "prometheus.rules"
}
# A job definition containing exactly one endpoint to scrape: Here it's prometheus itself.
job: {
# The job name is added as a label `job={job-name}` to any timeseries scraped from this job.
name: "prometheus" name: "prometheus"
# Override the global default and scrape targets from this job every 5 seconds.
scrape_interval: "5s" scrape_interval: "5s"
target_group { # Let's define a group of targets to scrape for this job. In this case, only one.
target_group: {
# These endpoints are scraped via HTTP.
target: "http://localhost:9090/metrics.json" target: "http://localhost:9090/metrics.json"
labels {
label {
name: "group"
value: "canary"
}
}
} }
} }