mirror of
https://github.com/emqx/neuron.git
synced 2026-10-19 05:51:27 +08:00
eeff
245 lines
8.1 KiB
C
245 lines
8.1 KiB
C
/**
|
|
* NEURON IIoT System for Industry 4.0
|
|
* Copyright (C) 2020-2022 EMQ Technologies Co., Ltd All rights reserved.
|
|
*
|
|
* This program is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU Lesser General Public
|
|
* License as published by the Free Software Foundation; either
|
|
* version 3 of the License, or (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
* Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public License
|
|
* along with this program; if not, write to the Free Software Foundation,
|
|
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
**/
|
|
|
|
#ifndef NEU_METRICS_H
|
|
#define NEU_METRICS_H
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
#include <stdint.h>
|
|
|
|
#include "define.h"
|
|
#include "type.h"
|
|
#include "utils/uthash.h"
|
|
|
|
// forward declaration for neu_adapter_t
|
|
typedef struct neu_adapter neu_adapter_t;
|
|
|
|
typedef enum {
|
|
NEU_METRIC_TYPE_COUNTER,
|
|
NEU_METRIC_TYPE_GAUAGE,
|
|
NEU_METRIC_TYPE_COUNTER_SET,
|
|
} neu_metric_type_e;
|
|
|
|
// node running state
|
|
#define NEU_METRIC_RUNNING_STATE "running_state"
|
|
#define NEU_METRIC_RUNNING_STATE_TYPE NEU_METRIC_TYPE_GAUAGE
|
|
#define NEU_METRIC_RUNNING_STATE_HELP "Node running state"
|
|
|
|
// node link state
|
|
#define NEU_METRIC_LINK_STATE "link_state"
|
|
#define NEU_METRIC_LINK_STATE_TYPE NEU_METRIC_TYPE_GAUAGE
|
|
#define NEU_METRIC_LINK_STATE_HELP "Node link state"
|
|
|
|
// last round trip time in millisends
|
|
#define NEU_METRIC_LAST_RTT_MS "last_rtt_ms"
|
|
#define NEU_METRIC_LAST_RTT_MS_TYPE NEU_METRIC_TYPE_GAUAGE
|
|
#define NEU_METRIC_LAST_RTT_MS_HELP \
|
|
"Last request round trip time in milliseconds"
|
|
#define NEU_METRIC_LAST_RTT_MS_MAX 9999
|
|
|
|
// number of bytes sent
|
|
#define NEU_METRIC_SEND_BYTES "send_bytes"
|
|
#define NEU_METRIC_SEND_BYTES_TYPE NEU_METRIC_TYPE_COUNTER_SET
|
|
#define NEU_METRIC_SEND_BYTES_HELP "Total number of bytes sent"
|
|
|
|
// number of bytes received
|
|
#define NEU_METRIC_RECV_BYTES "recv_bytes"
|
|
#define NEU_METRIC_RECV_BYTES_TYPE NEU_METRIC_TYPE_COUNTER_SET
|
|
#define NEU_METRIC_RECV_BYTES_HELP "Total number of bytes received"
|
|
|
|
// maintained by neuron core
|
|
// number of tag read including errors
|
|
#define NEU_METRIC_TAG_READS_TOTAL "tag_reads_total"
|
|
#define NEU_METRIC_TAG_READS_TOTAL_TYPE NEU_METRIC_TYPE_COUNTER
|
|
#define NEU_METRIC_TAG_READS_TOTAL_HELP \
|
|
"Total number of tag reads including errors"
|
|
|
|
// maintained by neuron core
|
|
// number of tag read errors
|
|
#define NEU_METRIC_TAG_READ_ERRORS_TOTAL "tag_read_errors_total"
|
|
#define NEU_METRIC_TAG_READ_ERRORS_TOTAL_TYPE NEU_METRIC_TYPE_COUNTER
|
|
#define NEU_METRIC_TAG_READ_ERRORS_TOTAL_HELP "Total number of tag read errors"
|
|
|
|
// maintained by neuron core
|
|
// number of tags in group
|
|
#define NEU_METRIC_GROUP_TAGS_TOTAL "group_tags_total"
|
|
#define NEU_METRIC_GROUP_TAGS_TOTAL_TYPE NEU_METRIC_TYPE_GAUAGE
|
|
#define NEU_METRIC_GROUP_TAGS_TOTAL_HELP "Total number of tags in the group"
|
|
|
|
// number of messages sent in last group timer
|
|
#define NEU_METRIC_GROUP_LAST_SEND_MSGS "group_last_send_msgs"
|
|
#define NEU_METRIC_GROUP_LAST_SEND_MSGS_TYPE NEU_METRIC_TYPE_GAUAGE
|
|
#define NEU_METRIC_GROUP_LAST_SEND_MSGS_HELP \
|
|
"Number of messages sent on last group timer invocation"
|
|
|
|
// maintained by neuron core
|
|
// milliseconds consumed in last group timer invocation
|
|
#define NEU_METRIC_GROUP_LAST_TIMER_MS "group_last_timer_ms"
|
|
#define NEU_METRIC_GROUP_LAST_TIMER_MS_TYPE NEU_METRIC_TYPE_GAUAGE
|
|
#define NEU_METRIC_GROUP_LAST_TIMER_MS_HELP \
|
|
"Time in milliseconds consumed on last group timer invocation"
|
|
|
|
// number of messages sent
|
|
#define NEU_METRIC_SEND_MSGS_TOTAL "send_msgs_total"
|
|
#define NEU_METRIC_SEND_MSGS_TOTAL_TYPE NEU_METRIC_TYPE_COUNTER
|
|
#define NEU_METRIC_SEND_MSGS_TOTAL_HELP "Total number of messages sent"
|
|
|
|
// number of errors encounter while sending messages
|
|
#define NEU_METRIC_SEND_MSG_ERRORS_TOTAL "send_msg_errors_total"
|
|
#define NEU_METRIC_SEND_MSG_ERRORS_TOTAL_TYPE NEU_METRIC_TYPE_COUNTER
|
|
#define NEU_METRIC_SEND_MSG_ERRORS_TOTAL_HELP \
|
|
"Total number of errors sending messages"
|
|
|
|
// number of messages received
|
|
#define NEU_METRIC_RECV_MSGS_TOTAL "recv_msgs_total"
|
|
#define NEU_METRIC_RECV_MSGS_TOTAL_TYPE NEU_METRIC_TYPE_COUNTER
|
|
#define NEU_METRIC_RECV_MSGS_TOTAL_HELP "Total number of messages received"
|
|
|
|
typedef enum {
|
|
NEU_METRICS_CATEGORY_GLOBAL,
|
|
NEU_METRICS_CATEGORY_DRIVER,
|
|
NEU_METRICS_CATEGORY_APP,
|
|
NEU_METRICS_CATEGORY_ALL,
|
|
} neu_metrics_category_e;
|
|
|
|
// metric entry
|
|
typedef struct {
|
|
const char * name; // NOTE: should points to string literal
|
|
const char * help; // NOTE: should points to string literal
|
|
neu_metric_type_e type; //
|
|
uint64_t value; //
|
|
UT_hash_handle hh; // ordered by name
|
|
} neu_metric_entry_t;
|
|
|
|
// group metrics
|
|
typedef struct {
|
|
char * name; // group name
|
|
neu_metric_entry_t *entries; // group metric entries
|
|
UT_hash_handle hh; // ordered by name
|
|
} neu_group_metrics_t;
|
|
|
|
// node metrics
|
|
typedef struct {
|
|
neu_node_type_e type; // node type
|
|
char * name; // node name
|
|
neu_metric_entry_t * entries; // node metric entries
|
|
neu_group_metrics_t *group_metrics; // group metrics
|
|
neu_adapter_t * adapter; //
|
|
UT_hash_handle hh; // ordered by name
|
|
} neu_node_metrics_t;
|
|
|
|
typedef struct {
|
|
char distro[32];
|
|
char kernel[32];
|
|
unsigned cpu_percent;
|
|
unsigned cpu_cores;
|
|
size_t mem_total_bytes;
|
|
size_t mem_used_bytes;
|
|
size_t mem_cache_bytes;
|
|
size_t disk_size_gibibytes;
|
|
size_t disk_used_gibibytes;
|
|
size_t disk_avail_gibibytes;
|
|
bool core_dumped;
|
|
uint64_t uptime_seconds;
|
|
size_t north_nodes;
|
|
size_t north_running_nodes;
|
|
size_t north_disconnected_nodes;
|
|
size_t south_nodes;
|
|
size_t south_running_nodes;
|
|
size_t south_disconnected_nodes;
|
|
neu_node_metrics_t *node_metrics;
|
|
neu_metric_entry_t *registered_metrics;
|
|
} neu_metrics_t;
|
|
|
|
static inline const char *neu_metric_type_str(neu_metric_type_e type)
|
|
{
|
|
if (NEU_METRIC_TYPE_COUNTER == type) {
|
|
return "counter";
|
|
} else {
|
|
return "gauge";
|
|
}
|
|
}
|
|
|
|
int neu_metric_entries_add(neu_metric_entry_t **entries, const char *name,
|
|
const char *help, neu_metric_type_e type,
|
|
uint64_t init);
|
|
|
|
static inline void neu_metric_entry_free(neu_metric_entry_t *entry)
|
|
{
|
|
free(entry);
|
|
}
|
|
|
|
static inline void neu_group_metrics_free(neu_group_metrics_t *group_metrics)
|
|
{
|
|
if (NULL == group_metrics) {
|
|
return;
|
|
}
|
|
|
|
neu_metric_entry_t *e = NULL, *tmp = NULL;
|
|
HASH_ITER(hh, group_metrics->entries, e, tmp)
|
|
{
|
|
HASH_DEL(group_metrics->entries, e);
|
|
neu_metric_entry_free(e);
|
|
}
|
|
free(group_metrics->name);
|
|
free(group_metrics);
|
|
}
|
|
|
|
static inline void neu_node_metrics_free(neu_node_metrics_t *node_metrics)
|
|
{
|
|
if (NULL == node_metrics) {
|
|
return;
|
|
}
|
|
|
|
neu_metric_entry_t *e = NULL, *etmp = NULL;
|
|
HASH_ITER(hh, node_metrics->entries, e, etmp)
|
|
{
|
|
HASH_DEL(node_metrics->entries, e);
|
|
neu_metric_entry_free(e);
|
|
}
|
|
|
|
neu_group_metrics_t *g = NULL, *gtmp = NULL;
|
|
HASH_ITER(hh, node_metrics->group_metrics, g, gtmp)
|
|
{
|
|
HASH_DEL(node_metrics->group_metrics, g);
|
|
neu_group_metrics_free(g);
|
|
}
|
|
|
|
free(node_metrics);
|
|
}
|
|
|
|
void neu_metrics_init();
|
|
void neu_metrics_add_node(const neu_adapter_t *adapter);
|
|
void neu_metrics_del_node(const neu_adapter_t *adapter);
|
|
int neu_metrics_register_entry(const char *name, const char *help,
|
|
neu_metric_type_e type);
|
|
void neu_metrics_unregister_entry(const char *name);
|
|
|
|
typedef void (*neu_metrics_cb_t)(const neu_metrics_t *metrics, void *data);
|
|
void neu_metrics_visist(neu_metrics_cb_t cb, void *data);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif
|