Difference between revisions of "Plugin:NTPd"

From collectd Wiki
Jump to: navigation, search
(Add prameters)
 
(8 intermediate revisions by one other user not shown)
Line 1: Line 1:
= Description =
+
{{Infobox Plugin
 
+
  | Name=NTPd
The <em>NTPd</em> plugin queries an NTP server (usually the local one, where statistics access is allowed) and extracts :
+
  | Type=read
 +
  | Callbacks={{Callback|config}}, {{Callback|read}}
 +
  | Status={{supported}}
 +
  | FirstVersion={{Version|3.10}}
 +
  | Copyright=''2006–2012'' [[User:Octo|Florian Forster]]
 +
  | License={{MIT License}}
 +
  | Manpage={{Manpage|collectd.conf|5|plugin_ntpd}}
 +
}}
 +
The '''NTPd plugin''' queries an NTP server (usually the local one, where statistics access is allowed) and extracts :
 
* "local" clock parameters :
 
* "local" clock parameters :
 
** time offset
 
** time offset
Line 10: Line 18:
 
** delay
 
** delay
  
Details of the configuration can be found in the [http://collectd.org/documentation/manpages/collectd.conf.5.shtml#plugin_ntpd collectd.conf(5)] manual page.
+
Details of the configuration can be found in the {{Manpage|collectd.conf|5|plugin_ntpd}} manual page.
  
= Example Graphs =
+
== Synopsis ==
 +
 
 +
<Plugin "ntpd">
 +
  Host "localhost"
 +
  Port "123"
 +
  ReverseLookups false
 +
</Plugin>
 +
 
 +
== Parameters ==
 +
{| class="wikitable"
 +
|-
 +
  ! Name
 +
  ! Default
 +
  ! Multivalue
 +
  ! Required
 +
  ! Description
 +
|-
 +
  | Host
 +
  | localhost
 +
  | No
 +
  | No
 +
  | Hostname or IP to collect NTP data from
 +
|-
 +
  | Port
 +
  | 123
 +
  | No
 +
  | No
 +
  | UDP port to collect NTP data from
 +
|-
 +
  | ReverseLookups
 +
  | True
 +
  | No
 +
  | No
 +
  | If True report the peers with hostnames instead of IP addresses
 +
|-
 +
  | IncludeUnitID
 +
  | False
 +
  | No
 +
  | No
 +
  | This option only exists for backward compatibility. If it is False and two ntpd peers use the same refclock driver, the plugin will try to write simultaneous measurements from both to the same type instance
 +
|}
 +
 
 +
== Example Graphs ==
  
 
[[Image:Plugin-Ntpd-delay.png]]
 
[[Image:Plugin-Ntpd-delay.png]]
Line 18: Line 68:
 
[[Image:Plugin-Ntpd-offset.png]]
 
[[Image:Plugin-Ntpd-offset.png]]
  
= Dependencies =
+
== Dependencies ==
  
only an NTP server to be queried
+
* <em>none</em>
  
 
--[[User:Sebg|Sebg]] 19:52, 26 February 2009 (UTC)
 
--[[User:Sebg|Sebg]] 19:52, 26 February 2009 (UTC)
 +
 +
[[Category:Plugins]]
 +
{{DEFAULTSORT:Ntpd}}

Latest revision as of 14:44, 11 June 2015

NTPd plugin
Type: read
Callbacks: config, read
Status: supported
First version: 3.10
Copyright: 2006–2012 Florian Forster
License: MIT license
Manpage: collectd.conf(5)
List of Plugins

The NTPd plugin queries an NTP server (usually the local one, where statistics access is allowed) and extracts :

  • "local" clock parameters :
    • time offset
    • error and offset loop
  • parameters for each NTP server used to sync time
    • offset
    • dispersion
    • delay

Details of the configuration can be found in the collectd.conf(5) manual page.

Synopsis

<Plugin "ntpd">
  Host "localhost"
  Port "123"
  ReverseLookups false
</Plugin>

Parameters

Name Default Multivalue Required Description
Host localhost No No Hostname or IP to collect NTP data from
Port 123 No No UDP port to collect NTP data from
ReverseLookups True No No If True report the peers with hostnames instead of IP addresses
IncludeUnitID False No No This option only exists for backward compatibility. If it is False and two ntpd peers use the same refclock driver, the plugin will try to write simultaneous measurements from both to the same type instance

Example Graphs

Plugin-Ntpd-delay.png Plugin-Ntpd-dispersion.png Plugin-Ntpd-offset.png

Dependencies

  • none

--Sebg 19:52, 26 February 2009 (UTC)