Difference between revisions of "V4 to v5 migration guide"

From collectd Wiki
Jump to: navigation, search
(Create initial page.)
 
(Upgrade strategy: Add a step-by-step guide.)
Line 3: Line 3:
 
== Upgrade strategy ==
 
== Upgrade strategy ==
  
''Todo''
+
If you use ''collectd'' in a client / server setup, we recommend to upgrade the server instance(s) first. This allows you to use the [[Target:v5 upgrade|v5 upgrade target]] which transforms data sent by v4 clients to the new v5 layout. Once the server is running v5 and the ''v5 upgrade target'' you can easily upgrade the clients one by one.
 +
 
 +
This step-by-step migration suggestion assumes you have one or more dedicated ''collectd'' servers writing [[RRD]] files. The directive is to upgrade the servers and minimizing the resulting gap in the collected data.
 +
* If you have only ''one server'':
 +
** Set up a second server identical to your production machine. You can use the <code>Forwarding</code> option of the {{Plugin|Network}} or a packet filter such as ''ip_tables'' to send a copy of the network traffic to your clone.
 +
* If you have ''two or more'' redundant servers:
 +
** Enter a downtime for one server in the monitoring and remove it from the load balancing if the server is used to create graphs, too. Let it still receive and handle ''collectd'' traffic, though.
 +
* Adapt the configuration for plugins collecting data locally. Usually this is fairly easy on the central ''collectd'' servers.
 +
* Configure the ''v5&nbsp;upgrade target''. Usually this is as simple as adding the following block to your ''collectd'' configuration:
 +
<Chain "PreCache">
 +
  Target "v5upgrade"
 +
</Chain>
 +
* (Re)start the daemon.
 +
* Look for files that are no longer upgraded and rename them or split them up. Look at [[#Migrating existing RRD files]] for details on this. Possibly ''rsync'' / ''scp'' the RRD files and run the migration script multiple times until you are satisfied with the migrated data.
 +
* On your original server / For each other server:
 +
** Copy the v5 config and adapt hostname / IP-addresses etc.
 +
** Restart the daemon.
 +
** ''rsync'' / ''scp'' the migrated files to get a clean data set without gaps.
  
 
== Migrating the configuration ==
 
== Migrating the configuration ==

Revision as of 11:44, 27 September 2010

Since version 5.* is a different major version than version 4.*, some things have been changed in a backwards incompatible manner. This migration guide is here to help you with the transition.

Upgrade strategy

If you use collectd in a client / server setup, we recommend to upgrade the server instance(s) first. This allows you to use the v5 upgrade target which transforms data sent by v4 clients to the new v5 layout. Once the server is running v5 and the v5 upgrade target you can easily upgrade the clients one by one.

This step-by-step migration suggestion assumes you have one or more dedicated collectd servers writing RRD files. The directive is to upgrade the servers and minimizing the resulting gap in the collected data.

  • If you have only one server:
    • Set up a second server identical to your production machine. You can use the Forwarding option of the Network plugin or a packet filter such as ip_tables to send a copy of the network traffic to your clone.
  • If you have two or more redundant servers:
    • Enter a downtime for one server in the monitoring and remove it from the load balancing if the server is used to create graphs, too. Let it still receive and handle collectd traffic, though.
  • Adapt the configuration for plugins collecting data locally. Usually this is fairly easy on the central collectd servers.
  • Configure the v5 upgrade target. Usually this is as simple as adding the following block to your collectd configuration:
<Chain "PreCache">
  Target "v5upgrade"
</Chain>
  • (Re)start the daemon.
  • Look for files that are no longer upgraded and rename them or split them up. Look at #Migrating existing RRD files for details on this. Possibly rsync / scp the RRD files and run the migration script multiple times until you are satisfied with the migrated data.
  • On your original server / For each other server:
    • Copy the v5 config and adapt hostname / IP-addresses etc.
    • Restart the daemon.
    • rsync / scp the migrated files to get a clean data set without gaps.

Migrating the configuration

This section details which changes you need to make to the configuration file.

FQDNLookup

The default value for FQDNLookup has been changed. It used to be disabled by default and it's now enabled by default. You can use "FQDNLookup false" to configure the old default behavior. Enabling this option is recommended though.

Todo

Migrating existing RRD files

Todo:

Other

Todo: