1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
|
# Whisper
[](https://www.codacy.com/app/graphite-project/whisper?utm_source=github.com&utm_medium=referral&utm_content=graphite-project/whisper&utm_campaign=badger)
[](http://travis-ci.org/graphite-project/whisper)
[](https://app.fossa.io/projects/git%2Bhttps%3A%2F%2Fgithub.com%2Fgraphite-project%2Fwhisper?ref=badge_shield)
## Overview
Whisper is one of three components within the Graphite project:
1. [Graphite-Web](https://github.com/graphite-project/graphite-web), a Django-based web application that renders graphs and dashboards
2. The [Carbon](https://github.com/graphite-project/carbon) metric processing daemons
3. The Whisper time-series database library
Whisper is a fixed-size database, similar in design and purpose to RRD (round-robin-database). It provides fast, reliable storage of numeric data over time. Whisper allows for higher resolution (seconds per point) of recent data to degrade into lower resolutions for long-term retention of historical data.
## Installation, Configuration and Usage
Please refer to the instructions at [readthedocs](http://graphite.readthedocs.org/).
## Whisper Scripts
rrd2whisper.py
--------------
Convert a rrd file into a whisper (.wsp) file.
```
Usage: rrd2whisper.py rrd_path
Options:
-h, --help show this help message and exit
--xFilesFactor=XFILESFACTOR
The xFilesFactor to use in the output file. Defaults
to the input RRD's xFilesFactor
--aggregationMethod=AGGREGATIONMETHOD
The consolidation function to fetch from on input and
aggregationMethod to set on output. One of: average,
last, max, min
--destinationPath=DESTINATIONPATH
Path to place created whisper file. Defaults to the
RRD file's source path.
```
whisper-create.py
-----------------
Create a new whisper database file.
```
Usage: whisper-create.py path timePerPoint:timeToStore [timePerPoint:timeToStore]*
whisper-create.py --estimate timePerPoint:timeToStore [timePerPoint:timeToStore]*
timePerPoint and timeToStore specify lengths of time, for example:
60:1440 60 seconds per datapoint, 1440 datapoints = 1 day of retention
15m:8 15 minutes per datapoint, 8 datapoints = 2 hours of retention
1h:7d 1 hour per datapoint, 7 days of retention
12h:2y 12 hours per datapoint, 2 years of retention
Options:
-h, --help show this help message and exit
--xFilesFactor=XFILESFACTOR
--aggregationMethod=AGGREGATIONMETHOD
Function to use when aggregating values (average, sum,
last, max, min)
--overwrite
--estimate Don't create a whisper file, estimate storage requirements based on archive definitions
```
whisper-dump.py
---------------
Dump the metadata about a whisper file to stdout.
```
Usage: whisper-dump.py path
Options:
-h, --help show this help message and exit
```
whisper-fetch.py
----------------
Fetch all the metrics stored in a whisper file to stdout.
```
Usage: whisper-fetch.py [options] path
Options:
-h, --help show this help message and exit
--from=_FROM Unix epoch time of the beginning of your requested interval
(default: 24 hours ago)
--until=UNTIL Unix epoch time of the end of your requested interval
(default: now)
--json Output results in JSON form
--pretty Show human-readable timestamps instead of unix times
--drop=DROP Specify 'nulls' to drop all null values. Specify 'zeroes' to
drop all zero values. Specify 'empty' to drop both null and
zero values.
```
whisper-info.py
---------------
```
Usage: whisper-info.py path [field]
Options:
-h, --help show this help message and exit
```
whisper-merge.py
----------------
Join two existing whisper files together.
```
Usage: whisper-merge.py [options] from_path to_path
Options:
-h, --help show this help message and exit
```
whisper-fill.py
----------------
Copies data from src in dst, if missing.
Unlike whisper-merge, don't overwrite data that's
already present in the target file, but instead, only add the missing
data (e.g. where the gaps in the target file are). Because no values
are overwritten, no data or precision gets lost. Also, unlike
whisper-merge, try to take the highest-precision archive to provide
the data, instead of the one with the largest retention.
```
Usage: whisper-fill.py [options] src_path dst_path
Options:
-h, --help show this help message and exit
```
whisper-resize.py
-----------------
Change the retention rates of an existing whisper file.
```
Usage: whisper-resize.py path timePerPoint:timeToStore [timePerPoint:timeToStore]*
timePerPoint and timeToStore specify lengths of time, for example:
60:1440 60 seconds per datapoint, 1440 datapoints = 1 day of retention
15m:8 15 minutes per datapoint, 8 datapoints = 2 hours of retention
1h:7d 1 hour per datapoint, 7 days of retention
12h:2y 12 hours per datapoint, 2 years of retention
Options:
-h, --help show this help message and exit
--xFilesFactor=XFILESFACTOR
Change the xFilesFactor
--aggregationMethod=AGGREGATIONMETHOD
Change the aggregation function (average, sum, last,
max, min)
--force Perform a destructive change
--newfile=NEWFILE Create a new database file without removing the
existing one
--nobackup Delete the .bak file after successful execution
--aggregate Try to aggregate the values to fit the new archive
better. Note that this will make things slower and use
more memory.
```
whisper-set-aggregation-method.py
---------------------------------
Change the aggregation method of an existing whisper file.
```
Usage: whisper-set-aggregation-method.py path <average|sum|last|max|min>
Options:
-h, --help show this help message and exit
```
whisper-update.py
-----------------
Update a whisper file with 1 or many values, must provide a time stamp with the value.
```
Usage: whisper-update.py [options] path timestamp:value [timestamp:value]*
Options:
-h, --help show this help message and exit
```
whisper-diff.py
---------------
Check the differences between whisper files. Use sanity check before merging.
```
Usage: whisper-diff.py [options] path_a path_b
Options:
-h, --help show this help message and exit
--summary show summary of differences
--ignore-empty skip comparison if either value is undefined
--columns print output in simple columns
--no-headers do not print column headers
--until=UNTIL Unix epoch time of the end of your requested interval
(default: now)
--json Output results in JSON form
```
## License
Whisper is licensed under version 2.0 of the Apache License. See the [LICENSE](https://github.com/graphite-project/carbon/blob/master/LICENSE) file for details.
|