X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Fcollectd.conf.pod;h=e4bcbc26e973c487749f1e7bd9b2fe1cc3ce7b7f;hb=24b87484c7fd2e0998682db6f77e54d8cdc459d4;hp=667e488e8280afd24459e6375d09beaf61082024;hpb=abd1972f9db972cfda12b61e2998d1300b1c1a0b;p=collectd.git diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod index 667e488e..e4bcbc26 100644 --- a/src/collectd.conf.pod +++ b/src/collectd.conf.pod @@ -1574,6 +1574,47 @@ Connection timeout in seconds. Defaults to B<2>. =back +=head2 Plugin Connectivity + +connectivity - Documentation of collectd's C + + + LoadPlugin connectivity + # ... + + Interface eth0 + + +The C queries interface status using netlink (man 7 netlink) which provides information about network interfaces via the NETLINK_ROUTE family (man 7 rtnetlink). The plugin translates the value it receives to collectd's internal format and, depending on the write plugins you have loaded, it may be written to disk or submitted to another instance. +The plugin listens to interfaces enumerated within the plugin configuration (see below). If no interfaces are listed, then the default is for all interfaces to be monitored. + +This example shows C monitoring all interfaces. +LoadPlugin connectivity + + + +This example shows C monitoring 2 interfaces, "eth0" and "eth1". +LoadPlugin connectivity + + Interface eth0 + Interface eth1 + + +This example shows C monitoring all interfaces except "eth1". +LoadPlugin connectivity + + Interface eth1 + IgnoreSelected true + + +=over 4 + +=item B I + +interface(s) to monitor connect to. + +=back + =head2 Plugin C This plugin collects IP conntrack statistics. @@ -1662,6 +1703,10 @@ installed) to get the current CPU frequency. If this file does not exist make sure B (L) or a similar tool is installed and an "cpu governor" (that's a kernel module) is loaded. +If the system has the I kernel module loaded, this plugin reports +the rate of p-state (cpu frequency) transitions and the percentage of time spent +in each p-state. + =head2 Plugin C This plugin doesn't have any options. It reads CLOCK_BOOTTIME and @@ -3206,6 +3251,30 @@ Pause to apply between attempts of connection to gpsd in seconds (default 5 sec) =back +=head2 Plugin C + +Efficiently collects various statistics from the system's NVIDIA GPUs using the +NVML library. Currently collected are fan speed, core temperature, percent +load, percent memory used, compute and memory frequencies, and power +consumption. + +=over 4 + +=item B + +If one or more of these options is specified, only GPUs at that index (as +determined by nvidia-utils through I) have statistics collected. +If no instance of this option is specified, all GPUs are monitored. + +=item B + +If set to true, all detected GPUs B the ones at indices specified by +B entries are collected. For greater clarity, setting IgnoreSelected +without any GPUIndex directives will result in B statistics being +collected. + +=back + =head2 Plugin C The I plugin provides an RPC interface to submit values to or query @@ -8837,6 +8906,33 @@ dynamic number assigned by the kernel. Otherwise, CnE> is used if there is only one package and CnE-coreEmE> if there is more than one, where I is the n-th core of package I. +=item B I|I + +Reading data from CPU has side-effect: collectd process's CPU affinity mask +changes. After reading data is completed, affinity mask needs to be restored. +This option allows to set restore policy. + +B (the default): Restore the affinity by setting affinity to any/all +CPUs. + +B: Save affinity using sched_getaffinity() before reading data and +restore it after. + +On some systems, sched_getaffinity() will fail due to inconsistency of the CPU +set size between userspace and kernel. In these cases plugin will detect the +unsuccessful call and fail with an error, preventing data collection. +Most of configurations does not need to save affinity as Collectd process is +allowed to run on any/all available CPUs. + +If you need to save and restore affinity and get errors like 'Unable to save +the CPU affinity', setting 'possible_cpus' kernel boot option may also help. + +See following links for details: + +L +L +L + =back =head2 Plugin C @@ -9106,6 +9202,40 @@ only on the host system. Only I is required. +Consider the following example config: + + + Connection "qemu:///system" + HostnameFormat "hostname" + InterfaceFormat "address" + PluginInstanceFormat "name" + + +It will generate the following values: + + node42.example.com/virt-instance-0006f26c/disk_octets-vda + node42.example.com/virt-instance-0006f26c/disk_ops-vda + node42.example.com/virt-instance-0006f26c/if_dropped-ca:fe:ca:fe:ca:fe + node42.example.com/virt-instance-0006f26c/if_errors-ca:fe:ca:fe:ca:fe + node42.example.com/virt-instance-0006f26c/if_octets-ca:fe:ca:fe:ca:fe + node42.example.com/virt-instance-0006f26c/if_packets-ca:fe:ca:fe:ca:fe + node42.example.com/virt-instance-0006f26c/memory-actual_balloon + node42.example.com/virt-instance-0006f26c/memory-available + node42.example.com/virt-instance-0006f26c/memory-last_update + node42.example.com/virt-instance-0006f26c/memory-major_fault + node42.example.com/virt-instance-0006f26c/memory-minor_fault + node42.example.com/virt-instance-0006f26c/memory-rss + node42.example.com/virt-instance-0006f26c/memory-swap_in + node42.example.com/virt-instance-0006f26c/memory-swap_out + node42.example.com/virt-instance-0006f26c/memory-total + node42.example.com/virt-instance-0006f26c/memory-unused + node42.example.com/virt-instance-0006f26c/memory-usable + node42.example.com/virt-instance-0006f26c/virt_cpu_total + node42.example.com/virt-instance-0006f26c/virt_vcpu-0 + +You can get information on the metric's units from the online libvirt documentation. +For instance, I is in nanoseconds. + =over 4 =item B I @@ -9208,7 +9338,8 @@ B means use the guest's UUID. This is useful if you want to track the same guest across migrations. B means to use the global B setting, which is probably not -useful on its own because all guests will appear to have the same name. +useful on its own because all guests will appear to have the same name. This is +useful in conjunction with B though. You can also specify combinations of these fields. For example B means to concatenate the guest name and UUID (with a literal colon character @@ -9337,83 +9468,6 @@ traffic (e.Eg. due to headers and retransmission). If you want to collect on-wire traffic you could, for example, use the logging facilities of iptables to feed data for the guest IPs into the iptables plugin. -=head2 Plugin C - -The C plugin writes metrics to the I (GCM) -service. - -This plugin supports two authentication methods: When configured, credentials -are read from the JSON credentials file specified with B. -Alternatively, when running on -I (GCE), an I token is retrieved from the -I and used to authenticate to GCM. - -B - - - Project "123456789012" - - -=over 4 - -=item B I - -Path to a JSON credentials file holding the credentials for a GCP service -account. - -If not specified, I. If running on GCE, -B may be set to chose a different service account associated with the -instance. - -=item B I - -The I or the I of the I. The -I is a string identifying the GCP project, which you can chose -freely when creating a new project. The I is a 12-digit decimal -number. You can look up both on the I. - -This setting is optional. If not set, the project ID is read from the -credentials file or determined from the GCE's metadata service. - -=item B I - -Email address of an GCE I. This setting is only effective when -running on GCE and using I (see -B above). - -=item B I - -Configures the I to use when storing metrics. This option -takes a I and arbitrary string options which are used as labels. - -On GCE, defaults to the equivalent of this config: - - - project_id "${meta/project/project-id}" - instance_id "${meta/instance/id}" - zone "${meta/instance/zone}" - - -Where C<${meta/...}> are values read from the meta data service. - -When not running on GCE, defaults to the equivalent of this config: - - - project_id "${Project}" - - -Where C<${Project}> refers to the B option. - -See L for more information -on I. - -=item B I - -URL of the I API. Defaults to -C. - -=back - =head2 Plugin C The C plugin writes data to I, an open-source metrics @@ -9711,6 +9765,13 @@ B =over 4 +=item B I + +Bind to the hostname / address I. By default, the plugin will bind to the +"any" address, i.e. accept packets sent to any of the hosts addresses. + +This option is supported only for libmicrohttpd newer than 0.9.0. + =item B I Port the embedded webserver should listen on. Defaults to B<9103>. @@ -10384,6 +10445,133 @@ attribute for each metric being sent out to I. =back +=head2 Plugin C + +The C plugin writes metrics to the +I service. + +This plugin supports two authentication methods: When configured, credentials +are read from the JSON credentials file specified with B. +Alternatively, when running on +I (GCE), an I token is retrieved from the +I and used to authenticate to GCM. + +B + + + CredentialFile "/path/to/service_account.json" + + Label "project_id" "monitored_project" + + + +=over 4 + +=item B I + +Path to a JSON credentials file holding the credentials for a GCP service +account. + +If B is not specified, the plugin uses I. That means which credentials are used depends on the environment: + +=over 4 + +=item + +The environment variable C is checked. If this +variable is specified it should point to a JSON file that defines the +credentials. + +=item + +The path C<${HOME}/.config/gcloud/application_default_credentials.json> is +checked. This where credentials used by the I command line utility are +stored. You can use C to create these +credentials. + +Please note that these credentials are often of your personal account, not a +service account, and are therefore unfit to be used in a production +environment. + +=item + +When running on GCE, the built-in service account associated with the virtual +machine instance is used. +See also the B option below. + +=back + +=item B I + +The I or the I of the I. The +I is a string identifying the GCP project, which you can chose +freely when creating a new project. The I is a 12-digit decimal +number. You can look up both on the I. + +This setting is optional. If not set, the project ID is read from the +credentials file or determined from the GCE's metadata service. + +=item B I (GCE only) + +Choses the GCE I used for authentication. + +Each GCE instance has a C I but may also be +associated with additional I. This is often used to restrict +the permissions of services running on the GCE instance to the required +minimum. The I requires the +C scope. When multiple I are available, this option selects which one is used by +I. + +=item B I + +Configures the I to use when storing metrics. +More information on I and I are +available at L. + +This block takes one string argument, the I. Inside the block are +one or more B