sys_tree.c

/*
Copyright (c) 2009-2020 Roger Light <roger@atchoo.org>

All rights reserved. This program and the accompanying materials
are made available under the terms of the Eclipse Public License 2.0
and Eclipse Distribution License v1.0 which accompany this distribution.

The Eclipse Public License is available at
   https://www.eclipse.org/legal/epl-2.0/
and the Eclipse Distribution License is available at
  http://www.eclipse.org/org/documents/edl-v10.php.

SPDX-License-Identifier: EPL-2.0 OR BSD-3-Clause

Contributors:
   Roger Light - initial implementation and documentation.
*/

#ifdef WITH_SYS_TREE

#include "config.h"

#include <math.h>
#include <stdio.h>
#include <limits.h>
#include <inttypes.h>

#include "mosquitto_broker_internal.h"
#include "memory_mosq.h"
#include "time_mosq.h"

#define BUFLEN 100

#define SYS_TREE_QOS 2

uint64_t g_bytes_received = 0;
uint64_t g_bytes_sent = 0;
uint64_t g_pub_bytes_received = 0;
uint64_t g_pub_bytes_sent = 0;
unsigned long g_msgs_received = 0;
unsigned long g_msgs_sent = 0;
unsigned long g_pub_msgs_received = 0;
unsigned long g_pub_msgs_sent = 0;
unsigned long g_msgs_dropped = 0;
unsigned int g_clients_expired = 0;
unsigned int g_socket_connections = 0;
unsigned int g_connection_count = 0;

void sys_tree__init(void)
{
	char buf[64];
	uint32_t len;

	if(db.config->sys_interval == 0){
		return;
	}

	/* Set static $SYS messages */
	len = (uint32_t)snprintf(buf, 64, "mosquitto version %s", VERSION);
	db__messages_easy_queue(NULL, "$SYS/broker/version", SYS_TREE_QOS, len, buf, 1, 0, NULL);
}

static void sys_tree__update_clients(char *buf)
{
	static unsigned int client_count = UINT_MAX;
	static unsigned int clients_expired = UINT_MAX;
	static unsigned int client_max = 0;
	static unsigned int disconnected_count = UINT_MAX;
	static unsigned int connected_count = UINT_MAX;
	uint32_t len;

	unsigned int count_total, count_by_sock;

	count_total = HASH_CNT(hh_id, db.contexts_by_id);
	count_by_sock = HASH_CNT(hh_sock, db.contexts_by_sock);

	if(client_count != count_total){
		client_count = count_total;
		len = (uint32_t)snprintf(buf, BUFLEN, "%d", client_count);
		db__messages_easy_queue(NULL, "$SYS/broker/clients/total", SYS_TREE_QOS, len, buf, 1, 0, NULL);

		if(client_count > client_max){
			client_max = client_count;
			len = (uint32_t)snprintf(buf, BUFLEN, "%d", client_max);
			db__messages_easy_queue(NULL, "$SYS/broker/clients/maximum", SYS_TREE_QOS, len, buf, 1, 0, NULL);
		}
	}

	if(disconnected_count != count_total-count_by_sock){
		disconnected_count = count_total-count_by_sock;
		len = (uint32_t)snprintf(buf, BUFLEN, "%d", disconnected_count);
		db__messages_easy_queue(NULL, "$SYS/broker/clients/inactive", SYS_TREE_QOS, len, buf, 1, 0, NULL);
		db__messages_easy_queue(NULL, "$SYS/broker/clients/disconnected", SYS_TREE_QOS, len, buf, 1, 0, NULL);
	}
	if(connected_count != count_by_sock){
		connected_count = count_by_sock;
		len = (uint32_t)snprintf(buf, BUFLEN, "%d", connected_count);
		db__messages_easy_queue(NULL, "$SYS/broker/clients/active", SYS_TREE_QOS, len, buf, 1, 0, NULL);
		db__messages_easy_queue(NULL, "$SYS/broker/clients/connected", SYS_TREE_QOS, len, buf, 1, 0, NULL);
	}
	if(g_clients_expired != clients_expired){
		clients_expired = g_clients_expired;
		len = (uint32_t)snprintf(buf, BUFLEN, "%d", clients_expired);
		db__messages_easy_queue(NULL, "$SYS/broker/clients/expired", SYS_TREE_QOS, len, buf, 1, 0, NULL);
	}
}

#ifdef REAL_WITH_MEMORY_TRACKING
static void sys_tree__update_memory(char *buf)
{
	static unsigned long current_heap = ULONG_MAX;
	static unsigned long max_heap = ULONG_MAX;
	unsigned long value_ul;
	uint32_t len;

	value_ul = mosquitto__memory_used();
	if(current_heap != value_ul){
		current_heap = value_ul;
		len = (uint32_t)snprintf(buf, BUFLEN, "%lu", current_heap);
		db__messages_easy_queue(NULL, "$SYS/broker/heap/current", SYS_TREE_QOS, len, buf, 1, 0, NULL);
	}
	value_ul =mosquitto__max_memory_used();
	if(max_heap != value_ul){
		max_heap = value_ul;
		len = (uint32_t)snprintf(buf, BUFLEN, "%lu", max_heap);
		db__messages_easy_queue(NULL, "$SYS/broker/heap/maximum", SYS_TREE_QOS, len, buf, 1, 0, NULL);
	}
}
#endif

static void calc_load(char *buf, const char *topic, bool initial, double exponent, double interval, double *current)
{
	double new_value;
	uint32_t len;

	if (initial) {
		new_value = *current;
		len = (uint32_t)snprintf(buf, BUFLEN, "%.2f", new_value);
		db__messages_easy_queue(NULL, topic, SYS_TREE_QOS, len, buf, 1, 0, NULL);
	} else {
		new_value = interval + exponent*((*current) - interval);
		if(fabs(new_value - (*current)) >= 0.01){
			len = (uint32_t)snprintf(buf, BUFLEN, "%.2f", new_value);
			db__messages_easy_queue(NULL, topic, SYS_TREE_QOS, len, buf, 1, 0, NULL);
		}
	}
	(*current) = new_value;
}

/* Send messages for the $SYS hierarchy if the last update is longer than
 * 'interval' seconds ago.
 * 'interval' is the amount of seconds between updates. If 0, then no periodic
 * messages are sent for the $SYS hierarchy.
 * 'start_time' is the result of time() that the broker was started at.
 */
void sys_tree__update(int interval, time_t start_time)
{
	static time_t last_update = 0;
	time_t uptime;
	char buf[BUFLEN];

	static int msg_store_count = INT_MAX;
	static unsigned long msg_store_bytes = ULONG_MAX;
	static unsigned long msgs_received = ULONG_MAX;
	static unsigned long msgs_sent = ULONG_MAX;
	static unsigned long publish_dropped = ULONG_MAX;
	static unsigned long pub_msgs_received = ULONG_MAX;
	static unsigned long pub_msgs_sent = ULONG_MAX;
	static unsigned long long bytes_received = ULLONG_MAX;
	static unsigned long long bytes_sent = ULLONG_MAX;
	static unsigned long long pub_bytes_received = ULLONG_MAX;
	static unsigned long long pub_bytes_sent = ULLONG_MAX;
	static int subscription_count = INT_MAX;
	static int shared_subscription_count = INT_MAX;
	static int retained_count = INT_MAX;

	static double msgs_received_load1 = 0;
	static double msgs_received_load5 = 0;
	static double msgs_received_load15 = 0;
	static double msgs_sent_load1 = 0;
	static double msgs_sent_load5 = 0;
	static double msgs_sent_load15 = 0;
	static double publish_dropped_load1 = 0;
	static double publish_dropped_load5 = 0;
	static double publish_dropped_load15 = 0;
	double msgs_received_interval, msgs_sent_interval, publish_dropped_interval;

	static double publish_received_load1 = 0;
	static double publish_received_load5 = 0;
	static double publish_received_load15 = 0;
	static double publish_sent_load1 = 0;
	static double publish_sent_load5 = 0;
	static double publish_sent_load15 = 0;
	double publish_received_interval, publish_sent_interval;

	static double bytes_received_load1 = 0;
	static double bytes_received_load5 = 0;
	static double bytes_received_load15 = 0;
	static double bytes_sent_load1 = 0;
	static double bytes_sent_load5 = 0;
	static double bytes_sent_load15 = 0;
	double bytes_received_interval, bytes_sent_interval;

	static double socket_load1 = 0;
	static double socket_load5 = 0;
	static double socket_load15 = 0;
	double socket_interval;

	static double connection_load1 = 0;
	static double connection_load5 = 0;
	static double connection_load15 = 0;
	double connection_interval;

	double exponent;
	double i_mult;
	uint32_t len;
	bool initial_publish;

	if(interval && db.now_s - interval > last_update){
		uptime = db.now_s - start_time;
		len = (uint32_t)snprintf(buf, BUFLEN, "%" PRIu64 " seconds", (uint64_t)uptime);
		db__messages_easy_queue(NULL, "$SYS/broker/uptime", SYS_TREE_QOS, len, buf, 1, 0, NULL);

		sys_tree__update_clients(buf);
		initial_publish = false;
		if(last_update == 0){
			initial_publish = true;
			last_update = 1;
		}
		if(last_update > 0){
			i_mult = 60.0/(double)(db.now_s-last_update);

			msgs_received_interval = (double)(g_msgs_received - msgs_received)*i_mult;
			msgs_sent_interval = (double)(g_msgs_sent - msgs_sent)*i_mult;
			publish_dropped_interval = (double)(g_msgs_dropped - publish_dropped)*i_mult;

			publish_received_interval = (double)(g_pub_msgs_received - pub_msgs_received)*i_mult;
			publish_sent_interval = (double)(g_pub_msgs_sent - pub_msgs_sent)*i_mult;

			bytes_received_interval = (double)(g_bytes_received - bytes_received)*i_mult;
			bytes_sent_interval = (double)(g_bytes_sent - bytes_sent)*i_mult;

			socket_interval = g_socket_connections*i_mult;
			g_socket_connections = 0;
			connection_interval = g_connection_count*i_mult;
			g_connection_count = 0;

			/* 1 minute load */
			exponent = exp(-1.0*(double)(db.now_s-last_update)/60.0);

			calc_load(buf, "$SYS/broker/load/messages/received/1min", initial_publish, exponent, msgs_received_interval, &msgs_received_load1);
			calc_load(buf, "$SYS/broker/load/messages/sent/1min", initial_publish, exponent, msgs_sent_interval, &msgs_sent_load1);
			calc_load(buf, "$SYS/broker/load/publish/dropped/1min", initial_publish, exponent, publish_dropped_interval, &publish_dropped_load1);
			calc_load(buf, "$SYS/broker/load/publish/received/1min", initial_publish, exponent, publish_received_interval, &publish_received_load1);
			calc_load(buf, "$SYS/broker/load/publish/sent/1min", initial_publish, exponent, publish_sent_interval, &publish_sent_load1);
			calc_load(buf, "$SYS/broker/load/bytes/received/1min", initial_publish, exponent, bytes_received_interval, &bytes_received_load1);
			calc_load(buf, "$SYS/broker/load/bytes/sent/1min", initial_publish, exponent, bytes_sent_interval, &bytes_sent_load1);
			calc_load(buf, "$SYS/broker/load/sockets/1min", initial_publish, exponent, socket_interval, &socket_load1);
			calc_load(buf, "$SYS/broker/load/connections/1min", initial_publish, exponent, connection_interval, &connection_load1);

			/* 5 minute load */
			exponent = exp(-1.0*(double)(db.now_s-last_update)/300.0);

			calc_load(buf, "$SYS/broker/load/messages/received/5min", initial_publish, exponent, msgs_received_interval, &msgs_received_load5);
			calc_load(buf, "$SYS/broker/load/messages/sent/5min", initial_publish, exponent, msgs_sent_interval, &msgs_sent_load5);
			calc_load(buf, "$SYS/broker/load/publish/dropped/5min", initial_publish, exponent, publish_dropped_interval, &publish_dropped_load5);
			calc_load(buf, "$SYS/broker/load/publish/received/5min", initial_publish, exponent, publish_received_interval, &publish_received_load5);
			calc_load(buf, "$SYS/broker/load/publish/sent/5min", initial_publish, exponent, publish_sent_interval, &publish_sent_load5);
			calc_load(buf, "$SYS/broker/load/bytes/received/5min", initial_publish, exponent, bytes_received_interval, &bytes_received_load5);
			calc_load(buf, "$SYS/broker/load/bytes/sent/5min", initial_publish, exponent, bytes_sent_interval, &bytes_sent_load5);
			calc_load(buf, "$SYS/broker/load/sockets/5min", initial_publish, exponent, socket_interval, &socket_load5);
			calc_load(buf, "$SYS/broker/load/connections/5min", initial_publish, exponent, connection_interval, &connection_load5);

			/* 15 minute load */
			exponent = exp(-1.0*(double)(db.now_s-last_update)/900.0);

			calc_load(buf, "$SYS/broker/load/messages/received/15min", initial_publish, exponent, msgs_received_interval, &msgs_received_load15);
			calc_load(buf, "$SYS/broker/load/messages/sent/15min", initial_publish, exponent, msgs_sent_interval, &msgs_sent_load15);
			calc_load(buf, "$SYS/broker/load/publish/dropped/15min", initial_publish, exponent, publish_dropped_interval, &publish_dropped_load15);
			calc_load(buf, "$SYS/broker/load/publish/received/15min", initial_publish, exponent, publish_received_interval, &publish_received_load15);
			calc_load(buf, "$SYS/broker/load/publish/sent/15min", initial_publish, exponent, publish_sent_interval, &publish_sent_load15);
			calc_load(buf, "$SYS/broker/load/bytes/received/15min", initial_publish, exponent, bytes_received_interval, &bytes_received_load15);
			calc_load(buf, "$SYS/broker/load/bytes/sent/15min", initial_publish, exponent, bytes_sent_interval, &bytes_sent_load15);
			calc_load(buf, "$SYS/broker/load/sockets/15min", initial_publish, exponent, socket_interval, &socket_load15);
			calc_load(buf, "$SYS/broker/load/connections/15min", initial_publish, exponent, connection_interval, &connection_load15);
		}

		if(db.msg_store_count != msg_store_count){
			msg_store_count = db.msg_store_count;
			len = (uint32_t)snprintf(buf, BUFLEN, "%d", msg_store_count);
			db__messages_easy_queue(NULL, "$SYS/broker/messages/stored", SYS_TREE_QOS, len, buf, 1, 0, NULL);
			db__messages_easy_queue(NULL, "$SYS/broker/store/messages/count", SYS_TREE_QOS, len, buf, 1, 0, NULL);
		}

		if (db.msg_store_bytes != msg_store_bytes){
			msg_store_bytes = db.msg_store_bytes;
			len = (uint32_t)snprintf(buf, BUFLEN, "%lu", msg_store_bytes);
			db__messages_easy_queue(NULL, "$SYS/broker/store/messages/bytes", SYS_TREE_QOS, len, buf, 1, 0, NULL);
		}

		if(db.subscription_count != subscription_count){
			subscription_count = db.subscription_count;
			len = (uint32_t)snprintf(buf, BUFLEN, "%d", subscription_count);
			db__messages_easy_queue(NULL, "$SYS/broker/subscriptions/count", SYS_TREE_QOS, len, buf, 1, 0, NULL);
		}

		if(db.shared_subscription_count != shared_subscription_count){
			shared_subscription_count = db.shared_subscription_count;
			len = (uint32_t)snprintf(buf, BUFLEN, "%d", shared_subscription_count);
			db__messages_easy_queue(NULL, "$SYS/broker/shared_subscriptions/count", SYS_TREE_QOS, len, buf, 1, 0, NULL);
		}

		if(db.retained_count != retained_count){
			retained_count = db.retained_count;
			len = (uint32_t)snprintf(buf, BUFLEN, "%d", retained_count);
			db__messages_easy_queue(NULL, "$SYS/broker/retained messages/count", SYS_TREE_QOS, len, buf, 1, 0, NULL);
		}

#ifdef REAL_WITH_MEMORY_TRACKING
		sys_tree__update_memory(buf);
#endif

		if(msgs_received != g_msgs_received){
			msgs_received = g_msgs_received;
			len = (uint32_t)snprintf(buf, BUFLEN, "%lu", msgs_received);
			db__messages_easy_queue(NULL, "$SYS/broker/messages/received", SYS_TREE_QOS, len, buf, 1, 0, NULL);
		}

		if(msgs_sent != g_msgs_sent){
			msgs_sent = g_msgs_sent;
			len = (uint32_t)snprintf(buf, BUFLEN, "%lu", msgs_sent);
			db__messages_easy_queue(NULL, "$SYS/broker/messages/sent", SYS_TREE_QOS, len, buf, 1, 0, NULL);
		}

		if(publish_dropped != g_msgs_dropped){
			publish_dropped = g_msgs_dropped;
			len = (uint32_t)snprintf(buf, BUFLEN, "%lu", publish_dropped);
			db__messages_easy_queue(NULL, "$SYS/broker/publish/messages/dropped", SYS_TREE_QOS, len, buf, 1, 0, NULL);
		}

		if(pub_msgs_received != g_pub_msgs_received){
			pub_msgs_received = g_pub_msgs_received;
			len = (uint32_t)snprintf(buf, BUFLEN, "%lu", pub_msgs_received);
			db__messages_easy_queue(NULL, "$SYS/broker/publish/messages/received", SYS_TREE_QOS, len, buf, 1, 0, NULL);
		}

		if(pub_msgs_sent != g_pub_msgs_sent){
			pub_msgs_sent = g_pub_msgs_sent;
			len = (uint32_t)snprintf(buf, BUFLEN, "%lu", pub_msgs_sent);
			db__messages_easy_queue(NULL, "$SYS/broker/publish/messages/sent", SYS_TREE_QOS, len, buf, 1, 0, NULL);
		}

		if(bytes_received != g_bytes_received){
			bytes_received = g_bytes_received;
			len = (uint32_t)snprintf(buf, BUFLEN, "%llu", bytes_received);
			db__messages_easy_queue(NULL, "$SYS/broker/bytes/received", SYS_TREE_QOS, len, buf, 1, 0, NULL);
		}

		if(bytes_sent != g_bytes_sent){
			bytes_sent = g_bytes_sent;
			len = (uint32_t)snprintf(buf, BUFLEN, "%llu", bytes_sent);
			db__messages_easy_queue(NULL, "$SYS/broker/bytes/sent", SYS_TREE_QOS, len, buf, 1, 0, NULL);
		}

		if(pub_bytes_received != g_pub_bytes_received){
			pub_bytes_received = g_pub_bytes_received;
			len = (uint32_t)snprintf(buf, BUFLEN, "%llu", pub_bytes_received);
			db__messages_easy_queue(NULL, "$SYS/broker/publish/bytes/received", SYS_TREE_QOS, len, buf, 1, 0, NULL);
		}

		if(pub_bytes_sent != g_pub_bytes_sent){
			pub_bytes_sent = g_pub_bytes_sent;
			len = (uint32_t)snprintf(buf, BUFLEN, "%llu", pub_bytes_sent);
			db__messages_easy_queue(NULL, "$SYS/broker/publish/bytes/sent", SYS_TREE_QOS, len, buf, 1, 0, NULL);
		}

		last_update = db.now_s;
	}
}

#endif