1 /*****************************************************************************
2 * RRDtool 1.4.3 Copyright by Tobi Oetiker, 1997-2010
3 *****************************************************************************
4 * change header parameters of an rrd
5 *****************************************************************************
8 * Revision 1.6 2004/05/26 22:11:12 oetiker
9 * reduce compiler warnings. Many small fixes. -- Mike Slifcak <slif@bellsouth.net>
11 * Revision 1.5 2002/02/01 20:34:49 oetiker
12 * fixed version number and date/time
14 * Revision 1.4 2001/08/22 22:29:07 jake
15 * Contents of this patch:
16 * (1) Adds/revises documentation for rrd tune in rrd_tool.c and pod files.
17 * (2) Moves some initialization code from rrd_create.c to rrd_hw.c.
18 * (3) Adds another pass to smoothing for SEASONAL and DEVSEASONAL RRAs.
19 * This pass computes the coefficients as deviations from an average; the
20 * average is added the baseline coefficient of HWPREDICT. Statistical texts
21 * suggest this to preserve algorithm stability. It will not invalidate
22 * RRD files created and smoothed with the old code.
23 * (4) Adds the aberrant-reset flag to rrd tune. This operation, which is
24 * specified for a single data source, causes the holt-winters algorithm to
25 * forget everthing it has learned and start over.
26 * (5) Fixes a few out-of-date code comments.
28 * Revision 1.3 2001/03/07 21:21:54 oetiker
29 * complete rewrite of rrdgraph documentation. This also includs info
30 * on upcomming/planned changes to the rrdgraph interface and functionality
31 * -- Alex van den Bogaerdt <alex@slot.hollandcasino.nl>
33 * Revision 1.2 2001/03/04 13:01:55 oetiker
34 * Aberrant Behavior Detection support. A brief overview added to rrdtool.pod.
35 * Major updates to rrd_update.c, rrd_create.c. Minor update to other core files.
36 * This is backwards compatible! But new files using the Aberrant stuff are not readable
37 * by old rrdtool versions. See http://cricket.sourceforge.net/aberrant/rrd_hw.htm
38 * -- Jake Brutlag <jakeb@corp.webtv.net>
40 *****************************************************************************/
46 #include "rrd_rpncalc.h"
52 enum rra_par_en rra_par,
56 enum rra_par_en rra_par,
66 enum rra_par_en rra_par,
77 char ds_nam[DS_NAM_SIZE];
78 char ds_new[DS_NAM_SIZE];
84 struct option long_options[] = {
85 {"heartbeat", required_argument, 0, 'h'},
86 {"minimum", required_argument, 0, 'i'},
87 {"maximum", required_argument, 0, 'a'},
88 {"data-source-type", required_argument, 0, 'd'},
89 {"data-source-rename", required_argument, 0, 'r'},
90 /* added parameter tuning options for aberrant behavior detection */
91 {"deltapos", required_argument, 0, 'p'},
92 {"deltaneg", required_argument, 0, 'n'},
93 {"window-length", required_argument, 0, 'w'},
94 {"failure-threshold", required_argument, 0, 'f'},
95 {"alpha", required_argument, 0, 'x'},
96 {"beta", required_argument, 0, 'y'},
97 {"gamma", required_argument, 0, 'z'},
98 {"gamma-deviation", required_argument, 0, 'v'},
99 {"smoothing-window", required_argument, 0, 's'},
100 {"smoothing-window-deviation", required_argument, 0, 'S'},
101 {"aberrant-reset", required_argument, 0, 'b'},
106 opterr = 0; /* initialize getopt */
110 rrd_file = rrd_open(argv[1], &rrd, RRD_READWRITE);
111 if (rrd_file == NULL) {
117 int option_index = 0;
119 char *old_locale = "";
121 opt = getopt_long(argc, argv, "h:i:a:d:r:p:n:w:f:x:y:z:v:b:",
122 long_options, &option_index);
129 old_locale = setlocale(LC_NUMERIC, NULL);
130 setlocale(LC_NUMERIC, "C");
132 sscanf(optarg, DS_NAM_FMT ":%ld", ds_nam,
134 rrd_set_error("invalid arguments for heartbeat");
137 setlocale(LC_NUMERIC, old_locale);
140 setlocale(LC_NUMERIC, old_locale);
141 if ((ds = ds_match(&rrd, ds_nam)) == -1) {
146 rrd.ds_def[ds].par[DS_mrhb_cnt].u_cnt = heartbeat;
150 old_locale = setlocale(LC_NUMERIC, NULL);
151 setlocale(LC_NUMERIC, "C");
153 sscanf(optarg, DS_NAM_FMT ":%lf", ds_nam, &min)) < 1) {
154 rrd_set_error("invalid arguments for minimum ds value");
157 setlocale(LC_NUMERIC, old_locale);
160 setlocale(LC_NUMERIC, old_locale);
161 if ((ds = ds_match(&rrd, ds_nam)) == -1) {
169 rrd.ds_def[ds].par[DS_min_val].u_val = min;
173 old_locale = setlocale(LC_NUMERIC, NULL);
174 setlocale(LC_NUMERIC, "C");
176 sscanf(optarg, DS_NAM_FMT ":%lf", ds_nam, &max)) < 1) {
177 rrd_set_error("invalid arguments for maximum ds value");
180 setlocale(LC_NUMERIC, old_locale);
183 setlocale(LC_NUMERIC, old_locale);
184 if ((ds = ds_match(&rrd, ds_nam)) == -1) {
191 rrd.ds_def[ds].par[DS_max_val].u_val = max;
196 sscanf(optarg, DS_NAM_FMT ":" DST_FMT, ds_nam, dst)) != 2) {
197 rrd_set_error("invalid arguments for data source type");
202 if ((ds = ds_match(&rrd, ds_nam)) == -1) {
207 if ((int) dst_conv(dst) == -1) {
212 /* only reset when something is changed */
213 if (strncmp(rrd.ds_def[ds].dst, dst, DST_SIZE - 1) != 0) {
214 strncpy(rrd.ds_def[ds].dst, dst, DST_SIZE - 1);
215 rrd.ds_def[ds].dst[DST_SIZE - 1] = '\0';
217 rrd.pdp_prep[ds].last_ds[0] = 'U';
218 rrd.pdp_prep[ds].last_ds[1] = 'N';
219 rrd.pdp_prep[ds].last_ds[2] = 'K';
220 rrd.pdp_prep[ds].last_ds[3] = 'N';
221 rrd.pdp_prep[ds].last_ds[4] = '\0';
226 sscanf(optarg, DS_NAM_FMT ":" DS_NAM_FMT, ds_nam,
228 rrd_set_error("invalid arguments for data source type");
233 if ((ds = ds_match(&rrd, ds_nam)) == -1) {
238 strncpy(rrd.ds_def[ds].ds_nam, ds_new, DS_NAM_SIZE - 1);
239 rrd.ds_def[ds].ds_nam[DS_NAM_SIZE - 1] = '\0';
242 if (set_deltaarg(&rrd, RRA_delta_pos, optarg)) {
248 if (set_deltaarg(&rrd, RRA_delta_neg, optarg)) {
254 if (set_windowarg(&rrd, RRA_failure_threshold, optarg)) {
260 if (set_windowarg(&rrd, RRA_window_len, optarg)) {
266 if (set_hwarg(&rrd, CF_HWPREDICT, RRA_hw_alpha, optarg)) {
267 if (set_hwarg(&rrd, CF_MHWPREDICT, RRA_hw_alpha, optarg)) {
275 if (set_hwarg(&rrd, CF_HWPREDICT, RRA_hw_beta, optarg)) {
276 if (set_hwarg(&rrd, CF_MHWPREDICT, RRA_hw_beta, optarg)) {
284 if (set_hwarg(&rrd, CF_SEASONAL, RRA_seasonal_gamma, optarg)) {
290 if (set_hwarg(&rrd, CF_DEVSEASONAL, RRA_seasonal_gamma, optarg)) {
296 if (sscanf(optarg, DS_NAM_FMT, ds_nam) != 1) {
297 rrd_set_error("invalid argument for aberrant-reset");
302 if ((ds = ds_match(&rrd, ds_nam)) == -1) {
303 /* ds_match handles it own errors */
308 reset_aberrant_coefficients(&rrd, rrd_file, (unsigned long) ds);
309 if (rrd_test_error()) {
316 strcpy(rrd.stat_head->version, RRD_VERSION); /* smoothing_window causes Version 4 */
318 (&rrd, CF_SEASONAL, RRA_seasonal_smoothing_window, optarg)) {
324 strcpy(rrd.stat_head->version, RRD_VERSION); /* smoothing_window causes Version 4 */
326 (&rrd, CF_DEVSEASONAL, RRA_seasonal_smoothing_window,
334 rrd_set_error("unknown option '%c'", optopt);
336 rrd_set_error("unknown option '%s'", argv[optind - 1]);
343 rrd_seek(rrd_file, 0, SEEK_SET);
344 rrd_write(rrd_file, rrd.stat_head, sizeof(stat_head_t) * 1);
345 rrd_write(rrd_file, rrd.ds_def,
346 sizeof(ds_def_t) * rrd.stat_head->ds_cnt);
347 /* need to write rra_defs for RRA parameter changes */
348 rrd_write(rrd_file, rrd.rra_def,
349 sizeof(rra_def_t) * rrd.stat_head->rra_cnt);
353 for (i = 0; i < (int) rrd.stat_head->ds_cnt; i++)
354 if (dst_conv(rrd.ds_def[i].dst) != DST_CDEF) {
355 printf("DS[%s] typ: %s\thbt: %ld\tmin: %1.4f\tmax: %1.4f\n",
356 rrd.ds_def[i].ds_nam,
358 rrd.ds_def[i].par[DS_mrhb_cnt].u_cnt,
359 rrd.ds_def[i].par[DS_min_val].u_val,
360 rrd.ds_def[i].par[DS_max_val].u_val);
364 rpn_compact2str((rpn_cdefds_t *) &
365 (rrd.ds_def[i].par[DS_cdef]), rrd.ds_def,
367 printf("DS[%s] typ: %s\tcdef: %s\n", rrd.ds_def[i].ds_nam,
368 rrd.ds_def[i].dst, buffer);
380 enum rra_par_en rra_par,
385 signed short rra_idx = -1;
389 if (param <= 0.0 || param >= 1.0) {
390 rrd_set_error("Holt-Winters parameter must be between 0 and 1");
393 /* does the appropriate RRA exist? */
394 for (i = 0; i < rrd->stat_head->rra_cnt; ++i) {
395 if (cf_conv(rrd->rra_def[i].cf_nam) == cf) {
401 rrd_set_error("Holt-Winters RRA does not exist in this RRD");
406 rrd->rra_def[rra_idx].par[rra_par].u_val = param;
413 enum rra_par_en rra_par,
418 signed short rra_idx = -1;
422 /* in order to avoid smoothing of SEASONAL or DEVSEASONAL, we need to
424 if (param < 0.0 || param > 1.0) {
425 rrd_set_error("Holt-Winters parameter must be between 0 and 1");
428 /* does the appropriate RRA exist? */
429 for (i = 0; i < rrd->stat_head->rra_cnt; ++i) {
430 if (cf_conv(rrd->rra_def[i].cf_nam) == cf) {
436 rrd_set_error("Holt-Winters RRA does not exist in this RRD");
441 rrd->rra_def[rra_idx].par[rra_par].u_val = param;
447 enum rra_par_en rra_par,
452 signed short rra_idx = -1;
456 rrd_set_error("Parameter specified is too small");
459 /* does the appropriate RRA exist? */
460 for (i = 0; i < rrd->stat_head->rra_cnt; ++i) {
461 if (cf_conv(rrd->rra_def[i].cf_nam) == CF_FAILURES) {
467 rrd_set_error("Failures RRA does not exist in this RRD");
472 rrd->rra_def[rra_idx].par[rra_par].u_val = param;
478 enum rra_par_en rra_par,
482 unsigned long i, cdp_idx;
483 signed short rra_idx = -1;
487 if (param < 1 || param > MAX_FAILURES_WINDOW_LEN) {
488 rrd_set_error("Parameter must be between %d and %d",
489 1, MAX_FAILURES_WINDOW_LEN);
492 /* does the appropriate RRA exist? */
493 for (i = 0; i < rrd->stat_head->rra_cnt; ++i) {
494 if (cf_conv(rrd->rra_def[i].cf_nam) == CF_FAILURES) {
500 rrd_set_error("Failures RRA does not exist in this RRD");
505 rrd->rra_def[rra_idx].par[rra_par].u_cnt = param;
507 /* erase existing violations */
508 for (i = 0; i < rrd->stat_head->ds_cnt; i++) {
509 cdp_idx = rra_idx * (rrd->stat_head->ds_cnt) + i;
510 erase_violations(rrd, cdp_idx, rra_idx);