src/collectd.conf.pod

   1 =head1 NAME
   2
   3 collectd.conf - Configuration for the system statistics collection daemon B<collectd>
   4
   5 =head1 SYNOPSIS
   6
   7   BaseDir "/path/to/data/"
   8   PIDFile "/path/to/pidfile/collectd.pid"
   9   Server  "123.123.123.123" 12345
  10
  11   LoadPlugin cpu
  12   LoadPlugin load
  13   LoadPlugin ping
  14
  15   <Plugin ping>
  16     Host "example.org"
  17     Host "provider.net"
  18   </Plugin>
  19
  20 =head1 DESCRIPTION
  21
  22 This config file controls how the system statistics collection daemon
  23 B<collectd> behaves. The most significant option is B<LoadPlugin>, which
  24 controls which plugins to load. These plugins ultimately define collectd's
  25 behavior.
  26
  27 The syntax of this config file is similar to the config file of the famos
  28 B<Apache Webserver>. Each line contains either a key-value-pair or a
  29 section-start or -end. Empty lines and everything after the hash-symbol `#' is
  30 ignored. Values are either string, enclosed in double-quotes,
  31 (floating-point-)numbers or a boolean expression, i.E<nbsp>e. either B<true> or
  32 B<false>. String containing of only alphanumeric characters and underscores do
  33 not need to be quoted.
  34
  35 =head1 GLOBAL OPTIONS
  36
  37 =over 4
  38
  39 =item B<BaseDir> I<Directory>
  40
  41 Sets the base directory. This is the directory beneath all RRD-files are
  42 created. Possibly more subdirectories are created. This is also the working
  43 directory for the daemon.
  44
  45 =item B<LoadPlugin> I<Plugin>
  46
  47 Loads the plugin I<Plugin>. There must be at least one such line or B<collectd>
  48 will be mostly useless.
  49
  50 =item B<PIDFile> I<File>
  51
  52 Sets where to write the PID file to. This file is overwritten when it exists
  53 and deleted when the program ist stopped. Some init-scripts might override this
  54 setting using the B<-P> commandline option.
  55
  56 =item B<PluginDir> I<Directory>
  57
  58 Path to the plugins (shared objects) of collectd.
  59
  60 =item B<TypesDB> I<File>
  61
  62 Set the file that contains the data-set descriptions.
  63
  64 =item B<Interval> I<Seconds>
  65
  66 Configures the interval in which to query the read plugins. Obviously smaller
  67 values lead to a higher system load produces by collectd, while higher values
  68 lead to more coarse statistics.
  69
  70 =item B<ReadThreads> I<Num>
  71
  72 Number of threads to start for reading plugins. The default value if B<5>, but
  73 you may want to increase this if you have more than five plugins that take a
  74 long time to read. Mostly those are plugin that do network-IO. Setting this to
  75 a value higher than the number of plugins you've loaded is totally useless.
  76
  77 =back
  78
  79 =head1 PLUGIN OPTIONS
  80
  81 Some Plugins may register own options. These options must be enclosed in a
  82 C<Plugin>-Section. Which options exist depends on the plugin used. Some plugins
  83 require external configuration, too. The C<apache plugin>, for example,
  84 required C<mod_status> to be configured in the webserver you're going to
  85 collect data from. These plugins are listed below as well, even if they don't
  86 require any configuration within collectd's configfile.
  87
  88 A list of all plugins and a short summary for each plugin can be found in the
  89 F<README> file shipped with the sourcecode and hopefully binary packets as
  90 well.
  91
  92 =head2 Plugin C<apache>
  93
  94 To configure the C<apache>-plugin you first need to configure the Apache
  95 webserver correctly. The Apache-plugin C<mod_status> needs to be loaded and
  96 working and the C<ExtendedStatus> directive needs to be B<enabled>. You can use
  97 the following snipped to base your Apache config upon:
  98
  99   ExtendedStatus on
 100   <IfModule mod_status.c>
 101     <Location /mod_status>
 102       SetHandler server-status
 103     </Location>
 104   </IfModule>
 105
 106 Since its C<mod_status> module is very similar to Apache's, B<lighttpd> is
 107 also supported. It introduces a new field, called C<BusyServers>, to count the
 108 number of currently connected clients. This field is also supported.
 109
 110 The following options are accepted by the C<apache>-plugin:
 111
 112 =over 4
 113
 114 =item B<URL> I<http://host/mod_status?auto>
 115
 116 Sets the URL of the C<mod_status> output. This needs to be the output generated
 117 by C<ExtendedStatus on> and it needs to be the machine readable output
 118 generated by appending the C<?auto> argument.
 119
 120 =item B<User> I<Username>
 121
 122 Optional user name needed for authentication.
 123
 124 =item B<Password> I<Password>
 125
 126 Optional password needed for authentication.
 127
 128 =item B<CACert> I<File>
 129
 130 File that holds one or more SSL certificates. If you want to use HTTPS you will
 131 possibly need this option. What CA certificates come bundled with C<libcurl>
 132 and are checked by default depends on the distribution you use.
 133
 134 =back
 135
 136 =head2 Plugin C<apcups>
 137
 138 =over 4
 139
 140 =item B<Host> I<Hostname>
 141
 142 Hostname of the host running B<apcupsd>. Defaults to B<localhost>. Please note
 143 that IPv6 support has been disabled unless someone can confirm or decline that
 144 B<apcupsd> can handle it.
 145
 146 =item B<Port> I<Port>
 147
 148 TCP-Port to connect to. Defaults to B<3551>.
 149
 150 =back
 151
 152 =head2 Plugin C<cpufreq>
 153
 154 This plugin doesn't have any options. It reads
 155 F</sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq> (for the first CPU
 156 installed) to get the current CPU frequency. If this file does not exist make
 157 sure B<cpufreqd> (L<http://cpufreqd.sourceforge.net/>) or a similar tool is
 158 installed and an "cpu governor" (that's a kernel module) is loaded.
 159
 160 =head2 Plugin C<csv>
 161
 162 =over 4
 163
 164 =item B<DataDir> I<Directory>
 165
 166 Set the directory to store RRD-files under. Per default RRD-files are generated
 167 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
 168
 169 =back
 170
 171 =head2 Plugin C<df>
 172
 173 =over 4
 174
 175 =item B<Device> I<Device>
 176
 177 Select partitions based on the devicename.
 178
 179 =item B<MountPoint> I<Directory>
 180
 181 Select partitions based on the mountpoint.
 182
 183 =item B<FSType> I<FSType>
 184
 185 Select partitions based on the filesystem type.
 186
 187 =item B<IgnoreSelected> I<true>|I<false>
 188
 189 Invert the selection: If set to true, all partitions B<except> the ones that
 190 match any one of the criteria are collected. By default only selected
 191 partitions are collected if a selection is made. If no selection is configured
 192 at all, B<all> partitions are selected.
 193
 194 =back
 195
 196 =head2 Plugin C<dns>
 197
 198 =over 4
 199
 200 =item B<Interface> I<Interface>
 201
 202 The dns plugin uses B<libpcap> to capture dns traffic and analyses it. This
 203 option sets the interface that should be used. If this option is not set, or
 204 set to "any", the plugin will try to get packets from B<all> interfaces. This
 205 may not work on certain platforms, such as MacE<nbsp>OSE<nbsp>X.
 206
 207 =item B<IgnoreSource> I<IP-address>
 208
 209 Ignore packets that originate from this address.
 210
 211 =back
 212
 213 =head2 Plugin C<email>
 214
 215 =over 4
 216
 217 =item B<SocketFile> I<Path>
 218
 219 Sets the socket-file which is to be created.
 220
 221 =item B<SocketGroup> I<Group>
 222
 223 If running as root change the group of the UNIX-socket after it has been
 224 created. Defaults to B<collectd>.
 225
 226 =item B<SocketPerms> I<Permissions>
 227
 228 Change the file permissions of the UNIX-socket after it has been created. The
 229 permissions must be given as a numeric, octal value as you would pass to
 230 L<chmod(1)>. Defaults to B<0770>.
 231
 232 =item B<MaxConns> I<Number>
 233
 234 Sets the maximum number of connections that can be handled in parallel. Since
 235 this many threads will be started immediately setting this to a very high
 236 value will waste valuable resources. Defaults to B<5> and will be forced to be
 237 at most B<16384> to prevent typos and dumb mistakes.
 238
 239 =back
 240
 241 =head2 Plugin C<exec>
 242
 243 Please make sure to read L<collectd-exec(5)> before using this plugin. It
 244 contains valuable information on when the executable is executed and the
 245 output that is expected from it.
 246
 247 =over 4
 248
 249 =item B<Exec> I<User> I<Executable>
 250
 251 Execute the executable I<Executable> as user I<User>.
 252
 253 =back
 254
 255 =head2 Plugin C<hddtemp>
 256
 257 To get values from B<hddtemp> collectd connects to B<localhost> (127.0.0.1),
 258 port B<7634/tcp>. The B<Host> and B<Port> options can be used to change these
 259 default values, see below. C<hddtemp> has to be running to work correctly. If
 260 C<hddtemp> is not running timeouts may appear which may interfere with other
 261 statistics..
 262
 263 The B<hddtemp> homepage can be found at
 264 L<http://www.guzu.net/linux/hddtemp.php>.
 265
 266 =over 4
 267
 268 =item B<Host> I<Hostname>
 269
 270 Hostname to connect to. Defaults to B<127.0.0.1>.
 271
 272 =item B<Port> I<Port>
 273
 274 TCP-Port to connect to. Defaults to B<7634>.
 275
 276 =back
 277
 278 =head2 Plugin C<interface>
 279
 280 =over 4
 281
 282 =item B<Interface> I<Interface>
 283
 284 Select this interface. By default these interfaces will then be collected. For
 285 a more detailed description see B<IgnoreSelected> below.
 286
 287 =item B<IgnoreSelected> I<true>|I<false>
 288
 289 If no configuration if given, the B<traffic>-plugin will collect data from
 290 all interfaces. This may not be practical, especially for loopback- and
 291 similar interfaces. Thus, you can use the B<Interface>-option to pick the
 292 interfaces you're interested in. Sometimes, however, it's easier/preferred
 293 to collect all interfaces I<except> a few ones. This option enables you to
 294 do that: By setting B<IgnoreSelected> to I<true> the effect of
 295 B<Interface> is inversed: All selected interfaces are ignored and all
 296 other interfaces are collected.
 297
 298 =back
 299
 300 =head2 Plugin C<iptables>
 301
 302 =over 4
 303
 304 =item B<Chain> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
 305
 306 Select the rules to count. If only I<Table> and I<Chain> are given, this plugin
 307 will collect the counters of all rules which have a comment-match. The comment
 308 is then used as type-instance.
 309
 310 If I<Comment> or I<Number> is given, only the rule with the matching comment or
 311 the I<n>th rule will be collected. Again, the comment (or the number) will be
 312 used as the type-instance.
 313
 314 If I<Name> is supplied, it will be used as the type-instance instead of the
 315 comment or the number.
 316
 317 =back
 318
 319 =head2 Plugin C<irq>
 320
 321 =over 4
 322
 323 =item B<Irq> I<Irq>
 324
 325 Select this irq. By default these irqs will then be collected. For a more
 326 detailed description see B<IgnoreSelected> below.
 327
 328 =item B<IgnoreSelected> I<true>|I<false>
 329
 330 If no configuration if given, the B<irq>-plugin will collect data from all
 331 irqs. This may not be practical, especially if no interrupts happen. Thus, you
 332 can use the B<Irq>-option to pick the interrupt you're interested in.
 333 Sometimes, however, it's easier/preferred to collect all interrupts I<except> a
 334 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
 335 I<true> the effect of B<Irq> is inversed: All selected interrupts are ignored
 336 and all other interrupts are collected.
 337
 338 =back
 339
 340 =head2 Plugin C<logfile>
 341
 342 =over 4
 343
 344 =item B<LogLevel> B<debug|info|notice|warning|err>
 345
 346 Sets the log-level. If, for example, set to B<notice>, then all events with
 347 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
 348
 349 =item B<File> I<File>
 350
 351 Sets the file to write log messages to. The special strings B<stdout> and
 352 B<stderr> can be used to write to the standard output and standard error
 353 channels, respectively. This, of course, only makes much sense when collectd is
 354 running in foreground- or non-daemon-mode.
 355
 356 =back
 357
 358 =head2 Plugin C<mbmon>
 359
 360 The C<mbmon plugin> uses mbmon to retrieve temperature, voltage, etc.
 361
 362 Be default collectd connects to B<localhost> (127.0.0.1), port B<411/tcp>.  The
 363 B<Host> and B<Port> options can be used to change these values, see below.
 364 C<mbmon> has to be running to work correctly. If C<mbmon> is not running
 365 timeouts may appear which may interfere with other statistics..
 366
 367 C<mbmon> must be run with the -r option ("print TAG and Value format");
 368 Debian's F</etc/init.d/mbmon> script already does this, other people
 369 will need to ensure that this is the case.
 370
 371 =over 4
 372
 373 =item B<Host> I<Hostname>
 374
 375 Hostname to connect to. Defaults to B<127.0.0.1>.
 376
 377 =item B<Port> I<Port>
 378
 379 TCP-Port to connect to. Defaults to B<411>.
 380
 381 =back
 382
 383 =head2 Plugin C<mysql>
 384
 385 The C<mysql plugin> requires B<mysqlclient> to be installed. It connects to the
 386 database when started and keeps the connection up as long as possible. When the
 387 connection is interrupted for whatever reason it will try to re-connect. The
 388 plugin logs loud complaints in case anything goes wrong.
 389
 390 This plugin issues C<SHOW STATUS> and evaluates C<Bytes_{received,sent}>,
 391 C<Com_*> and C<Handler_*> which correspond to F<mysql_octets.rrd>,
 392 F<mysql_commands-*.rrd> and F<mysql_handler-*.rrd>. Also, the values of
 393 C<Qcache_*> are put in F<mysql_qcache.rrd> and values of C<Threads_*> are put
 394 in F<mysql_threads.rrd>. Please refer to the B<MySQL reference manual>,
 395 I<5.2.4. Server Status Variables> for an explanation of these values.
 396
 397 Use the following options to configure the plugin:
 398
 399 =over 4
 400
 401 =item B<Host> I<Hostname>
 402
 403 Hostname of the database server. Defaults to B<localhost>.
 404
 405 =item B<User> I<Username>
 406
 407 Username to use when connecting to the database.
 408
 409 =item B<Password> I<Password>
 410
 411 Password needed to log into the database.
 412
 413 =item B<Database> I<Database>
 414
 415 Select this database. Defaults to I<no database> which is a perfectly reasonable
 416 option for what this plugin does.
 417
 418 =back
 419
 420 =head2 Plugin C<network>
 421
 422 =over 4
 423
 424 =item B<Listen> I<Host> [I<Port>]
 425
 426 =item B<Server> I<Host> [I<Port>]
 427
 428 The B<Server> statement sets the server to send datagrams B<to>.  The statement
 429 may occur multiple times to send each datagram to multiple destinations.
 430
 431 The B<Listen> statement sets the interfaces to bind to. When multiple
 432 statements are found the daemon will bind to multiple interfaces.
 433
 434 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
 435 the argument is a multicast address the daemon will join that multicast group.
 436
 437 If no B<Listen> statement is found the server tries join both, the default IPv6
 438 multicast group and the default IPv4 multicast group. If no B<Server> statement
 439 is found the client will try to send data to the IPv6 multicast group first. If
 440 that fails the client will try the IPv4 multicast group.
 441
 442 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
 443 multicast group is C<239.192.74.66>.
 444
 445 The optional I<Port> argument sets the port to use. It can either be given
 446 using a numeric port number or a service name. If the argument is omitted the
 447 default port B<25826> is assumed.
 448
 449 =item B<TimeToLive> I<1-255>
 450
 451 Set the time-to-live of sent packets. This applies to all, unicast and
 452 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
 453 That means that multicast packets will be sent with a TTL of C<1> (one) on most
 454 operating systems.
 455
 456 =item B<Forward> I<true|false>
 457
 458 If set to I<true>, write packets that were received via the network plugin to
 459 the sending sockets. This should only be activated when the B<Listen>- and
 460 B<Server>-statements differ. Otherwise packets may be send multiple times to
 461 the same multicast group. While this results in more network traffic than
 462 necessary it's not a huge problem since the plugin has a duplicate detection,
 463 so the values will not loop.
 464
 465 =item B<CacheFlush> I<Seconds>
 466
 467 For each host/plugin/type combination the C<network plugin> caches the time of
 468 the last value being sent or received. Every I<Seconds> seconds the plugin
 469 searches and removes all entries that are older than I<Seconds> seconds, thus
 470 freeing the unused memory again. Since this process is somewhat expensive and
 471 normally doesn't do much, this value should not be too small. The default is
 472 1800 seconds, but setting this to 86400 seconds (one day) will not do much harm
 473 either.
 474
 475 =back
 476
 477 =head2 Plugin C<ntpd>
 478
 479 =over 4
 480
 481 =item B<Host> I<Hostname>
 482
 483 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
 484
 485 =item B<Port> I<Port>
 486
 487 UDP-Port to connect to. Defaults to B<123>.
 488
 489 =back
 490
 491 =head2 Plugin C<nut>
 492
 493 =over 4
 494
 495 =item B<UPS> I<upsname>B<@>I<hostname>[B<:>I<port>]
 496
 497 Add a UPS to collect data from. The format is identical to the one accepted by
 498 L<upsc(8)>.
 499
 500 =back
 501
 502 =head2 Plugin C<perl>
 503
 504 =over 4
 505
 506 =item B<LoadPlugin> I<Plugin>
 507
 508 Loads the Perl plugin I<Plugin>. This does basically the same as B<use> would
 509 do in a Perl program.
 510
 511 =item B<BaseName> I<Name>
 512
 513 Prepends I<Name>B<::> to all plugin names loaded after this option. This is
 514 provided for convenience to keep plugin names short.
 515
 516 =item B<IncludeDir> I<Dir>
 517
 518 Adds I<Dir> to the B<@INC> array. This is the same as using the B<-IDir>
 519 command line option or B<use lib Dir> in the source code.
 520
 521 =back
 522
 523 =head2 Plugin C<ping>
 524
 525 =over 4
 526
 527 =item B<Host> I<IP-address>
 528
 529 Host to ping periodically. This option may be repeated several times to ping
 530 multiple hosts.
 531
 532 =item B<TTL> I<0-255>
 533
 534 Sets the Time-To-Live of generated ICMP packets.
 535
 536 =back
 537
 538 =head2 Plugin C<processes>
 539
 540 =over 4
 541
 542 =item B<Process> I<Name>
 543
 544 Select more detailed statistics of processes matching this name. The statistics
 545 collected for these selected processes are size of the resident segment size
 546 (RSS), user- and system-time used, number of processes and number of threads,
 547 and minor and major pagefaults.
 548
 549 =back
 550
 551 =head2 Plugin C<rrdtool>
 552
 553 You can use the settings B<StepSize>, B<HeartBeat>, B<RRARows>, and B<XFF> to
 554 finetune your RRD-files. Please read L<rrdcreate(1)> if you encounter problems
 555 using these settings. If you don't want to dive into the depths of RRDTool, you
 556 can safely ignore these settings.
 557
 558 =over 4
 559
 560 =item B<DataDir> I<Directory>
 561
 562 Set the directory to store RRD-files under. Per default RRD-files are generated
 563 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
 564
 565 =item B<StepSize> I<Seconds>
 566
 567 Sets the stepsize of newly created RRD-files. Ideally (and per default) this
 568 setting is identical to the global B<Interval>-option and should not be
 569 smaller. If unsure, don't set this option.
 570
 571 =item B<HeartBeat> I<Seconds>
 572
 573 Sets the heartbeat of newly created RRD-files. Ideally this setting is bigger
 574 than the B<Interval>-setting, by default it's twice the B<Interval>-setting. If
 575 unsure, don't set this option.
 576
 577 =item B<RRARows> I<NumRows>
 578
 579 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
 580 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
 581 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
 582 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
 583 week, one month, and one year.
 584
 585 So for each timespan, it calculates how many PDPs need to be consolidated into
 586 one CDP by calculating:
 587   number of PDPs = timespan / (stepsize * rrarows)
 588
 589 Bottom line is, set this no smaller than the width of you graphs in pixels. The
 590 default is 1200.
 591
 592 =item B<RRATimespan> I<Seconds>
 593
 594 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
 595 more then one RRA. If this option is never used, the built-in default of (3600,
 596 86400, 604800, 2678400, 31622400) is used.
 597
 598 For more information on how RRA-sizes are calculated see B<RRARows> above.
 599
 600 =item B<XFF> I<Factor>
 601
 602 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
 603
 604 =item B<CacheFlush> I<Seconds>
 605
 606 When the C<rrdtool plugin> uses a cache (by setting B<CacheTimeout>, see below)
 607 it writes all values for a certain RRD-file if the oldest value is older than
 608 (or equal to) the number of seconds specified. If some RRD-file is not updated
 609 anymore for some reason (the computer was shut down, the network is broken,
 610 etc.) some values may still be in the cache. If B<CacheFlush> is set, then the
 611 entire cache is searched for entries older than B<CacheTimeout> seconds and
 612 written to disk every I<Seconds> seconds. Since this is kind of expensive and
 613 does nothing under normal circumstances, this value should not be too small.
 614 900 seconds might be a good value, though setting this to 7200 seconds doesn't
 615 normally do much harm either.
 616
 617 =item B<CacheTimeout> I<Seconds>
 618
 619 If this option is set to a value greater than zero, the C<rrdtool plugin> will
 620 save values in a cache, as described above. Writing multiple values at once
 621 reduces IO-operations and thus lessens the load produced by updating the files.
 622 The tradeoff is that the graphs kind of "drag behind" and that more memory is
 623 used.
 624
 625 =back
 626
 627 =head2 Plugin C<sensors>
 628
 629 The C<sensors plugin> uses B<lm_sensors> to retrieve sensor-values. This means
 630 that all the needed modules have to be loaded and lm_sensors has to be
 631 configured (most likely by editing F</etc/sensors.conf>. Read
 632 L<sensors.conf(5)> for details.
 633
 634 The B<lm_sensors> homepage can be found at
 635 L<http://secure.netroedge.com/~lm78/>.
 636
 637 =over 4
 638
 639 =item B<Sensor> I<chip-bus-address/type-feature>
 640
 641 Selects the name of the sensor which you want to collect or ignore, depending
 642 on the B<IgnoreSelected> below. For example, the option "B<Sensor>
 643 I<it8712-isa-0290/voltage-in1>" will cause collectd to gather data for the
 644 voltage sensor I<in1> of the I<it8712> on the isa bus at the address 0290.
 645
 646 =item B<IgnoreSelected> I<true>|I<false>
 647
 648 If no configuration if given, the B<sensors>-plugin will collect data from all
 649 sensors. This may not be practical, especially for uninteresting sensors.
 650 Thus, you can use the B<Sensor>-option to pick the sensors you're interested
 651 in. Sometimes, however, it's easier/preferred to collect all sensors I<except> a
 652 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
 653 I<true> the effect of B<Sensor> is inversed: All selected sensors are ignored
 654 and all other sensors are collected.
 655
 656 =back
 657
 658 =head2 Plugin C<syslog>
 659
 660 =over 4
 661
 662 =item B<LogLevel> B<debug|info|notice|warning|err>
 663
 664 Sets the log-level. If, for example, set to B<notice>, then all events with
 665 severity B<notice>, B<warning>, or B<err> will be submitted to the
 666 syslog-daemon.
 667
 668 =back
 669
 670 =head2 Plugin C<unixsock>
 671
 672 =over 4
 673
 674 =item B<SocketFile> I<Path>
 675
 676 Sets the socket-file which is to be created.
 677
 678 =item B<SocketGroup> I<Group>
 679
 680 If running as root change the group of the UNIX-socket after it has been
 681 created. Defaults to B<collectd>.
 682
 683 =item B<SocketPerms> I<Permissions>
 684
 685 Change the file permissions of the UNIX-socket after it has been created. The
 686 permissions must be given as a numeric, octal value as you would pass to
 687 L<chmod(1)>. Defaults to B<0770>.
 688
 689 =back
 690
 691 =head2 Plugin C<vserver>
 692
 693 This plugin doesn't have any options. B<VServer> support is only available for
 694 Linux. It cannot yet be found in a vanilla kernel, though. To make use of this
 695 plugin you need a kernel that has B<VServer> support built in, i.E<nbsp>e. you
 696 need to apply the patches and compile your own kernel, which will then provide
 697 the F</proc/virtual> filesystem that is required by this plugin.
 698
 699 The B<VServer> homepage can be found at L<http://linux-vserver.org/>.
 700
 701 =head1 SEE ALSO
 702
 703 L<collectd(1)>,
 704 L<collectd-exec(5)>,
 705 L<collectd-unixsock(5)>,
 706 L<hddtemp(8)>,
 707 L<kstat(3KSTAT)>,
 708 L<mbmon(1)>,
 709 L<rrdtool(1)>,
 710 L<sensors(1)>
 711
 712 =head1 AUTHOR
 713
 714 Florian Forster E<lt>octo@verplant.orgE<gt>
 715
 716 =cut