Skip to content

Commit

Permalink
collectd.conf(5): Improve documentation of the turbostat plugin.
Browse files Browse the repository at this point in the history
  • Loading branch information
octo committed Nov 28, 2016
1 parent 247e0a2 commit 3d15f72
Showing 1 changed file with 36 additions and 37 deletions.
73 changes: 36 additions & 37 deletions src/collectd.conf.pod
Original file line number Diff line number Diff line change
Expand Up @@ -7442,7 +7442,7 @@ couple metrics: number of records, and database size on disk.

=item B<Host> I<Hostname/IP>

The hostname or ip which identifies the server.
The hostname or IP which identifies the server.
Default: B<127.0.0.1>

=item B<Port> I<Service/Port>
Expand All @@ -7456,69 +7456,60 @@ Default: B<1978>
=head2 Plugin C<turbostat>

The I<Turbostat plugin> reads CPU frequency and C-state residency on modern
Intel processors by using the new Model Specific Registers.
Intel processors by using I<Model Specific Registers>.

=over 4

=item B<CoreCstates> I<Bitmask(Integer)>

Bitmask of the list of core C states supported by the processor.
Bit mask of the list of core C-states supported by the processor.
This option should only be used if the automated detection fails.
Default value extracted from the cpu model and family.
Default value extracted from the CPU model and family.

Currently supported C-states (by this plugin): 3, 6, 7

Example: (1<<3)+(1<<6)+(1<<7) = 392 for all states
B<Example:>

All states (3, 6 and 7):
(1<<3) + (1<<6) + (1<<7) = 392

=item B<PackageCstates> I<Bitmask(Integer)>

Bitmask of the list of pacages C states supported by the processor.
This option should only be used if the automated detection fails.
Default value extracted from the cpu model and family.
Bit mask of the list of packages C-states supported by the processor. This
option should only be used if the automated detection fails. Default value
extracted from the CPU model and family.

Currently supported C-states (by this plugin): 2, 3, 6, 7, 8, 9, 10

Example: (1<<2)+(1<<3)+(1<<6)+(1<<7) = 396 for states 2, 3, 6 and 7

=item B<SystemManagementInterrupt> I<true>|I<false>
B<Example:>

Boolean enabling the collection of the I/O System-Management Interrupt
counter'. This option should only be used if the automated detection
fails or if you want to disable this feature.
States 2, 3, 6 and 7:
(1<<2) + (1<<3) + (1<<6) + (1<<7) = 396

=item B<DigitalTemperatureSensor> I<true>|I<false>
=item B<SystemManagementInterrupt> I<true>|I<false>

Boolean enabling the collection of the temperature of each core.
This option should only be used if the automated detectionfails or
if you want to disable this feature.
Boolean enabling the collection of the I/O System-Management Interrupt counter.
This option should only be used if the automated detection fails or if you want
to disable this feature.

=item B<DigitalTemperatureSensor> I<true>|I<false>

Boolean enabling the collection of the temperature of each package.
This option should only be used if the automated detectionfails or
if you want to disable this feature.
Boolean enabling the collection of the temperature of each core. This option
should only be used if the automated detection fails or if you want to disable
this feature.

=item B<TCCActivationTemp> I<Temperature>

Thermal Control Circuit Activation Temperature of the installed
CPU. This temperature is used when collecting the temperature of
cores or packages. This option should only be used if the automated
detection fails. Default value extracted from B<MSR_IA32_TEMPERATURE_TARGET>
I<Thermal Control Circuit Activation Temperature> of the installed CPU. This
temperature is used when collecting the temperature of cores or packages. This
option should only be used if the automated detection fails. Default value
extracted from B<MSR_IA32_TEMPERATURE_TARGET>.

=item B<RunningAveragePowerLimit> I<Bitmask(Integer)>

Bitmask of the list of elements to be thermally monitored. This option
should only be used if the automated detection fails or if you want to
disable some collections. The different bits of this bitmask accepted
by this plugin are:

=item B<LogicalCoreNames> I<true>|I<false>

Boolean enabling the use of logical core numbering for per core
statistics. When enabled, cpu<n> is used as plugin instance, where n
is a sequential number assigned by the kernel. Otherwise, core<n> is
used where n is the n-th core of the socket, causing name conflicts
when there is more than one socket.
Bit mask of the list of elements to be thermally monitored. This option should
only be used if the automated detection fails or if you want to disable some
collections. The different bits of this bit mask accepted by this plugin are:

=over 4

Expand All @@ -7532,6 +7523,14 @@ when there is more than one socket.

=back

=item B<LogicalCoreNames> I<true>|I<false>

Boolean enabling the use of logical core numbering for per core statistics.
When enabled, C<cpuE<lt>nE<gt>> is used as plugin instance, where I<n> is a
sequential number assigned by the kernel. Otherwise, C<coreE<lt>nE<gt>> is used
where I<n> is the n-th core of the socket, causing name conflicts when there is
more than one socket.

=back

=head2 Plugin C<unixsock>
Expand Down

0 comments on commit 3d15f72

Please sign in to comment.