Skip to content
Newer
Older
100644 48 lines (32 sloc) 1.91 KB
6798d61 simple install cleanup, includes example now
cdavis authored
1 Overview
2 -------------------------------------------------------------------------------
64895e5 @cdavis initial import
cdavis authored
3 Graphite consists of two major components
4
5 1) the frontend Django webapp that runs under mod_python Apache
cc98f6d @cdavis more preparation for a release
cdavis authored
6 2) the backend carbon-cache.py daemon
64895e5 @cdavis initial import
cdavis authored
7
cc98f6d @cdavis more preparation for a release
cdavis authored
8 Client applications connect to the running carbon-cache.py daemon on port 2003 and send it
64895e5 @cdavis initial import
cdavis authored
9 lines of text of the following format:
10
11 "my.metric.name value unix_timestamp", for example:
12
13 "performance.servers.www01.cpuUsage 42.5 1208815315"
14
ba69a59 @cdavis updated INSTALL and README files to reflect new installation steps
cdavis authored
15 The metric name is like a filesystem path that uses . as a separator instead of /
64895e5 @cdavis initial import
cdavis authored
16 The value is some scalar integer or floating point value
17 The unix_timestamp is unix epoch time, as an integer
18
19 Each line like this corresponds to one data point for one metric.
20
cc98f6d @cdavis more preparation for a release
cdavis authored
21 Once you've got some clients sending data to carbon-cache, you can view
64895e5 @cdavis initial import
cdavis authored
22 graphs of that data in the frontend webapp.
23
24
d6aaf4f @cdavis fixed more installation issues
cdavis authored
25 Webapp Installation
6798d61 simple install cleanup, includes example now
cdavis authored
26 -------------------------------------------------------------------------------
27 Use the instructions in the INSTALL file.
64895e5 @cdavis initial import
cdavis authored
28
29
cc98f6d @cdavis more preparation for a release
cdavis authored
30 Running carbon-cache.py
6798d61 simple install cleanup, includes example now
cdavis authored
31 -------------------------------------------------------------------------------
cc98f6d @cdavis more preparation for a release
cdavis authored
32 First you must tell carbon-cache what user it should run as.
5c447b1 @cdavis more minor deployment fixes
cdavis authored
33 This must be a user with write privileges to $GRAPHITE_ROOT/storage/whisper/
cc98f6d @cdavis more preparation for a release
cdavis authored
34 Specify the user account in $GRAPHITE_ROOT/carbon/conf/carbon.conf
ba69a59 @cdavis updated INSTALL and README files to reflect new installation steps
cdavis authored
35
5c447b1 @cdavis more minor deployment fixes
cdavis authored
36 This user must also have write privileges to $GRAPHITE_ROOT/storage/log/carbon-cache/
64895e5 @cdavis initial import
cdavis authored
37
38
6798d61 simple install cleanup, includes example now
cdavis authored
39 Writing a client
40 -------------------------------------------------------------------------------
41 First you obviously need to decide what data it is you want to graph with
42 graphite. The script examples/example-client.py demonstrates a simple client
43 that sends loadavg data for your local machine to carbon on a minutely basis.
64895e5 @cdavis initial import
cdavis authored
44
6798d61 simple install cleanup, includes example now
cdavis authored
45 The default storage schema stores data in one-minute intervals for 2 hours.
46 This is probably not what you want so you should create a custom storage schema
47 according to the docs on the graphite wiki (http://graphite.wikidot.com)
Something went wrong with that request. Please try again.