Skip to content

Commit

Permalink
Merge pull request #1083 from obfuscurity/readme_rewrite
Browse files Browse the repository at this point in the history
Simplify README and add diagram
  • Loading branch information
obfuscurity committed Jan 6, 2015
2 parents 349d752 + c0ded2f commit fe6e828
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 40 deletions.
48 changes: 8 additions & 40 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,48 +4,16 @@

Graphite consists of two major components:

1. the frontend Django webapp that runs under Apache/mod_wsgi
2. the backend carbon-cache.py daemon
1. The Django web application that runs under a wsgi-compatible webserver
2. The [Carbon](https://github.com/graphite-project/carbon) metric processing daemons
3. The [Whisper](https://github.com/graphite-project/whisper) time-series database library

Client applications connect to the running carbon-cache.py daemon on port 2003 and send it
lines of text of the following format:
![Graphite Components](https://github.com/obfuscurity/graphite-web/raw/master/webapp/content/img/overview.png "Graphite Components")

my.metric.name value unix_timestamp
## Installation, Configuration and Usage

For example:
Please refer to the instructions at [readthedocs](http://graphite.readthedocs.org/).

performance.servers.www01.cpuUsage 42.5 1208815315
## License

The metric name is like a filesystem path that uses `.` as a separator instead of `/`.
The value is some scalar integer or floating point value.
The unix_timestamp is unix epoch time, as an integer.

Each line like this corresponds to one data point for one metric.

Once you've got some clients sending data to carbon-cache, you can view
graphs of that data in the frontend webapp.


## Webapp Installation

Use the instructions in the `docs/` folder or [on
readthedocs](http://graphite.readthedocs.org/).

## Running carbon-cache.py

First you must tell carbon-cache what user it should run as.
This must be a user with write privileges to `$GRAPHITE_ROOT/storage/whisper/`
Specify the user account in `$GRAPHITE_ROOT/carbon/conf/carbon.conf`

This user must also have write privileges to `$GRAPHITE_ROOT/storage/log/carbon-cache/`


## Writing a client

First you obviously need to decide what data it is you want to graph with
graphite. The script `examples/example-client.py` demonstrates a simple client
that sends loadavg data for your local machine to carbon on a minutely basis.

The default storage schema stores data in one-minute intervals for 2 hours.
This is probably not what you want so you should create a custom storage schema
according to the docs on the graphite wiki (http://graphite.readthedocs.org/).
Graphite-Web is licensed under version 2.0 of the Apache License. See the [LICENSE](https://github.com/graphite-project/graphite-web/blob/master/LICENSE) file for details.
Binary file added webapp/content/img/overview.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit fe6e828

Please sign in to comment.