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
25 * - Plausibility checks on values received
26 * -> Done at higher levels
31 #include "common.h" /* auxiliary functions */
32 #include "plugin.h" /* plugin_register_*, plugin_dispatch_values */
35 #include <netdb.h> /* struct addrinfo */
38 #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 \
46 "/dev/urandom" /* Used to initialize seq nr generator */
47 #define RAND_DEVICE_PATH \
48 "/dev/random" /* Used to initialize seq nr generator (fall back) */
50 static const char *g_config_keys[] = {CONFIG_KEY_HOST, CONFIG_KEY_PORT,
53 static int g_config_keys_num = STATIC_ARRAY_SIZE(g_config_keys);
54 static int g_chrony_is_connected;
55 static int g_chrony_socket = -1;
56 static time_t g_chrony_timeout = -1;
57 static char *g_chrony_plugin_instance;
58 static char *g_chrony_host;
59 static char *g_chrony_port;
60 static uint32_t g_chrony_rand = 1;
61 static uint32_t g_chrony_seq_is_initialized;
63 #define PLUGIN_NAME_SHORT "chrony"
64 #define PLUGIN_NAME PLUGIN_NAME_SHORT " plugin"
65 #define DAEMON_NAME PLUGIN_NAME_SHORT
66 #define CHRONY_DEFAULT_HOST "localhost"
67 #define CHRONY_DEFAULT_PORT "323"
68 #define CHRONY_DEFAULT_TIMEOUT 2
70 /* Return codes (collectd expects non-zero on errors) */
71 #define CHRONY_RC_OK 0
72 #define CHRONY_RC_FAIL 1
74 /* Chronyd command packet variables adapted from chrony/candm.h (GPL2) */
75 #define PROTO_VERSION_NUMBER 6
76 #define IPADDR_UNSPEC 0
77 #define IPADDR_INET4 1
78 #define IPADDR_INET6 2
79 #define IPV6_STR_MAX_SIZE (8 * 4 + 7 + 1)
81 typedef enum { PKT_TYPE_CMD_REQUEST = 1, PKT_TYPE_CMD_REPLY = 2 } ePacketType;
94 RPY_MANUAL_TIMESTAMP = 4,
100 #if defined(__GNUC__) || defined(__SUNPRO_C) || defined(lint)
101 #/* extension to enforce struct packing. */
102 #define ATTRIB_PACKED __attribute__((packed))
104 #error Not defining packed attribute (unknown compiler)
105 #define ATTRIB_PACKED
108 typedef struct ATTRIB_PACKED { int32_t value; } tFloat;
110 typedef struct ATTRIB_PACKED {
111 uint32_t tv_sec_high;
121 STT_NOSUCHSOURCE = 4,
125 STT_ACCESSALLOWED = 8,
126 STT_ACCESSDENIED = 9,
127 STT_NOHOSTACCESS = 10,
128 STT_SOURCEALREADYKNOWN = 11,
129 STT_TOOMANYSOURCES = 12,
135 STT_BADPKTVERSION = 18,
136 STT_BADPKTLENGTH = 19
139 /* Chrony client request packets */
140 typedef struct ATTRIB_PACKED {
141 uint8_t f_dummy0[80]; /* Chrony expects 80bytes dummy data (Avoiding UDP
143 } tChrony_Req_Tracking;
145 typedef struct ATTRIB_PACKED { uint32_t f_n_sources; } tChrony_Req_N_Sources;
147 typedef struct ATTRIB_PACKED {
149 uint8_t f_dummy0[44];
150 } tChrony_Req_Source_data;
152 typedef struct ATTRIB_PACKED {
154 uint8_t f_dummy0[56];
155 } tChrony_Req_Source_stats;
157 typedef struct ATTRIB_PACKED {
169 } header; /* Packed: 20Bytes */
171 tChrony_Req_N_Sources n_sources;
172 tChrony_Req_Source_data source_data;
173 tChrony_Req_Source_stats source_stats;
174 tChrony_Req_Tracking tracking;
176 uint8_t padding[4 + 16]; /* Padding to match minimal response size */
179 /* Chrony daemon response packets */
180 typedef struct ATTRIB_PACKED { uint32_t f_n_sources; } tChrony_Resp_N_Sources;
182 typedef struct ATTRIB_PACKED {
190 typedef struct ATTRIB_PACKED {
193 dummy; /* FIXME: Strange dummy space. Needed on gcc 4.8.3/clang 3.4.1 on
195 int16_t f_poll; /* 2^f_poll = Time between polls (s) */
196 uint16_t f_stratum; /* Remote clock stratum */
197 uint16_t f_state; /* 0 = RPY_SD_ST_SYNC, 1 = RPY_SD_ST_UNREACH, 2 =
198 RPY_SD_ST_FALSETICKER */
199 /* 3 = RPY_SD_ST_JITTERY, 4 = RPY_SD_ST_CANDIDATE, 5 = RPY_SD_ST_OUTLIER */
200 uint16_t f_mode; /* 0 = RPY_SD_MD_CLIENT, 1 = RPY_SD_MD_PEER, 2 =
202 uint16_t f_flags; /* unused */
204 f_reachability; /* Bit mask of successfull tries to reach the source */
206 uint32_t f_since_sample; /* Time since last sample (s) */
207 tFloat f_origin_latest_meas; /* */
208 tFloat f_latest_meas; /* */
209 tFloat f_latest_meas_err; /* */
210 } tChrony_Resp_Source_data;
212 typedef struct ATTRIB_PACKED {
216 dummy; /* FIXME: Strange dummy space. Needed on gcc 4.8.3/clang 3.4.1 on
218 uint32_t f_n_samples; /* Number of measurements done */
219 uint32_t f_n_runs; /* How many measurements to come */
220 uint32_t f_span_seconds; /* For how long we're measuring */
221 tFloat f_rtc_seconds_fast; /* ??? */
222 tFloat f_rtc_gain_rate_ppm; /* Estimated relative frequency error */
223 tFloat f_skew_ppm; /* Clock skew (ppm) (worst case freq est error (skew:
225 tFloat f_est_offset; /* Estimated offset of source */
226 tFloat f_est_offset_err; /* Error of estimation */
227 } tChrony_Resp_Source_stats;
229 typedef struct ATTRIB_PACKED {
233 dummy; /* FIXME: Strange dummy space. Needed on gcc 4.8.3/clang 3.4.1 on
236 uint16_t f_leap_status;
238 tFloat f_current_correction;
239 tFloat f_last_offset;
242 tFloat f_resid_freq_ppm;
245 tFloat f_root_dispersion;
246 tFloat f_last_update_interval;
247 } tChrony_Resp_Tracking;
249 typedef struct ATTRIB_PACKED {
264 } header; /* Packed: 28 Bytes */
267 tChrony_Resp_N_Sources n_sources;
268 tChrony_Resp_Source_data source_data;
269 tChrony_Resp_Source_stats source_stats;
270 tChrony_Resp_Tracking tracking;
273 uint8_t padding[1024];
276 /*****************************************************************************/
277 /* Internal functions */
278 /*****************************************************************************/
280 /* connect_client code adapted from:
281 * http://long.ccaba.upc.edu/long/045Guidelines/eva/ipv6.html#daytimeClient6 */
282 /* License granted by Eva M Castro via e-mail on 2016-02-18 under the terms of
284 static int connect_client(const char *p_hostname, const char *p_service,
285 int p_family, int p_socktype) {
286 struct addrinfo *res, *ressave;
289 struct addrinfo ai_hints = {.ai_family = p_family, .ai_socktype = p_socktype};
291 n = getaddrinfo(p_hostname, p_service, &ai_hints, &res);
294 ERROR(PLUGIN_NAME ": getaddrinfo error:: [%s]", gai_strerror(n));
302 sockfd = socket(res->ai_family, res->ai_socktype, res->ai_protocol);
305 if (connect(sockfd, res->ai_addr, res->ai_addrlen) == 0) {
316 freeaddrinfo(ressave);
320 /* niptoha code originally from:
321 * git://git.tuxfamily.org/gitroot/chrony/chrony.git:util.c */
322 /* Original code licensed as GPLv2, by Richard P. Purnow, Miroslav Lichvar */
323 /* Original name: char * UTI_IPToString(IPAddr *addr)*/
324 static char *niptoha(const tChrony_IPAddr *addr, char *p_buf,
327 unsigned long a, b, c, d, ip;
329 switch (ntohs(addr->f_family)) {
331 rc = snprintf(p_buf, p_buf_size, "[UNSPEC]");
334 ip = ntohl(addr->addr.ip4);
335 a = (ip >> 24) & 0xff;
336 b = (ip >> 16) & 0xff;
337 c = (ip >> 8) & 0xff;
338 d = (ip >> 0) & 0xff;
339 rc = snprintf(p_buf, p_buf_size, "%ld.%ld.%ld.%ld", a, b, c, d);
342 const char *rp = inet_ntop(AF_INET6, addr->addr.ip6, p_buf, p_buf_size);
344 ERROR(PLUGIN_NAME ": Error converting ipv6 address to string. Errno = %d",
346 rc = snprintf(p_buf, p_buf_size, "[UNKNOWN]");
351 rc = snprintf(p_buf, p_buf_size, "[UNKNOWN]");
357 static int chrony_set_timeout(void) {
358 /* Set the socket's timeout to g_chrony_timeout; a value of 0 signals
359 * infinite timeout */
360 /* Returns 0 on success, !0 on error (check errno) */
363 tv.tv_sec = g_chrony_timeout;
366 assert(g_chrony_socket >= 0);
367 if (setsockopt(g_chrony_socket, SOL_SOCKET, SO_RCVTIMEO, (char *)&tv,
368 sizeof(struct timeval)) < 0) {
369 return CHRONY_RC_FAIL;
374 static int chrony_connect(void) {
375 /* Connects to the chrony daemon */
376 /* Returns 0 on success, !0 on error (check errno) */
379 if (g_chrony_host == NULL) {
380 g_chrony_host = strdup(CHRONY_DEFAULT_HOST);
381 if (g_chrony_host == NULL) {
382 ERROR(PLUGIN_NAME ": Error duplicating chrony host name");
383 return CHRONY_RC_FAIL;
386 if (g_chrony_port == NULL) {
387 g_chrony_port = strdup(CHRONY_DEFAULT_PORT);
388 if (g_chrony_port == NULL) {
389 ERROR(PLUGIN_NAME ": Error duplicating chrony port string");
390 return CHRONY_RC_FAIL;
393 if (g_chrony_timeout < 0) {
394 g_chrony_timeout = CHRONY_DEFAULT_TIMEOUT;
395 assert(g_chrony_timeout >= 0);
398 DEBUG(PLUGIN_NAME ": Connecting to %s:%s", g_chrony_host, g_chrony_port);
399 socket = connect_client(g_chrony_host, g_chrony_port, AF_UNSPEC, SOCK_DGRAM);
401 ERROR(PLUGIN_NAME ": Error connecting to daemon. Errno = %d", errno);
402 return CHRONY_RC_FAIL;
404 DEBUG(PLUGIN_NAME ": Connected");
405 g_chrony_socket = socket;
407 if (chrony_set_timeout()) {
408 ERROR(PLUGIN_NAME ": Error setting timeout to %llds. Errno = %d",
409 (long long)g_chrony_timeout, errno);
410 return CHRONY_RC_FAIL;
415 static int chrony_send_request(const tChrony_Request *p_req,
417 if (send(g_chrony_socket, p_req, p_req_size, 0) < 0) {
418 ERROR(PLUGIN_NAME ": Error sending packet. Errno = %d", errno);
419 return CHRONY_RC_FAIL;
424 static int chrony_recv_response(tChrony_Response *p_resp,
425 size_t p_resp_max_size, size_t *p_resp_size) {
426 ssize_t rc = recv(g_chrony_socket, p_resp, p_resp_max_size, 0);
428 ERROR(PLUGIN_NAME ": Error receiving packet: %s (%d)", strerror(errno),
430 return CHRONY_RC_FAIL;
437 static int chrony_query(const int p_command, tChrony_Request *p_req,
438 tChrony_Response *p_resp, size_t *p_resp_size) {
439 /* Check connection. We simply perform one try as collectd already handles
445 if (g_chrony_is_connected == 0) {
446 if (chrony_connect() == CHRONY_RC_OK) {
447 g_chrony_is_connected = 1;
449 ERROR(PLUGIN_NAME ": Unable to connect. Errno = %d", errno);
450 return CHRONY_RC_FAIL;
455 int valid_command = 0;
456 size_t req_size = sizeof(p_req->header) + sizeof(p_req->padding);
457 size_t resp_size = sizeof(p_resp->header);
458 uint16_t resp_code = RPY_NULL;
461 req_size += sizeof(p_req->body.tracking);
462 resp_size += sizeof(p_resp->body.tracking);
463 resp_code = RPY_TRACKING;
467 req_size += sizeof(p_req->body.n_sources);
468 resp_size += sizeof(p_resp->body.n_sources);
469 resp_code = RPY_N_SOURCES;
472 case REQ_SOURCE_DATA:
473 req_size += sizeof(p_req->body.source_data);
474 resp_size += sizeof(p_resp->body.source_data);
475 resp_code = RPY_SOURCE_DATA;
478 case REQ_SOURCE_STATS:
479 req_size += sizeof(p_req->body.source_stats);
480 resp_size += sizeof(p_resp->body.source_stats);
481 resp_code = RPY_SOURCE_STATS;
485 ERROR(PLUGIN_NAME ": Unknown request command (Was: %d)", p_command);
489 if (valid_command == 0)
492 uint32_t seq_nr = rand_r(&g_chrony_rand);
493 p_req->header.f_cmd = htons(p_command);
494 p_req->header.f_cmd_try = 0;
495 p_req->header.f_seq = seq_nr;
497 DEBUG(PLUGIN_NAME ": Sending request (.cmd = %d, .seq = %d)", p_command,
499 if (chrony_send_request(p_req, req_size) != 0)
502 DEBUG(PLUGIN_NAME ": Waiting for response");
503 if (chrony_recv_response(p_resp, resp_size, p_resp_size) != 0)
506 DEBUG(PLUGIN_NAME ": Received response: .version = %u, .type = %u, .cmd = "
507 "%u, .reply = %u, .status = %u, .seq = %u",
508 p_resp->header.f_version, p_resp->header.f_type,
509 ntohs(p_resp->header.f_cmd), ntohs(p_resp->header.f_reply),
510 ntohs(p_resp->header.f_status), p_resp->header.f_seq);
512 if (p_resp->header.f_version != p_req->header.f_version) {
513 ERROR(PLUGIN_NAME ": Wrong protocol version (Was: %d, expected: %d)",
514 p_resp->header.f_version, p_req->header.f_version);
515 return CHRONY_RC_FAIL;
517 if (p_resp->header.f_type != PKT_TYPE_CMD_REPLY) {
518 ERROR(PLUGIN_NAME ": Wrong packet type (Was: %d, expected: %d)",
519 p_resp->header.f_type, PKT_TYPE_CMD_REPLY);
520 return CHRONY_RC_FAIL;
522 if (p_resp->header.f_seq != seq_nr) {
523 /* FIXME: Implement sequence number handling */
524 ERROR(PLUGIN_NAME ": Unexpected sequence number (Was: %d, expected: %d)",
525 p_resp->header.f_seq, p_req->header.f_seq);
526 return CHRONY_RC_FAIL;
528 if (p_resp->header.f_cmd != p_req->header.f_cmd) {
529 ERROR(PLUGIN_NAME ": Wrong reply command (Was: %d, expected: %d)",
530 p_resp->header.f_cmd, p_req->header.f_cmd);
531 return CHRONY_RC_FAIL;
534 if (ntohs(p_resp->header.f_reply) != resp_code) {
535 ERROR(PLUGIN_NAME ": Wrong reply code (Was: %d, expected: %d)",
536 ntohs(p_resp->header.f_reply), resp_code);
537 return CHRONY_RC_FAIL;
540 switch (p_resp->header.f_status) {
542 DEBUG(PLUGIN_NAME ": Reply packet status STT_SUCCESS");
546 ": Reply packet contains error status: %d (expected: %d)",
547 p_resp->header.f_status, STT_SUCCESS);
548 return CHRONY_RC_FAIL;
555 /* Some error occured */
556 return CHRONY_RC_FAIL;
559 static void chrony_init_req(tChrony_Request *p_req) {
560 memset(p_req, 0, sizeof(*p_req));
561 p_req->header.f_version = PROTO_VERSION_NUMBER;
562 p_req->header.f_type = PKT_TYPE_CMD_REQUEST;
563 p_req->header.f_dummy0 = 0;
564 p_req->header.f_dummy1 = 0;
565 p_req->header.f_dummy2 = 0;
566 p_req->header.f_dummy3 = 0;
569 /* ntohf code originally from:
570 * git://git.tuxfamily.org/gitroot/chrony/chrony.git:util.c */
571 /* Original code licensed as GPLv2, by Richard P. Purnow, Miroslav Lichvar */
572 /* Original name: double UTI_tFloatNetworkToHost(tFloat f) */
573 static double ntohf(tFloat p_float) {
574 /* Convert tFloat in Network-bit-order to double in host-bit-order */
576 #define FLOAT_EXP_BITS 7
577 #define FLOAT_EXP_MIN (-(1 << (FLOAT_EXP_BITS - 1)))
578 #define FLOAT_EXP_MAX (-FLOAT_EXP_MIN - 1)
579 #define FLOAT_COEF_BITS ((int)sizeof(int32_t) * 8 - FLOAT_EXP_BITS)
580 #define FLOAT_COEF_MIN (-(1 << (FLOAT_COEF_BITS - 1)))
581 #define FLOAT_COEF_MAX (-FLOAT_COEF_MIN - 1)
586 uval = ntohl(p_float.value);
587 exp = (uval >> FLOAT_COEF_BITS) - FLOAT_COEF_BITS;
588 if (exp >= 1 << (FLOAT_EXP_BITS - 1))
589 exp -= 1 << FLOAT_EXP_BITS;
591 /* coef = (x << FLOAT_EXP_BITS) >> FLOAT_EXP_BITS; */
592 coef = uval % (1U << FLOAT_COEF_BITS);
593 if (coef >= 1 << (FLOAT_COEF_BITS - 1))
594 coef -= 1 << FLOAT_COEF_BITS;
596 return coef * pow(2.0, exp);
599 static void chrony_push_data(const char *p_type, const char *p_type_inst,
601 value_list_t vl = VALUE_LIST_INIT;
603 vl.values = &(value_t){.gauge = p_value};
606 /* XXX: Shall g_chrony_host/g_chrony_port be reflected in the plugin's output?
608 sstrncpy(vl.plugin, PLUGIN_NAME_SHORT, sizeof(vl.plugin));
609 if (g_chrony_plugin_instance != NULL) {
610 sstrncpy(vl.plugin_instance, g_chrony_plugin_instance,
611 sizeof(vl.plugin_instance));
614 sstrncpy(vl.type, p_type, sizeof(vl.type));
616 if (p_type_inst != NULL)
617 sstrncpy(vl.type_instance, p_type_inst, sizeof(vl.type_instance));
619 plugin_dispatch_values(&vl);
622 static void chrony_push_data_valid(const char *p_type, const char *p_type_inst,
623 const int p_is_valid, double p_value) {
624 /* Push real value if p_is_valid is true, push NAN if p_is_valid is not true
625 * (idea from ntp plugin) */
629 chrony_push_data(p_type, p_type_inst, p_value);
632 static int chrony_init_seq(void) {
633 /* Initialize the sequence number generator from /dev/urandom */
634 /* Fallbacks: /dev/random and time(NULL) */
639 fh = open(URAND_DEVICE_PATH, O_RDONLY);
641 ssize_t rc = read(fh, &g_chrony_rand, sizeof(g_chrony_rand));
642 if (rc != sizeof(g_chrony_rand)) {
643 ERROR(PLUGIN_NAME ": Reading from random source \'%s\'failed: %s (%d)",
644 URAND_DEVICE_PATH, strerror(errno), errno);
646 return CHRONY_RC_FAIL;
649 DEBUG(PLUGIN_NAME ": Seeding RNG from " URAND_DEVICE_PATH);
651 if (errno == ENOENT) {
652 /* URAND_DEVICE_PATH device not found. Try RAND_DEVICE_PATH as fall-back
654 fh = open(RAND_DEVICE_PATH, O_RDONLY);
656 ssize_t rc = read(fh, &g_chrony_rand, sizeof(g_chrony_rand));
657 if (rc != sizeof(g_chrony_rand)) {
659 ": Reading from random source \'%s\'failed: %s (%d)",
660 RAND_DEVICE_PATH, strerror(errno), errno);
662 return CHRONY_RC_FAIL;
665 DEBUG(PLUGIN_NAME ": Seeding RNG from " RAND_DEVICE_PATH);
667 /* Error opening RAND_DEVICE_PATH. Try time(NULL) as fall-back */
668 DEBUG(PLUGIN_NAME ": Seeding RNG from time(NULL)");
669 g_chrony_rand = time(NULL) ^ getpid();
672 ERROR(PLUGIN_NAME ": Opening random source \'%s\' failed: %s (%d)",
673 URAND_DEVICE_PATH, strerror(errno), errno);
674 return CHRONY_RC_FAIL;
681 /*****************************************************************************/
682 /* Exported functions */
683 /*****************************************************************************/
684 static int chrony_config(const char *p_key, const char *p_value) {
688 /* Parse config variables */
689 if (strcasecmp(p_key, CONFIG_KEY_HOST) == 0) {
690 if (g_chrony_host != NULL)
693 if ((g_chrony_host = strdup(p_value)) == NULL) {
694 ERROR(PLUGIN_NAME ": Error duplicating host name");
695 return CHRONY_RC_FAIL;
698 if (strcasecmp(p_key, CONFIG_KEY_PORT) == 0) {
699 if (g_chrony_port != NULL)
702 if ((g_chrony_port = strdup(p_value)) == NULL) {
703 ERROR(PLUGIN_NAME ": Error duplicating port name");
704 return CHRONY_RC_FAIL;
707 if (strcasecmp(p_key, CONFIG_KEY_TIMEOUT) == 0) {
708 time_t tosec = strtol(p_value, NULL, 0);
709 g_chrony_timeout = tosec;
711 WARNING(PLUGIN_NAME ": Unknown configuration variable: %s %s", p_key,
713 return CHRONY_RC_FAIL;
717 /* XXX: We could set g_chrony_plugin_instance here to
718 * "g_chrony_host-g_chrony_port", but as multiple instances aren't yet
719 * supported, we skip this for now */
724 static int chrony_request_daemon_stats(void) {
725 /* Perform Tracking request */
727 size_t chrony_resp_size;
728 tChrony_Request chrony_req;
729 tChrony_Response chrony_resp;
731 chrony_init_req(&chrony_req);
732 rc = chrony_query(REQ_TRACKING, &chrony_req, &chrony_resp, &chrony_resp_size);
734 ERROR(PLUGIN_NAME ": chrony_query (REQ_TRACKING) failed with status %i",
740 char src_addr[IPV6_STR_MAX_SIZE] = {0};
741 niptoha(&chrony_resp.body.tracking.addr, src_addr, sizeof(src_addr));
743 ": Daemon stat: .addr = %s, .ref_id= %u, .stratum = %u, .leap_status "
744 "= %u, .ref_time = %u:%u:%u, .current_correction = %f, .last_offset "
745 "= %f, .rms_offset = %f, .freq_ppm = %f, .skew_ppm = %f, .root_delay "
746 "= %f, .root_dispersion = %f, .last_update_interval = %f",
747 src_addr, ntohs(chrony_resp.body.tracking.f_ref_id),
748 ntohs(chrony_resp.body.tracking.f_stratum),
749 ntohs(chrony_resp.body.tracking.f_leap_status),
750 ntohl(chrony_resp.body.tracking.f_ref_time.tv_sec_high),
751 ntohl(chrony_resp.body.tracking.f_ref_time.tv_sec_low),
752 ntohl(chrony_resp.body.tracking.f_ref_time.tv_nsec),
753 ntohf(chrony_resp.body.tracking.f_current_correction),
754 ntohf(chrony_resp.body.tracking.f_last_offset),
755 ntohf(chrony_resp.body.tracking.f_rms_offset),
756 ntohf(chrony_resp.body.tracking.f_freq_ppm),
757 ntohf(chrony_resp.body.tracking.f_skew_ppm),
758 ntohf(chrony_resp.body.tracking.f_root_delay),
759 ntohf(chrony_resp.body.tracking.f_root_dispersion),
760 ntohf(chrony_resp.body.tracking.f_last_update_interval));
764 double time_ref = ntohl(chrony_resp.body.tracking.f_ref_time.tv_nsec);
765 time_ref /= 1000000000.0;
766 time_ref += ntohl(chrony_resp.body.tracking.f_ref_time.tv_sec_low);
767 if (chrony_resp.body.tracking.f_ref_time.tv_sec_high) {
768 double secs_high = ntohl(chrony_resp.body.tracking.f_ref_time.tv_sec_high);
769 secs_high *= 4294967296.0;
770 time_ref += secs_high;
773 /* Forward results to collectd-daemon */
774 /* Type_instance is always 'chrony' to tag daemon-wide data */
775 /* Type Type_instan Value */
776 chrony_push_data("clock_stratum", DAEMON_NAME,
777 ntohs(chrony_resp.body.tracking.f_stratum));
778 chrony_push_data("time_ref", DAEMON_NAME, time_ref); /* unit: s */
780 "time_offset_ntp", DAEMON_NAME,
781 ntohf(chrony_resp.body.tracking.f_current_correction)); /* Offset between
785 "time_offset", DAEMON_NAME,
787 chrony_resp.body.tracking
788 .f_last_offset)); /* Estimated Offset of the NTP time, unit: s */
790 "time_offset_rms", DAEMON_NAME,
791 ntohf(chrony_resp.body.tracking
792 .f_rms_offset)); /* averaged value of the above, unit: s */
794 "frequency_error", DAEMON_NAME,
795 ntohf(chrony_resp.body.tracking
796 .f_freq_ppm)); /* Frequency error of the local osc, unit: ppm */
797 chrony_push_data("clock_skew_ppm", DAEMON_NAME,
798 ntohf(chrony_resp.body.tracking.f_skew_ppm));
800 "root_delay", DAEMON_NAME,
801 ntohf(chrony_resp.body.tracking.f_root_delay)); /* Network latency between
804 chrony_push_data("root_dispersion", DAEMON_NAME,
805 ntohf(chrony_resp.body.tracking.f_root_dispersion));
806 chrony_push_data("clock_last_update", DAEMON_NAME,
807 ntohf(chrony_resp.body.tracking.f_last_update_interval));
812 static int chrony_request_sources_count(unsigned int *p_count) {
813 /* Requests the number of time sources from the chrony daemon */
815 size_t chrony_resp_size;
816 tChrony_Request chrony_req;
817 tChrony_Response chrony_resp;
819 DEBUG(PLUGIN_NAME ": Requesting data");
820 chrony_init_req(&chrony_req);
822 chrony_query(REQ_N_SOURCES, &chrony_req, &chrony_resp, &chrony_resp_size);
824 ERROR(PLUGIN_NAME ": chrony_query (REQ_N_SOURCES) failed with status %i",
829 *p_count = ntohl(chrony_resp.body.n_sources.f_n_sources);
830 DEBUG(PLUGIN_NAME ": Getting data of %d clock sources", *p_count);
835 static int chrony_request_source_data(int p_src_idx, int *p_is_reachable) {
836 /* Perform Source data request for source #p_src_idx */
838 size_t chrony_resp_size;
839 tChrony_Request chrony_req;
840 tChrony_Response chrony_resp;
842 char src_addr[IPV6_STR_MAX_SIZE] = {0};
844 chrony_init_req(&chrony_req);
845 chrony_req.body.source_data.f_index = htonl(p_src_idx);
846 rc = chrony_query(REQ_SOURCE_DATA, &chrony_req, &chrony_resp,
849 ERROR(PLUGIN_NAME ": chrony_query (REQ_SOURCE_DATA) failed with status %i",
854 niptoha(&chrony_resp.body.source_data.addr, src_addr, sizeof(src_addr));
855 DEBUG(PLUGIN_NAME ": Source[%d] data: .addr = %s, .poll = %u, .stratum = %u, "
856 ".state = %u, .mode = %u, .flags = %u, .reach = %u, "
857 ".latest_meas_ago = %u, .orig_latest_meas = %f, "
858 ".latest_meas = %f, .latest_meas_err = %f",
859 p_src_idx, src_addr, ntohs(chrony_resp.body.source_data.f_poll),
860 ntohs(chrony_resp.body.source_data.f_stratum),
861 ntohs(chrony_resp.body.source_data.f_state),
862 ntohs(chrony_resp.body.source_data.f_mode),
863 ntohs(chrony_resp.body.source_data.f_flags),
864 ntohs(chrony_resp.body.source_data.f_reachability),
865 ntohl(chrony_resp.body.source_data.f_since_sample),
866 ntohf(chrony_resp.body.source_data.f_origin_latest_meas),
867 ntohf(chrony_resp.body.source_data.f_latest_meas),
868 ntohf(chrony_resp.body.source_data.f_latest_meas_err));
870 /* Push NaN if source is currently not reachable */
871 int is_reachable = ntohs(chrony_resp.body.source_data.f_reachability) & 0x01;
872 *p_is_reachable = is_reachable;
874 /* Forward results to collectd-daemon */
875 chrony_push_data_valid("clock_stratum", src_addr, is_reachable,
876 ntohs(chrony_resp.body.source_data.f_stratum));
877 chrony_push_data_valid("clock_state", src_addr, is_reachable,
878 ntohs(chrony_resp.body.source_data.f_state));
879 chrony_push_data_valid("clock_mode", src_addr, is_reachable,
880 ntohs(chrony_resp.body.source_data.f_mode));
881 chrony_push_data_valid("clock_reachability", src_addr, is_reachable,
882 ntohs(chrony_resp.body.source_data.f_reachability));
883 chrony_push_data_valid("clock_last_meas", src_addr, is_reachable,
884 ntohs(chrony_resp.body.source_data.f_since_sample));
889 static int chrony_request_source_stats(int p_src_idx,
890 const int *p_is_reachable) {
891 /* Perform Source stats request for source #p_src_idx */
893 size_t chrony_resp_size;
894 tChrony_Request chrony_req;
895 tChrony_Response chrony_resp;
896 double skew_ppm, frequency_error, time_offset;
898 char src_addr[IPV6_STR_MAX_SIZE] = {0};
900 if (*p_is_reachable == 0) {
905 chrony_init_req(&chrony_req);
906 chrony_req.body.source_stats.f_index = htonl(p_src_idx);
907 rc = chrony_query(REQ_SOURCE_STATS, &chrony_req, &chrony_resp,
911 ": chrony_query (REQ_SOURCE_STATS) failed with status %i",
916 skew_ppm = ntohf(chrony_resp.body.source_stats.f_skew_ppm);
917 frequency_error = ntohf(chrony_resp.body.source_stats.f_rtc_gain_rate_ppm);
918 time_offset = ntohf(chrony_resp.body.source_stats.f_est_offset);
920 niptoha(&chrony_resp.body.source_stats.addr, src_addr, sizeof(src_addr));
922 ": Source[%d] stat: .addr = %s, .ref_id= %u, .n_samples = %u, "
923 ".n_runs = %u, .span_seconds = %u, .rtc_seconds_fast = %f, "
924 ".rtc_gain_rate_ppm = %f, .skew_ppm= %f, .est_offset = %f, "
925 ".est_offset_err = %f",
926 p_src_idx, src_addr, ntohl(chrony_resp.body.source_stats.f_ref_id),
927 ntohl(chrony_resp.body.source_stats.f_n_samples),
928 ntohl(chrony_resp.body.source_stats.f_n_runs),
929 ntohl(chrony_resp.body.source_stats.f_span_seconds),
930 ntohf(chrony_resp.body.source_stats.f_rtc_seconds_fast),
931 frequency_error, skew_ppm, time_offset,
932 ntohf(chrony_resp.body.source_stats.f_est_offset_err));
934 } /* if (*is_reachable) */
936 /* Forward results to collectd-daemon */
937 chrony_push_data_valid("clock_skew_ppm", src_addr, *p_is_reachable, skew_ppm);
938 chrony_push_data_valid("frequency_error", src_addr, *p_is_reachable,
939 frequency_error); /* unit: ppm */
940 chrony_push_data_valid("time_offset", src_addr, *p_is_reachable,
941 time_offset); /* unit: s */
946 static int chrony_read(void) {
947 /* collectd read callback: Perform data acquisition */
949 unsigned int n_sources;
951 if (g_chrony_seq_is_initialized == 0) {
952 /* Seed RNG for sequence number generation */
953 rc = chrony_init_seq();
954 if (rc != CHRONY_RC_OK)
957 g_chrony_seq_is_initialized = 1;
960 /* Get daemon stats */
961 rc = chrony_request_daemon_stats();
962 if (rc != CHRONY_RC_OK)
965 /* Get number of time sources, then check every source for status */
966 rc = chrony_request_sources_count(&n_sources);
967 if (rc != CHRONY_RC_OK)
970 for (unsigned int now_src = 0; now_src < n_sources; ++now_src) {
972 rc = chrony_request_source_data(now_src, &is_reachable);
973 if (rc != CHRONY_RC_OK)
976 rc = chrony_request_source_stats(now_src, &is_reachable);
977 if (rc != CHRONY_RC_OK)
983 static int chrony_shutdown(void) {
984 /* Collectd shutdown callback: Free mem */
985 if (g_chrony_is_connected != 0) {
986 close(g_chrony_socket);
987 g_chrony_is_connected = 0;
989 if (g_chrony_host != NULL)
990 sfree(g_chrony_host);
992 if (g_chrony_port != NULL)
993 sfree(g_chrony_port);
995 if (g_chrony_plugin_instance != NULL)
996 sfree(g_chrony_plugin_instance);
1001 void module_register(void) {
1002 plugin_register_config(PLUGIN_NAME_SHORT, chrony_config, g_config_keys,
1004 plugin_register_read(PLUGIN_NAME_SHORT, chrony_read);
1005 plugin_register_shutdown(PLUGIN_NAME_SHORT, chrony_shutdown);