1 /*****************************************************************************
2 * RRDtool 1.4.0 Copyright by Tobi Oetiker, 1997-2009
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, "C");
131 sscanf(optarg, DS_NAM_FMT ":%ld", ds_nam,
133 rrd_set_error("invalid arguments for heartbeat");
136 setlocale(LC_NUMERIC, old_locale);
139 setlocale(LC_NUMERIC, old_locale);
140 if ((ds = ds_match(&rrd, ds_nam)) == -1) {
145 rrd.ds_def[ds].par[DS_mrhb_cnt].u_cnt = heartbeat;
149 old_locale = setlocale(LC_NUMERIC, "C");
151 sscanf(optarg, DS_NAM_FMT ":%lf", ds_nam, &min)) < 1) {
152 rrd_set_error("invalid arguments for minimum ds value");
155 setlocale(LC_NUMERIC, old_locale);
158 setlocale(LC_NUMERIC, old_locale);
159 if ((ds = ds_match(&rrd, ds_nam)) == -1) {
167 rrd.ds_def[ds].par[DS_min_val].u_val = min;
171 old_locale = setlocale(LC_NUMERIC, "C");
173 sscanf(optarg, DS_NAM_FMT ":%lf", ds_nam, &max)) < 1) {
174 rrd_set_error("invalid arguments for maximum ds value");
177 setlocale(LC_NUMERIC, old_locale);
180 setlocale(LC_NUMERIC, old_locale);
181 if ((ds = ds_match(&rrd, ds_nam)) == -1) {
188 rrd.ds_def[ds].par[DS_max_val].u_val = max;
193 sscanf(optarg, DS_NAM_FMT ":" DST_FMT, ds_nam, dst)) != 2) {
194 rrd_set_error("invalid arguments for data source type");
199 if ((ds = ds_match(&rrd, ds_nam)) == -1) {
204 if ((int) dst_conv(dst) == -1) {
209 /* only reset when something is changed */
210 if (strncmp(rrd.ds_def[ds].dst, dst, DST_SIZE - 1) != 0) {
211 strncpy(rrd.ds_def[ds].dst, dst, DST_SIZE - 1);
212 rrd.ds_def[ds].dst[DST_SIZE - 1] = '\0';
214 rrd.pdp_prep[ds].last_ds[0] = 'U';
215 rrd.pdp_prep[ds].last_ds[1] = 'N';
216 rrd.pdp_prep[ds].last_ds[2] = 'K';
217 rrd.pdp_prep[ds].last_ds[3] = 'N';
218 rrd.pdp_prep[ds].last_ds[4] = '\0';
223 sscanf(optarg, DS_NAM_FMT ":" DS_NAM_FMT, ds_nam,
225 rrd_set_error("invalid arguments for data source type");
230 if ((ds = ds_match(&rrd, ds_nam)) == -1) {
235 strncpy(rrd.ds_def[ds].ds_nam, ds_new, DS_NAM_SIZE - 1);
236 rrd.ds_def[ds].ds_nam[DS_NAM_SIZE - 1] = '\0';
239 if (set_deltaarg(&rrd, RRA_delta_pos, optarg)) {
245 if (set_deltaarg(&rrd, RRA_delta_neg, optarg)) {
251 if (set_windowarg(&rrd, RRA_failure_threshold, optarg)) {
257 if (set_windowarg(&rrd, RRA_window_len, optarg)) {
263 if (set_hwarg(&rrd, CF_HWPREDICT, RRA_hw_alpha, optarg)) {
264 if (set_hwarg(&rrd, CF_MHWPREDICT, RRA_hw_alpha, optarg)) {
272 if (set_hwarg(&rrd, CF_HWPREDICT, RRA_hw_beta, optarg)) {
273 if (set_hwarg(&rrd, CF_MHWPREDICT, RRA_hw_beta, optarg)) {
281 if (set_hwarg(&rrd, CF_SEASONAL, RRA_seasonal_gamma, optarg)) {
287 if (set_hwarg(&rrd, CF_DEVSEASONAL, RRA_seasonal_gamma, optarg)) {
293 if (sscanf(optarg, DS_NAM_FMT, ds_nam) != 1) {
294 rrd_set_error("invalid argument for aberrant-reset");
299 if ((ds = ds_match(&rrd, ds_nam)) == -1) {
300 /* ds_match handles it own errors */
305 reset_aberrant_coefficients(&rrd, rrd_file, (unsigned long) ds);
306 if (rrd_test_error()) {
313 strcpy(rrd.stat_head->version, RRD_VERSION); /* smoothing_window causes Version 4 */
315 (&rrd, CF_SEASONAL, RRA_seasonal_smoothing_window, optarg)) {
321 strcpy(rrd.stat_head->version, RRD_VERSION); /* smoothing_window causes Version 4 */
323 (&rrd, CF_DEVSEASONAL, RRA_seasonal_smoothing_window,
331 rrd_set_error("unknown option '%c'", optopt);
333 rrd_set_error("unknown option '%s'", argv[optind - 1]);
340 rrd_seek(rrd_file, 0, SEEK_SET);
341 rrd_write(rrd_file, rrd.stat_head, sizeof(stat_head_t) * 1);
342 rrd_write(rrd_file, rrd.ds_def,
343 sizeof(ds_def_t) * rrd.stat_head->ds_cnt);
344 /* need to write rra_defs for RRA parameter changes */
345 rrd_write(rrd_file, rrd.rra_def,
346 sizeof(rra_def_t) * rrd.stat_head->rra_cnt);
350 for (i = 0; i < (int) rrd.stat_head->ds_cnt; i++)
351 if (dst_conv(rrd.ds_def[i].dst) != DST_CDEF) {
352 printf("DS[%s] typ: %s\thbt: %ld\tmin: %1.4f\tmax: %1.4f\n",
353 rrd.ds_def[i].ds_nam,
355 rrd.ds_def[i].par[DS_mrhb_cnt].u_cnt,
356 rrd.ds_def[i].par[DS_min_val].u_val,
357 rrd.ds_def[i].par[DS_max_val].u_val);
361 rpn_compact2str((rpn_cdefds_t *) &
362 (rrd.ds_def[i].par[DS_cdef]), rrd.ds_def,
364 printf("DS[%s] typ: %s\tcdef: %s\n", rrd.ds_def[i].ds_nam,
365 rrd.ds_def[i].dst, buffer);
377 enum rra_par_en rra_par,
382 signed short rra_idx = -1;
386 if (param <= 0.0 || param >= 1.0) {
387 rrd_set_error("Holt-Winters parameter must be between 0 and 1");
390 /* does the appropriate RRA exist? */
391 for (i = 0; i < rrd->stat_head->rra_cnt; ++i) {
392 if (cf_conv(rrd->rra_def[i].cf_nam) == cf) {
398 rrd_set_error("Holt-Winters RRA does not exist in this RRD");
403 rrd->rra_def[rra_idx].par[rra_par].u_val = param;
410 enum rra_par_en rra_par,
415 signed short rra_idx = -1;
419 /* in order to avoid smoothing of SEASONAL or DEVSEASONAL, we need to
421 if (param < 0.0 || param > 1.0) {
422 rrd_set_error("Holt-Winters parameter must be between 0 and 1");
425 /* does the appropriate RRA exist? */
426 for (i = 0; i < rrd->stat_head->rra_cnt; ++i) {
427 if (cf_conv(rrd->rra_def[i].cf_nam) == cf) {
433 rrd_set_error("Holt-Winters RRA does not exist in this RRD");
438 rrd->rra_def[rra_idx].par[rra_par].u_val = param;
444 enum rra_par_en rra_par,
449 signed short rra_idx = -1;
453 rrd_set_error("Parameter specified is too small");
456 /* does the appropriate RRA exist? */
457 for (i = 0; i < rrd->stat_head->rra_cnt; ++i) {
458 if (cf_conv(rrd->rra_def[i].cf_nam) == CF_FAILURES) {
464 rrd_set_error("Failures RRA does not exist in this RRD");
469 rrd->rra_def[rra_idx].par[rra_par].u_val = param;
475 enum rra_par_en rra_par,
479 unsigned long i, cdp_idx;
480 signed short rra_idx = -1;
484 if (param < 1 || param > MAX_FAILURES_WINDOW_LEN) {
485 rrd_set_error("Parameter must be between %d and %d",
486 1, MAX_FAILURES_WINDOW_LEN);
489 /* does the appropriate RRA exist? */
490 for (i = 0; i < rrd->stat_head->rra_cnt; ++i) {
491 if (cf_conv(rrd->rra_def[i].cf_nam) == CF_FAILURES) {
497 rrd_set_error("Failures RRA does not exist in this RRD");
502 rrd->rra_def[rra_idx].par[rra_par].u_cnt = param;
504 /* erase existing violations */
505 for (i = 0; i < rrd->stat_head->ds_cnt; i++) {
506 cdp_idx = rra_idx * (rrd->stat_head->ds_cnt) + i;
507 erase_violations(rrd, cdp_idx, rra_idx);