X-Git-Url: https://git.tokkee.org/?p=pkg-rrdtool.git;a=blobdiff_plain;f=doc%2Frrdtune.txt;h=b9a14ddc223b545c1d4b64f37646110fb5c5c3fe;hp=b300baaa4bde8db1b0a6121969ec0a9cff651617;hb=51c3d3fb997c22e1ee828470413f1e84989e1f6c;hpb=1559397b94b4af3de73cfa23c04be31d8bee53e7 diff --git a/doc/rrdtune.txt b/doc/rrdtune.txt index b300baa..b9a14dd 100644 --- a/doc/rrdtune.txt +++ b/doc/rrdtune.txt @@ -6,15 +6,16 @@ NNAAMMEE rrdtune - Modify some basic properties of a Round Robin Database SSYYNNOOPPSSIISS - rrrrddttooooll ttuunnee _f_i_l_e_n_a_m_e [----hheeaarrttbbeeaatt|--hh _d_s_-_n_a_m_e:_h_e_a_r_t_b_e_a_t] [----mmiinnii-- - mmuumm|--ii _d_s_-_n_a_m_e:_m_i_n] [----mmaaxxiimmuumm|--aa _d_s_-_n_a_m_e:_m_a_x] + rrrrddttooooll ttuunnee _f_i_l_e_n_a_m_e [----hheeaarrttbbeeaatt|--hh _d_s_-_n_a_m_e:_h_e_a_r_t_b_e_a_t] + [----mmiinniimmuumm|--ii _d_s_-_n_a_m_e:_m_i_n] [----mmaaxxiimmuumm|--aa _d_s_-_n_a_m_e:_m_a_x] [----ddaattaa--ssoouurrccee--ttyyppee|--dd _d_s_-_n_a_m_e:_D_S_T] [----ddaattaa--ssoouurrccee--rreennaammee|--rr _o_l_d_- _n_a_m_e:_n_e_w_-_n_a_m_e] [----ddeellttaappooss _s_c_a_l_e_-_v_a_l_u_e] [----ddeellttaanneegg _s_c_a_l_e_-_v_a_l_u_e] [----ffaaiilluurree--tthhrreesshhoolldd _f_a_i_l_u_r_e_-_t_h_r_e_s_h_o_l_d] [----wwiinnddooww--lleennggtthh _w_i_n_d_o_w_-_l_e_n_g_t_h] - [----aallpphhaa _a_d_a_p_t_i_o_n_-_p_a_r_a_m_e_t_e_r] [----bbeettaa _a_d_a_p_t_i_o_n_-_p_a_r_a_m_e_t_e_r] [----ggaammmmaa _a_d_a_p_- - _t_i_o_n_-_p_a_r_a_m_e_t_e_r] [----ggaammmmaa--ddeevviiaattiioonn _a_d_a_p_t_i_o_n_-_p_a_r_a_m_e_t_e_r] [----ssmmooootthh-- - iinngg--wwiinnddooww _f_r_a_c_t_i_o_n_-_o_f_-_s_e_a_s_o_n] [----ssmmooootthhiinngg--wwiinnddooww--ddeevviiaattiioonn _f_r_a_c_t_i_o_n_- - _o_f_-_s_e_a_s_o_n] [----aabbeerrrraanntt--rreesseett _d_s_-_n_a_m_e] + [----aallpphhaa _a_d_a_p_t_i_o_n_-_p_a_r_a_m_e_t_e_r] [----bbeettaa _a_d_a_p_t_i_o_n_-_p_a_r_a_m_e_t_e_r] + [----ggaammmmaa _a_d_a_p_t_i_o_n_-_p_a_r_a_m_e_t_e_r] [----ggaammmmaa--ddeevviiaattiioonn _a_d_a_p_t_i_o_n_-_p_a_r_a_m_e_t_e_r] + [----ssmmooootthhiinngg--wwiinnddooww _f_r_a_c_t_i_o_n_-_o_f_-_s_e_a_s_o_n] + [----ssmmooootthhiinngg--wwiinnddooww--ddeevviiaattiioonn _f_r_a_c_t_i_o_n_-_o_f_-_s_e_a_s_o_n] [----aabbeerrrraanntt--rreesseett _d_s_- + _n_a_m_e] DDEESSCCRRIIPPTTIIOONN The tune option allows you to alter some of the basic configuration @@ -57,9 +58,9 @@ DDEESSCCRRIIPPTTIIOONN confidence band used internally to calculate violations for the FAILURES RRRRAA. The default value is 2. Note that this parameter is not related to graphing confidence bounds which must be - specified as a CDEF argument to generate a graph with confi- - dence bounds. The graph scale factor need not to agree with the - value used internally by the FAILURES RRRRAA. + specified as a CDEF argument to generate a graph with + confidence bounds. The graph scale factor need not to agree + with the value used internally by the FAILURES RRRRAA. ----ddeellttaanneegg _s_c_a_l_e_-_v_a_l_u_e Alter the deviation scaling factor for the lower bound of the @@ -73,24 +74,24 @@ DDEESSCCRRIIPPTTIIOONN a failure for purposes of the FAILURES RRRRAA. This must be an integer less than or equal to the window length of the FAILURES RRRRAA. This restriction is not verified by the tune option, so - one can reset failure-threshold and window-length simultane- - ously. Setting this option will reset the count of violations - to 0. + one can reset failure-threshold and window-length + simultaneously. Setting this option will reset the count of + violations to 0. ----wwiinnddooww--lleennggtthh _w_i_n_d_o_w_-_l_e_n_g_t_h Alter the number of time points in the temporal window for determining failures. This must be an integer greater than or equal to the window length of the FAILURES RRRRAA and less than or - equal to 28. Setting this option will reset the count of viola- - tions to 0. + equal to 28. Setting this option will reset the count of + violations to 0. ----aallpphhaa _a_d_a_p_t_i_o_n_-_p_a_r_a_m_e_t_e_r Alter the intercept adaptation parameter for the Holt-Winters forecasting algorithm. This parameter must be between 0 and 1. ----bbeettaa _a_d_a_p_t_i_o_n_-_p_a_r_a_m_e_t_e_r - Alter the slope adaptation parameter for the Holt-Winters fore- - casting algorithm. This parameter must be between 0 and 1. + Alter the slope adaptation parameter for the Holt-Winters + forecasting algorithm. This parameter must be between 0 and 1. ----ggaammmmaa _a_d_a_p_t_i_o_n_-_p_a_r_a_m_e_t_e_r Alter the seasonal coefficient adaptation parameter for the @@ -111,17 +112,17 @@ DDEESSCCRRIIPPTTIIOONN ----aabbeerrrraanntt--rreesseett _d_s_-_n_a_m_e This option causes the aberrant behavior detection algorithm to reset for the specified data source; that is, forget all it is - has learnt so far. Specifically, for the HWPREDICT or MHWPRE- - DICT RRRRAA, it sets the intercept and slope coefficients to - unknown. For the SEASONAL RRRRAA, it sets all seasonal coeffi- - cients to unknown. For the DEVSEASONAL RRRRAA, it sets all sea- - sonal deviation coefficients to unknown. For the FAILURES RRRRAA, - it erases the violation history. Note that reset does not erase - past predictions (the values of the HWPREDICT or MHWPREDICT - RRRRAA), predicted deviations (the values of the DEVPREDICT RRRRAA), - or failure history (the values of the FAILURES RRRRAA). This - option will function even if not all the listed RRRRAAss are - present. + has learnt so far. Specifically, for the HWPREDICT or + MHWPREDICT RRRRAA, it sets the intercept and slope coefficients to + unknown. For the SEASONAL RRRRAA, it sets all seasonal + coefficients to unknown. For the DEVSEASONAL RRRRAA, it sets all + seasonal deviation coefficients to unknown. For the FAILURES + RRRRAA, it erases the violation history. Note that reset does not + erase past predictions (the values of the HWPREDICT or + MHWPREDICT RRRRAA), predicted deviations (the values of the + DEVPREDICT RRRRAA), or failure history (the values of the FAILURES + RRRRAA). This option will function even if not all the listed + RRRRAAss are present. Due to the implementation of this option, there is an indirect impact on other data sources in the RRD. A smoothing algorithm @@ -136,8 +137,8 @@ DDEESSCCRRIIPPTTIIOONN period of the reset data source. Use of this tuning option is advised when the behavior of the - data source time series changes in a drastic and permanent man- - ner. + data source time series changes in a drastic and permanent + manner. EEXXAAMMPPLLEE 11 "rrdtool tune data.rrd -h in:100000 -h out:100000 -h through:100000" @@ -159,4 +160,4 @@ AAUUTTHHOORR -1.3.7 2008-03-15 RRDTUNE(1) +1.3.8 2008-03-15 RRDTUNE(1)