]>
Commit | Line | Data |
---|---|---|
ca581a4b JB |
1 | --- rrdtool-1.5.4/doc/rrdrados.pod.orig 1970-01-01 01:00:00.000000000 +0100 |
2 | +++ rrdtool-1.5.4/doc/rrdrados.pod 2015-09-20 11:15:15.308190828 +0200 | |
3 | @@ -0,0 +1,68 @@ | |
4 | +=head1 NAME | |
5 | + | |
6 | +rrdrados - Creating, updating and retrieving RRD files from Ceph | |
7 | + | |
8 | +=head1 SYNOPSIS | |
9 | + | |
10 | +E<lt>rrdfileE<gt> = B<ceph//E<lt>nameE<gt>> | |
11 | + | |
12 | + | |
13 | +=head1 DESCRIPTION | |
14 | + | |
15 | +This module adds support for creating, updating and retrieving RRD files | |
16 | +directly from a Ceph cluster using librados. | |
17 | + | |
18 | +It adds a ceph// prefix to RRD file name which is used to instruct rrdtool to | |
19 | +operate on a file that is stored in Ceph. | |
20 | + | |
21 | +Currently the module expects to find the Ceph configuration file in the default | |
22 | +location at /etc/ceph/ceph.conf. By default it uses Ceph client ID "admin" and a | |
23 | +Ceph pool named "rrd". | |
24 | + | |
25 | + | |
26 | +=head1 ENVIRONMENT VARIABLES | |
27 | + | |
28 | +=over 4 | |
29 | + | |
30 | +=item B<CEPH_ID> | |
31 | + | |
32 | +Sets the Ceph Client ID to use when connecting. By default the client ID "admin" | |
33 | +is used. | |
34 | + | |
35 | +=item B<CEPH_POOL> | |
36 | + | |
37 | +Sets the name of the Ceph Pool to connect to. By default, the pool "rrd" is | |
38 | +used. | |
39 | + | |
40 | +=back | |
41 | + | |
42 | + | |
43 | +=head1 EXAMPLES | |
44 | + | |
45 | +B<Creating an RRD file on Ceph> | |
46 | + | |
47 | + rrdtool create ceph//temperature.rrd --step 300 \ | |
48 | + DS:temp:GAUGE:600:-273:5000 \ | |
49 | + RRA:AVERAGE:0.5:1:1200 \ | |
50 | + RRA:MIN:0.5:12:2400 \ | |
51 | + RRA:MAX:0.5:12:2400 \ | |
52 | + RRA:AVERAGE:0.5:12:2400 | |
53 | + | |
54 | + | |
55 | +B<Importing an existing RRD into Ceph> | |
56 | + | |
57 | + rrdtool dump existing.rrd | rrdtool restore - ceph//new.rrd | |
58 | + | |
59 | +Or you could also copy the RRD file directly into Ceph using the rados command | |
60 | +line utility. | |
61 | + | |
62 | + | |
63 | +B<Retrieving RRD data from Ceph> | |
64 | + | |
65 | + rrdtool fetch ceph//file.rrd AVERAGE | |
66 | + | |
67 | + | |
68 | +=head1 AUTHOR | |
69 | + | |
70 | +Simon Boulet E<lt>simon@nostalgeek.comE<gt> | |
71 | + |