From 30f15c0632513caff0c322c4cf1a8a1e10d9865c Mon Sep 17 00:00:00 2001 From: Niko Tyni Date: Sat, 26 Feb 2005 18:00:27 +0000 Subject: SYNOPSYS is really spelled SYNOPSIS. Shame on me. --- doc/smokeping_extend.pod | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'doc') diff --git a/doc/smokeping_extend.pod b/doc/smokeping_extend.pod index eef0bf6..402efac 100644 --- a/doc/smokeping_extend.pod +++ b/doc/smokeping_extend.pod @@ -46,7 +46,7 @@ manpage. The supported section names are C, C, C, C, C, C, and C. If you don't need a particular section, just leave it out. -The special sections C and C are automatically +The special sections C and C are automatically generated from the description of your variables. See below. Note that if you use 'here documents' ('<<') that have POD markup inside, @@ -114,7 +114,7 @@ Description of the variable. =item _example -An example value. This will be used in the SYNOPSYS section in the +An example value. This will be used in the SYNOPSIS section in the probe manual. =back @@ -185,7 +185,7 @@ That's it, you're done! =head1 EXAMPLE CONFIGURATIONS If you would like to provide a documented example configuration for your -probe (in addition to the automatically generated SYNOPSYS section in +probe (in addition to the automatically generated SYNOPSIS section in the probe manual), you can do so by adding it to the L module. Look for the 'examples' subroutine and add your example there. -- cgit v1.2.3-24-g4f1b From 1eda41862b7279427ab2da51b8dd12767118bfa4 Mon Sep 17 00:00:00 2001 From: Niko Tyni Date: Wed, 9 Mar 2005 17:17:06 +0000 Subject: * change all ISG::ParseConfig references to its new name, Config::Grammar --- doc/smokeping_extend.pod | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) (limited to 'doc') diff --git a/doc/smokeping_extend.pod b/doc/smokeping_extend.pod index 402efac..0a0eb41 100644 --- a/doc/smokeping_extend.pod +++ b/doc/smokeping_extend.pod @@ -94,13 +94,13 @@ convenience method called C<_makevars> that does this, and the common idiom is } The variables are declared in a syntax that comes from the module used -for parsing the configuration file, C. Each variable +for parsing the configuration file, C. Each variable should be a hash that uses the "special variable keys" documented in -L. See C and the other +L. See C and the other probes for examples. For reference, here are the keys the hash should have. Much of this -is taken straight from the C manual. +is taken straight from the C manual. =over @@ -150,11 +150,11 @@ the returned string as content. The C and C methods should return hash references that contain the variable names as keys and the hashes described above -as values. In addition the C special section key +as values. In addition the C special section key C<_mandatory> is supported and should contain a reference to a list of mandatory variables. The C<_makevars> method is available of this special key and merges the mandatory lists in its arguments. Note that no other -C special section keys are supported. +C special section keys are supported. =head1 INITIALIZATION -- cgit v1.2.3-24-g4f1b From 021947ad8e963d89bdb00bd9de24dc962a3472bf Mon Sep 17 00:00:00 2001 From: Niko Tyni Date: Thu, 10 Mar 2005 11:00:44 +0000 Subject: * 2.0/lib/Smokeping/probes/Curl.pm, 2.0/doc/smokeping_upgrade.pod, 2.0/CHANGES: + new variables: extraargs and extrare --- doc/smokeping_upgrade.pod | 2 ++ 1 file changed, 2 insertions(+) (limited to 'doc') diff --git a/doc/smokeping_upgrade.pod b/doc/smokeping_upgrade.pod index bd3b93a..41e109b 100644 --- a/doc/smokeping_upgrade.pod +++ b/doc/smokeping_upgrade.pod @@ -148,6 +148,8 @@ quotes are not needed anymore around the User-Agent string (the C parameter). Smokeping will complain if it notices quotes around the string. +Any extra arguments for C can now be specified in the C variable. + =item L The default timeout of this probe has been raised to 10 seconds. -- cgit v1.2.3-24-g4f1b From 292c6fc1ffce6460bd8fa97d31b912da3a90673b Mon Sep 17 00:00:00 2001 From: Niko Tyni Date: Tue, 10 May 2005 18:10:14 +0000 Subject: * branches/2.0/doc/smokeping_upgrade.pod; branches/2.0/CHANGES: + changelog updates --- doc/smokeping_upgrade.pod | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) (limited to 'doc') diff --git a/doc/smokeping_upgrade.pod b/doc/smokeping_upgrade.pod index 41e109b..ad7b595 100644 --- a/doc/smokeping_upgrade.pod +++ b/doc/smokeping_upgrade.pod @@ -23,7 +23,7 @@ An official list of changes with each release can be found in the CHANGES file in the Smokeping distribution. This document tries to complement that with upgrading instructions etc. -=head1 1.38 to 2.0 +=head1 1.40 to 2.0 The biggest change with the 2.0 release is that the configuration file is now parsed much more strictly. This should result in (hopefully @@ -199,6 +199,17 @@ in the C variable, like it is with all the other probes. =back +=head1 1.38 to 1.40 + +=over + +=item The new navigation feature + +The big visible difference between 1.38 and 1.40 is the new browser navigation +feature: when clicking on the graphs in detail view you can select +different time ranges for the graph. The creation of this +feature has been sponsored by BeverlyCorp.com. + =head1 1.34 to 1.37 =over -- cgit v1.2.3-24-g4f1b From 54b0cfd69a5ea9dd38b27bb1b6880b97bf9bc27d Mon Sep 17 00:00:00 2001 From: Niko Tyni Date: Wed, 1 Jun 2005 11:29:44 +0000 Subject: * 2.0/doc/smokeping_upgrade.pod: + mention tSmoke inclusion * 2.0/bin/tSmoke.dist, 2.0/Makefile: + make tSmoke require the current Smokeping.pm version + add tSmoke to the 'patch' Makefile target to keep it up to date * 2.0/etc/config.dist: + add the 'tmail' variable * 2.0/CHANGES: + mention Dan as the original tSmoke author --- doc/smokeping_upgrade.pod | 7 +++++++ 1 file changed, 7 insertions(+) (limited to 'doc') diff --git a/doc/smokeping_upgrade.pod b/doc/smokeping_upgrade.pod index ad7b595..046afdf 100644 --- a/doc/smokeping_upgrade.pod +++ b/doc/smokeping_upgrade.pod @@ -32,6 +32,13 @@ trial-and-error variety than it used to be. It also automates the generation of the configuration documentation from the source code, so the docs are now more accurate. +A smaller change worth mentioning is the inclusion of the tSmoke script +(contributed by Dan McGinn-Combs) for sending summary emails on daily +and weekly system status. Note that it needs the new 'tmail' variable +to be defined in the config file. + +=head2 CONFIGURATION + The configuration syntax has stayed mostly the same, except for the issues below. -- cgit v1.2.3-24-g4f1b From 2f01fa7db139ec0141bf5e7f8d8e2223069d3c68 Mon Sep 17 00:00:00 2001 From: Niko Tyni Date: Thu, 18 Aug 2005 20:20:00 +0000 Subject: * branches/2.0/doc/smokeping_upgrade.pod: + document the tuning of RRD DS parameters --- doc/smokeping_upgrade.pod | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'doc') diff --git a/doc/smokeping_upgrade.pod b/doc/smokeping_upgrade.pod index 046afdf..61277fc 100644 --- a/doc/smokeping_upgrade.pod +++ b/doc/smokeping_upgrade.pod @@ -112,10 +112,10 @@ and measuring and visualizing the variation between them. Smokeping now checks at startup that the parameters of any existing RRD files match those specified in the configuration file. If there is a discrepancy, -it will give an error message and refuse to start. +it will try to fix the situation and refuse to start if it can't. -This situation is most likely to happen if you have modified the C -or C variables in your configuration file. You'll then have to +This situation is most likely to happen if you have modified the +C variable in your configuration file. You'll then have to delete the old RRD file or somehow convert it to use the new parameters. The C command might be helpful here. -- cgit v1.2.3-24-g4f1b From 3946df708ae20686c8453eb55be934103daf2f7e Mon Sep 17 00:00:00 2001 From: Niko Tyni Date: Sun, 4 Sep 2005 11:34:08 +0000 Subject: * lib/Smokeping.pm, lib/Smokeping/probes/base.pm, doc/smokeping_upgrade.pod, TODO, CHANGES: + the DYNAMIC-related files (.adr and .snmp) can now be located outside "datadir" by specifying the new configuration variable "dyndir" --- doc/smokeping_upgrade.pod | 11 +++++++++++ 1 file changed, 11 insertions(+) (limited to 'doc') diff --git a/doc/smokeping_upgrade.pod b/doc/smokeping_upgrade.pod index 61277fc..df5013b 100644 --- a/doc/smokeping_upgrade.pod +++ b/doc/smokeping_upgrade.pod @@ -119,6 +119,17 @@ C variable in your configuration file. You'll then have to delete the old RRD file or somehow convert it to use the new parameters. The C command might be helpful here. +=item Configurable location for DYNAMIC-related files + +There is now a new configuration variable, C, that can be used +to specify the location of the DYNAMIC-related files (.adr and .snmp). +These files used to be kept under C along with the RRD files, +but since they need to be writable by the web server, it may be useful +to separate these. + +If C is not specified, Smokeping will use the C value +as the default. This should ensure that no existing setups will break. + =back In addition to this, some probes have had minor incompatible changes to -- cgit v1.2.3-24-g4f1b