1 /* chrony plugin for collectd (monitoring of chrony time server daemon)
2 **********************************************************************
3 * Copyright (C) Claudius M Zingerli, ZSeng, 2015-2016
5 * Internals roughly based on the ntpd plugin
6 * Some functions copied from chronyd/web (as marked)
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of version 2 of the GNU General Public License as
10 * published by the Free Software Foundation.
12 * This program is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License for more details.
17 * You should have received a copy of the GNU General Public License along
18 * with this program; if not, write to the Free Software Foundation, Inc.,
19 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
22 * - More robust udp parsing (using offsets instead of structs?)
23 * -> Currently chrony parses its data the same way as we do (using structs)
24 * - Plausibility checks on values received
25 * -> Done at higher levels
30 #include "common.h" /* auxiliary functions */
31 #include "plugin.h" /* plugin_register_*, plugin_dispatch_values */
34 # include <netdb.h> /* struct addrinfo */
37 # include <arpa/inet.h> /* ntohs/ntohl */
41 #define CONFIG_KEY_HOST "Host"
42 #define CONFIG_KEY_PORT "Port"
43 #define CONFIG_KEY_TIMEOUT "Timeout"
45 #define URAND_DEVICE_PATH "/dev/urandom" /* Used to initialize seq nr generator */
46 #define RAND_DEVICE_PATH "/dev/random" /* Used to initialize seq nr generator (fall back) */
48 static const char *g_config_keys[] = {
54 static int g_config_keys_num = STATIC_ARRAY_SIZE(g_config_keys);
55 static int g_chrony_is_connected;
56 static int g_chrony_socket = -1;
57 static time_t g_chrony_timeout = -1;
58 static char *g_chrony_plugin_instance;
59 static char *g_chrony_host;
60 static char *g_chrony_port;
61 static uint32_t g_chrony_rand = 1;
62 static uint32_t g_chrony_seq_is_initialized;
64 #define PLUGIN_NAME_SHORT "chrony"
65 #define PLUGIN_NAME PLUGIN_NAME_SHORT " plugin"
66 #define DAEMON_NAME PLUGIN_NAME_SHORT
67 #define CHRONY_DEFAULT_HOST "localhost"
68 #define CHRONY_DEFAULT_PORT "323"
69 #define CHRONY_DEFAULT_TIMEOUT 2
71 /* Return codes (collectd expects non-zero on errors) */
72 #define CHRONY_RC_OK 0
73 #define CHRONY_RC_FAIL 1
75 /* Chronyd command packet variables adapted from chrony/candm.h (GPL2) */
76 #define PROTO_VERSION_NUMBER 6
77 #define IPADDR_UNSPEC 0
78 #define IPADDR_INET4 1
79 #define IPADDR_INET6 2
80 #define IPV6_STR_MAX_SIZE (8*4+7+1)
84 PKT_TYPE_CMD_REQUEST = 1,
85 PKT_TYPE_CMD_REPLY = 2
102 RPY_MANUAL_TIMESTAMP = 4,
104 RPY_SOURCE_STATS = 6,
109 #if defined(__GNUC__) || defined (__SUNPRO_C) || defined(lint)
110 # /* extension to enforce struct packing. */
111 # define ATTRIB_PACKED __attribute__((packed))
113 # error Not defining packed attribute (unknown compiler)
114 # define ATTRIB_PACKED
117 typedef struct ATTRIB_PACKED
122 typedef struct ATTRIB_PACKED
124 uint32_t tv_sec_high;
135 STT_NOSUCHSOURCE = 4,
139 STT_ACCESSALLOWED = 8,
140 STT_ACCESSDENIED = 9,
141 STT_NOHOSTACCESS = 10,
142 STT_SOURCEALREADYKNOWN = 11,
143 STT_TOOMANYSOURCES = 12,
149 STT_BADPKTVERSION = 18,
150 STT_BADPKTLENGTH = 19
153 /* Chrony client request packets */
154 typedef struct ATTRIB_PACKED
156 uint8_t f_dummy0[80]; /* Chrony expects 80bytes dummy data (Avoiding UDP Amplification) */
157 } tChrony_Req_Tracking;
159 typedef struct ATTRIB_PACKED
161 uint32_t f_n_sources;
162 } tChrony_Req_N_Sources;
164 typedef struct ATTRIB_PACKED
167 uint8_t f_dummy0[44];
168 } tChrony_Req_Source_data;
170 typedef struct ATTRIB_PACKED
173 uint8_t f_dummy0[56];
174 } tChrony_Req_Source_stats;
176 typedef struct ATTRIB_PACKED
190 } header; /* Packed: 20Bytes */
193 tChrony_Req_N_Sources n_sources;
194 tChrony_Req_Source_data source_data;
195 tChrony_Req_Source_stats source_stats;
196 tChrony_Req_Tracking tracking;
198 uint8_t padding[4 + 16]; /* Padding to match minimal response size */
201 /* Chrony daemon response packets */
202 typedef struct ATTRIB_PACKED
204 uint32_t f_n_sources;
205 } tChrony_Resp_N_Sources;
207 typedef struct ATTRIB_PACKED
217 typedef struct ATTRIB_PACKED
220 uint16_t dummy; /* FIXME: Strange dummy space. Needed on gcc 4.8.3/clang 3.4.1 on x86_64 */
221 int16_t f_poll; /* 2^f_poll = Time between polls (s) */
222 uint16_t f_stratum; /* Remote clock stratum */
223 uint16_t f_state; /* 0 = RPY_SD_ST_SYNC, 1 = RPY_SD_ST_UNREACH, 2 = RPY_SD_ST_FALSETICKER */
224 /* 3 = RPY_SD_ST_JITTERY, 4 = RPY_SD_ST_CANDIDATE, 5 = RPY_SD_ST_OUTLIER */
225 uint16_t f_mode; /* 0 = RPY_SD_MD_CLIENT, 1 = RPY_SD_MD_PEER, 2 = RPY_SD_MD_REF */
226 uint16_t f_flags; /* unused */
227 uint16_t f_reachability; /* Bit mask of successfull tries to reach the source */
229 uint32_t f_since_sample; /* Time since last sample (s) */
230 tFloat f_origin_latest_meas; /* */
231 tFloat f_latest_meas; /* */
232 tFloat f_latest_meas_err; /* */
233 } tChrony_Resp_Source_data;
235 typedef struct ATTRIB_PACKED
239 uint16_t dummy; /* FIXME: Strange dummy space. Needed on gcc 4.8.3/clang 3.4.1 on x86_64 */
240 uint32_t f_n_samples; /* Number of measurements done */
241 uint32_t f_n_runs; /* How many measurements to come */
242 uint32_t f_span_seconds; /* For how long we're measuring */
243 tFloat f_rtc_seconds_fast; /* ??? */
244 tFloat f_rtc_gain_rate_ppm; /* Estimated relative frequency error */
245 tFloat f_skew_ppm; /* Clock skew (ppm) (worst case freq est error (skew: peak2peak)) */
246 tFloat f_est_offset; /* Estimated offset of source */
247 tFloat f_est_offset_err; /* Error of estimation */
248 } tChrony_Resp_Source_stats;
250 typedef struct ATTRIB_PACKED
254 uint16_t dummy; /* FIXME: Strange dummy space. Needed on gcc 4.8.3/clang 3.4.1 on x86_64 */
256 uint16_t f_leap_status;
258 tFloat f_current_correction;
259 tFloat f_last_offset;
262 tFloat f_resid_freq_ppm;
265 tFloat f_root_dispersion;
266 tFloat f_last_update_interval;
267 } tChrony_Resp_Tracking;
269 typedef struct ATTRIB_PACKED
286 } header; /* Packed: 28 Bytes */
290 tChrony_Resp_N_Sources n_sources;
291 tChrony_Resp_Source_data source_data;
292 tChrony_Resp_Source_stats source_stats;
293 tChrony_Resp_Tracking tracking;
296 uint8_t padding[1024];
300 /*****************************************************************************/
301 /* Internal functions */
302 /*****************************************************************************/
304 /* connect_client code adapted from: http://long.ccaba.upc.edu/long/045Guidelines/eva/ipv6.html#daytimeClient6 */
305 /* License granted by Eva M Castro via e-mail on 2016-02-18 under the terms of GPLv3 */
307 connect_client(const char *p_hostname,
308 const char *p_service, int p_family, int p_socktype)
310 struct addrinfo *res, *ressave;
313 struct addrinfo ai_hints = {
314 .ai_family = p_family,
315 .ai_socktype = p_socktype
318 n = getaddrinfo(p_hostname, p_service, &ai_hints, &res);
322 ERROR(PLUGIN_NAME ": getaddrinfo error:: [%s]", gai_strerror(n));
331 sockfd = socket(res->ai_family, res->ai_socktype, res->ai_protocol);
335 if (connect(sockfd, res->ai_addr, res->ai_addrlen) == 0)
347 freeaddrinfo(ressave);
352 /* niptoha code originally from: git://git.tuxfamily.org/gitroot/chrony/chrony.git:util.c */
353 /* Original code licensed as GPLv2, by Richard P. Purnow, Miroslav Lichvar */
354 /* Original name: char * UTI_IPToString(IPAddr *addr)*/
356 niptoha(const tChrony_IPAddr * addr, char *p_buf, size_t p_buf_size)
359 unsigned long a, b, c, d, ip;
361 switch (ntohs(addr->f_family))
364 rc = snprintf(p_buf, p_buf_size, "[UNSPEC]");
367 ip = ntohl(addr->addr.ip4);
368 a = (ip >> 24) & 0xff;
369 b = (ip >> 16) & 0xff;
370 c = (ip >> 8) & 0xff;
371 d = (ip >> 0) & 0xff;
372 rc = snprintf(p_buf, p_buf_size, "%ld.%ld.%ld.%ld", a, b, c, d);
376 const char *rp = inet_ntop(AF_INET6, addr->addr.ip6, p_buf, p_buf_size);
379 ERROR(PLUGIN_NAME ": Error converting ipv6 address to string. Errno = %d", errno);
380 rc = snprintf(p_buf, p_buf_size, "[UNKNOWN]");
385 rc = snprintf(p_buf, p_buf_size, "[UNKNOWN]");
393 chrony_set_timeout(void)
395 /* Set the socket's timeout to g_chrony_timeout; a value of 0 signals infinite timeout */
396 /* Returns 0 on success, !0 on error (check errno) */
399 tv.tv_sec = g_chrony_timeout;
402 assert(g_chrony_socket >= 0);
403 if (setsockopt(g_chrony_socket, SOL_SOCKET,
404 SO_RCVTIMEO, (char *) &tv, sizeof(struct timeval)) < 0)
406 return CHRONY_RC_FAIL;
415 /* Connects to the chrony daemon */
416 /* Returns 0 on success, !0 on error (check errno) */
419 if (g_chrony_host == NULL)
421 g_chrony_host = strdup(CHRONY_DEFAULT_HOST);
422 if (g_chrony_host == NULL)
424 ERROR(PLUGIN_NAME ": Error duplicating chrony host name");
425 return CHRONY_RC_FAIL;
428 if (g_chrony_port == NULL)
430 g_chrony_port = strdup(CHRONY_DEFAULT_PORT);
431 if (g_chrony_port == NULL)
433 ERROR(PLUGIN_NAME ": Error duplicating chrony port string");
434 return CHRONY_RC_FAIL;
437 if (g_chrony_timeout < 0)
439 g_chrony_timeout = CHRONY_DEFAULT_TIMEOUT;
440 assert(g_chrony_timeout >= 0);
443 DEBUG(PLUGIN_NAME ": Connecting to %s:%s", g_chrony_host, g_chrony_port);
444 socket = connect_client(g_chrony_host, g_chrony_port, AF_UNSPEC, SOCK_DGRAM);
447 ERROR(PLUGIN_NAME ": Error connecting to daemon. Errno = %d", errno);
448 return CHRONY_RC_FAIL;
450 DEBUG(PLUGIN_NAME ": Connected");
451 g_chrony_socket = socket;
453 if (chrony_set_timeout())
455 ERROR(PLUGIN_NAME ": Error setting timeout to %llds. Errno = %d",
456 (long long)g_chrony_timeout, errno);
457 return CHRONY_RC_FAIL;
464 chrony_send_request(const tChrony_Request * p_req, size_t p_req_size)
466 if (send(g_chrony_socket, p_req, p_req_size, 0) < 0)
468 ERROR(PLUGIN_NAME ": Error sending packet. Errno = %d", errno);
469 return CHRONY_RC_FAIL;
476 chrony_recv_response(tChrony_Response * p_resp, size_t p_resp_max_size,
477 size_t * p_resp_size)
479 ssize_t rc = recv(g_chrony_socket, p_resp, p_resp_max_size, 0);
482 ERROR(PLUGIN_NAME ": Error receiving packet: %s (%d)", strerror(errno),
484 return CHRONY_RC_FAIL;
495 chrony_query(const int p_command, tChrony_Request * p_req,
496 tChrony_Response * p_resp, size_t * p_resp_size)
498 /* Check connection. We simply perform one try as collectd already handles retries */
503 if (g_chrony_is_connected == 0)
505 if (chrony_connect() == CHRONY_RC_OK)
507 g_chrony_is_connected = 1;
511 ERROR(PLUGIN_NAME ": Unable to connect. Errno = %d", errno);
512 return CHRONY_RC_FAIL;
518 int valid_command = 0;
519 size_t req_size = sizeof(p_req->header) + sizeof(p_req->padding);
520 size_t resp_size = sizeof(p_resp->header);
521 uint16_t resp_code = RPY_NULL;
525 req_size += sizeof(p_req->body.tracking);
526 resp_size += sizeof(p_resp->body.tracking);
527 resp_code = RPY_TRACKING;
531 req_size += sizeof(p_req->body.n_sources);
532 resp_size += sizeof(p_resp->body.n_sources);
533 resp_code = RPY_N_SOURCES;
536 case REQ_SOURCE_DATA:
537 req_size += sizeof(p_req->body.source_data);
538 resp_size += sizeof(p_resp->body.source_data);
539 resp_code = RPY_SOURCE_DATA;
542 case REQ_SOURCE_STATS:
543 req_size += sizeof(p_req->body.source_stats);
544 resp_size += sizeof(p_resp->body.source_stats);
545 resp_code = RPY_SOURCE_STATS;
549 ERROR(PLUGIN_NAME ": Unknown request command (Was: %d)", p_command);
553 if (valid_command == 0)
556 uint32_t seq_nr = rand_r(&g_chrony_rand);
557 p_req->header.f_cmd = htons(p_command);
558 p_req->header.f_cmd_try = 0;
559 p_req->header.f_seq = seq_nr;
561 DEBUG(PLUGIN_NAME ": Sending request (.cmd = %d, .seq = %d)", p_command,
563 if (chrony_send_request(p_req, req_size) != 0)
566 DEBUG(PLUGIN_NAME ": Waiting for response");
567 if (chrony_recv_response(p_resp, resp_size, p_resp_size) != 0)
571 ": Received response: .version = %u, .type = %u, .cmd = %u, .reply = %u, .status = %u, .seq = %u",
572 p_resp->header.f_version, p_resp->header.f_type,
573 ntohs(p_resp->header.f_cmd), ntohs(p_resp->header.f_reply),
574 ntohs(p_resp->header.f_status), p_resp->header.f_seq);
576 if (p_resp->header.f_version != p_req->header.f_version)
578 ERROR(PLUGIN_NAME ": Wrong protocol version (Was: %d, expected: %d)",
579 p_resp->header.f_version, p_req->header.f_version);
580 return CHRONY_RC_FAIL;
582 if (p_resp->header.f_type != PKT_TYPE_CMD_REPLY)
584 ERROR(PLUGIN_NAME ": Wrong packet type (Was: %d, expected: %d)",
585 p_resp->header.f_type, PKT_TYPE_CMD_REPLY);
586 return CHRONY_RC_FAIL;
588 if (p_resp->header.f_seq != seq_nr)
590 /* FIXME: Implement sequence number handling */
592 ": Unexpected sequence number (Was: %d, expected: %d)",
593 p_resp->header.f_seq, p_req->header.f_seq);
594 return CHRONY_RC_FAIL;
596 if (p_resp->header.f_cmd != p_req->header.f_cmd)
598 ERROR(PLUGIN_NAME ": Wrong reply command (Was: %d, expected: %d)",
599 p_resp->header.f_cmd, p_req->header.f_cmd);
600 return CHRONY_RC_FAIL;
603 if (ntohs(p_resp->header.f_reply) != resp_code)
605 ERROR(PLUGIN_NAME ": Wrong reply code (Was: %d, expected: %d)",
606 ntohs(p_resp->header.f_reply), resp_code);
607 return CHRONY_RC_FAIL;
610 switch (p_resp->header.f_status)
613 DEBUG(PLUGIN_NAME ": Reply packet status STT_SUCCESS");
617 ": Reply packet contains error status: %d (expected: %d)",
618 p_resp->header.f_status, STT_SUCCESS);
619 return CHRONY_RC_FAIL;
627 /* Some error occured */
628 return CHRONY_RC_FAIL;
633 chrony_init_req(tChrony_Request * p_req)
635 memset(p_req, 0, sizeof(*p_req));
636 p_req->header.f_version = PROTO_VERSION_NUMBER;
637 p_req->header.f_type = PKT_TYPE_CMD_REQUEST;
638 p_req->header.f_dummy0 = 0;
639 p_req->header.f_dummy1 = 0;
640 p_req->header.f_dummy2 = 0;
641 p_req->header.f_dummy3 = 0;
645 /* ntohf code originally from: git://git.tuxfamily.org/gitroot/chrony/chrony.git:util.c */
646 /* Original code licensed as GPLv2, by Richard P. Purnow, Miroslav Lichvar */
647 /* Original name: double UTI_tFloatNetworkToHost(tFloat f) */
649 ntohf(tFloat p_float)
651 /* Convert tFloat in Network-bit-order to double in host-bit-order */
653 #define FLOAT_EXP_BITS 7
654 #define FLOAT_EXP_MIN (-(1 << (FLOAT_EXP_BITS - 1)))
655 #define FLOAT_EXP_MAX (-FLOAT_EXP_MIN - 1)
656 #define FLOAT_COEF_BITS ((int)sizeof (int32_t) * 8 - FLOAT_EXP_BITS)
657 #define FLOAT_COEF_MIN (-(1 << (FLOAT_COEF_BITS - 1)))
658 #define FLOAT_COEF_MAX (-FLOAT_COEF_MIN - 1)
663 uval = ntohl(p_float.value);
664 exp = (uval >> FLOAT_COEF_BITS) - FLOAT_COEF_BITS;
665 if (exp >= 1 << (FLOAT_EXP_BITS - 1))
666 exp -= 1 << FLOAT_EXP_BITS;
668 /* coef = (x << FLOAT_EXP_BITS) >> FLOAT_EXP_BITS; */
669 coef = uval % (1U << FLOAT_COEF_BITS);
670 if (coef >= 1 << (FLOAT_COEF_BITS - 1))
671 coef -= 1 << FLOAT_COEF_BITS;
673 return coef * pow(2.0, exp);
678 chrony_push_data(const char *p_type, const char *p_type_inst, double p_value)
680 value_list_t vl = VALUE_LIST_INIT;
682 vl.values = &(value_t) { .gauge = p_value };
685 /* XXX: Shall g_chrony_host/g_chrony_port be reflected in the plugin's output? */
686 /* hostname_g is set in daemon/collectd.c (from config, via gethostname or by resolving localhost) */
687 /* defined as: char hostname_g[DATA_MAX_NAME_LEN]; (never NULL) */
688 sstrncpy(vl.host, hostname_g, sizeof(vl.host));
689 sstrncpy(vl.plugin, PLUGIN_NAME_SHORT, sizeof(vl.plugin));
690 if (g_chrony_plugin_instance != NULL)
692 sstrncpy(vl.plugin_instance, g_chrony_plugin_instance,
693 sizeof(vl.plugin_instance));
696 sstrncpy(vl.type, p_type, sizeof(vl.type));
698 if (p_type_inst != NULL)
699 sstrncpy(vl.type_instance, p_type_inst, sizeof(vl.type_instance));
701 plugin_dispatch_values(&vl);
706 chrony_push_data_valid(const char *p_type, const char *p_type_inst, const int p_is_valid,
709 /* Push real value if p_is_valid is true, push NAN if p_is_valid is not true (idea from ntp plugin) */
713 chrony_push_data(p_type, p_type_inst, p_value);
718 chrony_init_seq(void)
720 /* Initialize the sequence number generator from /dev/urandom */
721 /* Fallbacks: /dev/random and time(NULL) */
726 fh = open(URAND_DEVICE_PATH, O_RDONLY);
729 ssize_t rc = read(fh, &g_chrony_rand, sizeof(g_chrony_rand));
730 if (rc != sizeof(g_chrony_rand))
732 ERROR(PLUGIN_NAME ": Reading from random source \'%s\'failed: %s (%d)",
733 URAND_DEVICE_PATH, strerror(errno), errno);
735 return CHRONY_RC_FAIL;
738 DEBUG(PLUGIN_NAME ": Seeding RNG from " URAND_DEVICE_PATH);
744 /* URAND_DEVICE_PATH device not found. Try RAND_DEVICE_PATH as fall-back */
745 fh = open(RAND_DEVICE_PATH, O_RDONLY);
748 ssize_t rc = read(fh, &g_chrony_rand, sizeof(g_chrony_rand));
749 if (rc != sizeof(g_chrony_rand))
752 ": Reading from random source \'%s\'failed: %s (%d)",
753 RAND_DEVICE_PATH, strerror(errno), errno);
755 return CHRONY_RC_FAIL;
758 DEBUG(PLUGIN_NAME ": Seeding RNG from " RAND_DEVICE_PATH);
762 /* Error opening RAND_DEVICE_PATH. Try time(NULL) as fall-back */
763 DEBUG(PLUGIN_NAME ": Seeding RNG from time(NULL)");
764 g_chrony_rand = time(NULL) ^ getpid();
769 ERROR(PLUGIN_NAME ": Opening random source \'%s\' failed: %s (%d)",
770 URAND_DEVICE_PATH, strerror(errno), errno);
771 return CHRONY_RC_FAIL;
779 /*****************************************************************************/
780 /* Exported functions */
781 /*****************************************************************************/
783 chrony_config(const char *p_key, const char *p_value)
788 /* Parse config variables */
789 if (strcasecmp(p_key, CONFIG_KEY_HOST) == 0)
791 if (g_chrony_host != NULL)
794 if ((g_chrony_host = strdup(p_value)) == NULL)
796 ERROR(PLUGIN_NAME ": Error duplicating host name");
797 return CHRONY_RC_FAIL;
802 if (strcasecmp(p_key, CONFIG_KEY_PORT) == 0)
804 if (g_chrony_port != NULL)
807 if ((g_chrony_port = strdup(p_value)) == NULL)
809 ERROR(PLUGIN_NAME ": Error duplicating port name");
810 return CHRONY_RC_FAIL;
815 if (strcasecmp(p_key, CONFIG_KEY_TIMEOUT) == 0)
817 time_t tosec = strtol(p_value, NULL, 0);
818 g_chrony_timeout = tosec;
822 WARNING(PLUGIN_NAME ": Unknown configuration variable: %s %s", p_key, p_value);
823 return CHRONY_RC_FAIL;
827 /* XXX: We could set g_chrony_plugin_instance here to "g_chrony_host-g_chrony_port", but as multiple instances aren't yet supported, we skip this for now */
834 chrony_request_daemon_stats(void)
836 /* Perform Tracking request */
838 size_t chrony_resp_size;
839 tChrony_Request chrony_req;
840 tChrony_Response chrony_resp;
842 chrony_init_req(&chrony_req);
844 chrony_query(REQ_TRACKING, &chrony_req, &chrony_resp, &chrony_resp_size);
847 ERROR(PLUGIN_NAME ": chrony_query (REQ_TRACKING) failed with status %i",
853 char src_addr[IPV6_STR_MAX_SIZE] = { 0 };
854 niptoha(&chrony_resp.body.tracking.addr, src_addr, sizeof(src_addr));
855 DEBUG(PLUGIN_NAME ": Daemon stat: .addr = %s, .ref_id= %u, .stratum = %u, .leap_status = %u, .ref_time = %u:%u:%u, .current_correction = %f, .last_offset = %f, .rms_offset = %f, .freq_ppm = %f, .skew_ppm = %f, .root_delay = %f, .root_dispersion = %f, .last_update_interval = %f", src_addr, ntohs(chrony_resp.body.tracking.f_ref_id),
856 ntohs(chrony_resp.body.tracking.f_stratum),
857 ntohs(chrony_resp.body.tracking.f_leap_status),
858 ntohl(chrony_resp.body.tracking.f_ref_time.tv_sec_high),
859 ntohl(chrony_resp.body.tracking.f_ref_time.tv_sec_low),
860 ntohl(chrony_resp.body.tracking.f_ref_time.tv_nsec),
861 ntohf(chrony_resp.body.tracking.f_current_correction),
862 ntohf(chrony_resp.body.tracking.f_last_offset),
863 ntohf(chrony_resp.body.tracking.f_rms_offset),
864 ntohf(chrony_resp.body.tracking.f_freq_ppm),
865 ntohf(chrony_resp.body.tracking.f_skew_ppm),
866 ntohf(chrony_resp.body.tracking.f_root_delay),
867 ntohf(chrony_resp.body.tracking.f_root_dispersion),
868 ntohf(chrony_resp.body.tracking.f_last_update_interval));
872 double time_ref = ntohl(chrony_resp.body.tracking.f_ref_time.tv_nsec);
873 time_ref /= 1000000000.0;
874 time_ref += ntohl(chrony_resp.body.tracking.f_ref_time.tv_sec_low);
875 if (chrony_resp.body.tracking.f_ref_time.tv_sec_high)
878 ntohl(chrony_resp.body.tracking.f_ref_time.tv_sec_high);
879 secs_high *= 4294967296.0;
880 time_ref += secs_high;
883 /* Forward results to collectd-daemon */
884 /* Type_instance is always 'chrony' to tag daemon-wide data */
885 /* Type Type_instan Value */
886 chrony_push_data("clock_stratum", DAEMON_NAME, ntohs(chrony_resp.body.tracking.f_stratum));
887 chrony_push_data("time_ref", DAEMON_NAME, time_ref); /* unit: s */
888 chrony_push_data("time_offset_ntp", DAEMON_NAME, ntohf(chrony_resp.body.tracking.f_current_correction)); /* Offset between system time and NTP, unit: s */
889 chrony_push_data("time_offset", DAEMON_NAME, ntohf(chrony_resp.body.tracking.f_last_offset)); /* Estimated Offset of the NTP time, unit: s */
890 chrony_push_data("time_offset_rms", DAEMON_NAME, ntohf(chrony_resp.body.tracking.f_rms_offset)); /* averaged value of the above, unit: s */
891 chrony_push_data("frequency_error", DAEMON_NAME, ntohf(chrony_resp.body.tracking.f_freq_ppm)); /* Frequency error of the local osc, unit: ppm */
892 chrony_push_data("clock_skew_ppm", DAEMON_NAME, ntohf(chrony_resp.body.tracking.f_skew_ppm));
893 chrony_push_data("root_delay", DAEMON_NAME, ntohf(chrony_resp.body.tracking.f_root_delay)); /* Network latency between local daemon and the current source */
894 chrony_push_data("root_dispersion", DAEMON_NAME, ntohf(chrony_resp.body.tracking.f_root_dispersion));
895 chrony_push_data("clock_last_update", DAEMON_NAME, ntohf(chrony_resp.body.tracking.f_last_update_interval));
902 chrony_request_sources_count(unsigned int *p_count)
904 /* Requests the number of time sources from the chrony daemon */
906 size_t chrony_resp_size;
907 tChrony_Request chrony_req;
908 tChrony_Response chrony_resp;
910 DEBUG(PLUGIN_NAME ": Requesting data");
911 chrony_init_req(&chrony_req);
913 chrony_query(REQ_N_SOURCES, &chrony_req, &chrony_resp, &chrony_resp_size);
916 ERROR(PLUGIN_NAME ": chrony_query (REQ_N_SOURCES) failed with status %i",
921 *p_count = ntohl(chrony_resp.body.n_sources.f_n_sources);
922 DEBUG(PLUGIN_NAME ": Getting data of %d clock sources", *p_count);
929 chrony_request_source_data(int p_src_idx, int *p_is_reachable)
931 /* Perform Source data request for source #p_src_idx */
933 size_t chrony_resp_size;
934 tChrony_Request chrony_req;
935 tChrony_Response chrony_resp;
937 char src_addr[IPV6_STR_MAX_SIZE] = { 0 };
939 chrony_init_req(&chrony_req);
940 chrony_req.body.source_data.f_index = htonl(p_src_idx);
942 chrony_query(REQ_SOURCE_DATA, &chrony_req, &chrony_resp,
947 ": chrony_query (REQ_SOURCE_DATA) failed with status %i", rc);
951 niptoha(&chrony_resp.body.source_data.addr, src_addr, sizeof(src_addr));
953 ": Source[%d] data: .addr = %s, .poll = %u, .stratum = %u, .state = %u, .mode = %u, .flags = %u, .reach = %u, .latest_meas_ago = %u, .orig_latest_meas = %f, .latest_meas = %f, .latest_meas_err = %f",
954 p_src_idx, src_addr, ntohs(chrony_resp.body.source_data.f_poll),
955 ntohs(chrony_resp.body.source_data.f_stratum),
956 ntohs(chrony_resp.body.source_data.f_state),
957 ntohs(chrony_resp.body.source_data.f_mode),
958 ntohs(chrony_resp.body.source_data.f_flags),
959 ntohs(chrony_resp.body.source_data.f_reachability),
960 ntohl(chrony_resp.body.source_data.f_since_sample),
961 ntohf(chrony_resp.body.source_data.f_origin_latest_meas),
962 ntohf(chrony_resp.body.source_data.f_latest_meas),
963 ntohf(chrony_resp.body.source_data.f_latest_meas_err));
965 /* Push NaN if source is currently not reachable */
967 ntohs(chrony_resp.body.source_data.f_reachability) & 0x01;
968 *p_is_reachable = is_reachable;
970 /* Forward results to collectd-daemon */
971 chrony_push_data_valid("clock_stratum", src_addr, is_reachable,
972 ntohs(chrony_resp.body.source_data.f_stratum));
973 chrony_push_data_valid("clock_state", src_addr, is_reachable,
974 ntohs(chrony_resp.body.source_data.f_state));
975 chrony_push_data_valid("clock_mode", src_addr, is_reachable,
976 ntohs(chrony_resp.body.source_data.f_mode));
977 chrony_push_data_valid("clock_reachability", src_addr, is_reachable,
978 ntohs(chrony_resp.body.source_data.f_reachability));
979 chrony_push_data_valid("clock_last_meas", src_addr, is_reachable,
980 ntohs(chrony_resp.body.source_data.f_since_sample));
987 chrony_request_source_stats(int p_src_idx, const int *p_is_reachable)
989 /* Perform Source stats request for source #p_src_idx */
991 size_t chrony_resp_size;
992 tChrony_Request chrony_req;
993 tChrony_Response chrony_resp;
994 double skew_ppm, frequency_error, time_offset;
996 char src_addr[IPV6_STR_MAX_SIZE] = { 0 };
998 if (*p_is_reachable == 0)
1001 frequency_error = 0;
1006 chrony_init_req(&chrony_req);
1007 chrony_req.body.source_stats.f_index = htonl(p_src_idx);
1009 chrony_query(REQ_SOURCE_STATS, &chrony_req, &chrony_resp,
1014 ": chrony_query (REQ_SOURCE_STATS) failed with status %i", rc);
1018 skew_ppm = ntohf(chrony_resp.body.source_stats.f_skew_ppm);
1020 ntohf(chrony_resp.body.source_stats.f_rtc_gain_rate_ppm);
1021 time_offset = ntohf(chrony_resp.body.source_stats.f_est_offset);
1023 niptoha(&chrony_resp.body.source_stats.addr, src_addr, sizeof(src_addr));
1025 ": Source[%d] stat: .addr = %s, .ref_id= %u, .n_samples = %u, "
1026 ".n_runs = %u, .span_seconds = %u, .rtc_seconds_fast = %f, "
1027 ".rtc_gain_rate_ppm = %f, .skew_ppm= %f, .est_offset = %f, .est_offset_err = %f",
1028 p_src_idx, src_addr,
1029 ntohl(chrony_resp.body.source_stats.f_ref_id),
1030 ntohl(chrony_resp.body.source_stats.f_n_samples),
1031 ntohl(chrony_resp.body.source_stats.f_n_runs),
1032 ntohl(chrony_resp.body.source_stats.f_span_seconds),
1033 ntohf(chrony_resp.body.source_stats.f_rtc_seconds_fast),
1034 frequency_error, skew_ppm, time_offset,
1035 ntohf(chrony_resp.body.source_stats.f_est_offset_err));
1037 } /* if (*is_reachable) */
1039 /* Forward results to collectd-daemon */
1040 chrony_push_data_valid("clock_skew_ppm", src_addr, *p_is_reachable, skew_ppm);
1041 chrony_push_data_valid("frequency_error", src_addr, *p_is_reachable, frequency_error); /* unit: ppm */
1042 chrony_push_data_valid("time_offset", src_addr, *p_is_reachable, time_offset); /* unit: s */
1044 return CHRONY_RC_OK;
1051 /* collectd read callback: Perform data acquisition */
1053 unsigned int n_sources;
1055 if (g_chrony_seq_is_initialized == 0)
1057 /* Seed RNG for sequence number generation */
1058 rc = chrony_init_seq();
1059 if (rc != CHRONY_RC_OK)
1062 g_chrony_seq_is_initialized = 1;
1065 /* Get daemon stats */
1066 rc = chrony_request_daemon_stats();
1067 if (rc != CHRONY_RC_OK)
1070 /* Get number of time sources, then check every source for status */
1071 rc = chrony_request_sources_count(&n_sources);
1072 if (rc != CHRONY_RC_OK)
1075 for (unsigned int now_src = 0; now_src < n_sources; ++now_src)
1078 rc = chrony_request_source_data(now_src, &is_reachable);
1079 if (rc != CHRONY_RC_OK)
1082 rc = chrony_request_source_stats(now_src, &is_reachable);
1083 if (rc != CHRONY_RC_OK)
1087 return CHRONY_RC_OK;
1092 chrony_shutdown(void)
1094 /* Collectd shutdown callback: Free mem */
1095 if (g_chrony_is_connected != 0)
1097 close(g_chrony_socket);
1098 g_chrony_is_connected = 0;
1100 if (g_chrony_host != NULL)
1101 sfree(g_chrony_host);
1103 if (g_chrony_port != NULL)
1104 sfree(g_chrony_port);
1106 if (g_chrony_plugin_instance != NULL)
1107 sfree(g_chrony_plugin_instance);
1109 return CHRONY_RC_OK;
1114 module_register(void)
1116 plugin_register_config(PLUGIN_NAME_SHORT, chrony_config, g_config_keys,
1118 plugin_register_read(PLUGIN_NAME_SHORT, chrony_read);
1119 plugin_register_shutdown(PLUGIN_NAME_SHORT, chrony_shutdown);