mirror of https://gerrit.osmocom.org/libosmocore
stats: Add the reporting framework
This commit provides the stats reporting framework that can manage several types of measurement reporters. Initially support for rate_ctr and the statsd protocol is included. Sponsored-by: On-Waves ehf
This commit is contained in:
Jacob Erlbeck
parent
45513e6040
commit
95bf828003
|
|
@ -22,6 +22,7 @@ nobase_include_HEADERS = \
|
|||
osmocom/core/linuxrbtree.h \
|
||||
osmocom/core/logging.h \
|
||||
osmocom/core/loggingrb.h \
|
||||
osmocom/core/stats.h \
|
||||
osmocom/core/macaddr.h \
|
||||
osmocom/core/msgb.h \
|
||||
osmocom/core/panic.h \
|
||||
|
|
|
|||
|
|
@ -0,0 +1,70 @@
|
|||
/* (C) 2015 by Sysmocom s.f.m.c. GmbH
|
||||
*
|
||||
* All Rights Reserved
|
||||
*
|
||||
* This program is free software; you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation; either version 2 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 General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU 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.
|
||||
*
|
||||
*/
|
||||
#pragma once
|
||||
|
||||
#include <sys/socket.h>
|
||||
#include <osmocom/core/linuxlist.h>
|
||||
|
||||
enum stats_reporter_type {
|
||||
STATS_REPORTER_STATSD,
|
||||
};
|
||||
|
||||
struct stats_reporter {
|
||||
enum stats_reporter_type type;
|
||||
char *name;
|
||||
|
||||
/* config */
|
||||
int enabled;
|
||||
int interval;
|
||||
char *name_prefix;
|
||||
char *dest_addr_str;
|
||||
char *bind_addr_str;
|
||||
int dest_port;
|
||||
int mtu;
|
||||
|
||||
/* state */
|
||||
int running;
|
||||
struct sockaddr dest_addr;
|
||||
int dest_addr_len;
|
||||
struct sockaddr bind_addr;
|
||||
int bind_addr_len;
|
||||
int fd;
|
||||
|
||||
struct llist_head list;
|
||||
};
|
||||
|
||||
void stats_init(void *ctx);
|
||||
int stats_report();
|
||||
|
||||
struct stats_reporter *stats_reporter_alloc(enum stats_reporter_type type,
|
||||
const char *name);
|
||||
void stats_reporter_free(struct stats_reporter *srep);
|
||||
struct stats_reporter *stats_reporter_create_statsd(const char *name);
|
||||
|
||||
struct stats_reporter *stats_reporter_find(enum stats_reporter_type type,
|
||||
const char *name);
|
||||
|
||||
int stats_reporter_set_remote_addr(struct stats_reporter *srep, const char *addr);
|
||||
int stats_reporter_set_remote_port(struct stats_reporter *srep, int port);
|
||||
int stats_reporter_set_local_addr(struct stats_reporter *srep, const char *addr);
|
||||
int stats_reporter_set_interval(struct stats_reporter *srep, int interval);
|
||||
int stats_reporter_set_name_prefix(struct stats_reporter *srep, const char *prefix);
|
||||
int stats_reporter_enable(struct stats_reporter *srep);
|
||||
int stats_reporter_disable(struct stats_reporter *srep);
|
||||
|
|
@ -15,7 +15,7 @@ libosmocore_la_SOURCES = timer.c select.c signal.c msgb.c bits.c \
|
|||
gsmtap_util.c crc16.c panic.c backtrace.c \
|
||||
conv.c application.c rbtree.c strrb.c \
|
||||
loggingrb.c crc8gen.c crc16gen.c crc32gen.c crc64gen.c \
|
||||
macaddr.c stat_item.c
|
||||
macaddr.c stat_item.c stats.c
|
||||
|
||||
BUILT_SOURCES = crc8gen.c crc16gen.c crc32gen.c crc64gen.c
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,387 @@
|
|||
/*
|
||||
* (C) 2015 by Sysmocom s.f.m.c. GmbH
|
||||
*
|
||||
* Author: Jacob Erlbeck <jerlbeck@sysmocom.de>
|
||||
*
|
||||
* All Rights Reserved
|
||||
*
|
||||
* This program is free software; you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation; either version 2 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 General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU 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.
|
||||
*
|
||||
*/
|
||||
|
||||
#include <osmocom/core/stats.h>
|
||||
|
||||
#include <unistd.h>
|
||||
#include <string.h>
|
||||
#include <stdint.h>
|
||||
#include <errno.h>
|
||||
#include <stdio.h>
|
||||
#include <sys/socket.h>
|
||||
#include <netinet/ip.h>
|
||||
#include <arpa/inet.h>
|
||||
|
||||
#include <osmocom/core/utils.h>
|
||||
#include <osmocom/core/logging.h>
|
||||
#include <osmocom/core/rate_ctr.h>
|
||||
#include <osmocom/core/stat_item.h>
|
||||
|
||||
/* TODO: register properly */
|
||||
#define DSTATS DLGLOBAL
|
||||
|
||||
|
||||
static LLIST_HEAD(stats_reporter_list);
|
||||
static void *stats_ctx = NULL;
|
||||
|
||||
static int stats_reporter_statsd_open(struct stats_reporter *srep);
|
||||
static int stats_reporter_statsd_close(struct stats_reporter *srep);
|
||||
static int stats_reporter_send(struct stats_reporter *srep, const char *data,
|
||||
int data_len);
|
||||
|
||||
static int update_srep_config(struct stats_reporter *srep)
|
||||
{
|
||||
int rc = 0;
|
||||
|
||||
if (srep->type != STATS_REPORTER_STATSD) {
|
||||
srep->enabled = 0;
|
||||
return -ENOTSUP;
|
||||
}
|
||||
|
||||
if (srep->running) {
|
||||
rc = stats_reporter_statsd_close(srep);
|
||||
srep->running = 0;
|
||||
}
|
||||
|
||||
if (!srep->enabled)
|
||||
return rc;
|
||||
|
||||
rc = stats_reporter_statsd_open(srep);
|
||||
if (rc < 0)
|
||||
srep->enabled = 0;
|
||||
else
|
||||
srep->running = 1;
|
||||
|
||||
return rc;
|
||||
}
|
||||
|
||||
struct stats_reporter *stats_reporter_alloc(enum stats_reporter_type type,
|
||||
const char *name)
|
||||
{
|
||||
struct stats_reporter *srep;
|
||||
srep = talloc_zero(stats_ctx, struct stats_reporter);
|
||||
OSMO_ASSERT(srep);
|
||||
srep->type = type;
|
||||
if (name)
|
||||
srep->name = talloc_strdup(srep, name);
|
||||
srep->fd = -1;
|
||||
|
||||
llist_add(&srep->list, &stats_reporter_list);
|
||||
|
||||
return srep;
|
||||
}
|
||||
|
||||
void stats_reporter_free(struct stats_reporter *srep)
|
||||
{
|
||||
stats_reporter_disable(srep);
|
||||
llist_del(&srep->list);
|
||||
talloc_free(srep);
|
||||
}
|
||||
|
||||
void stats_init(void *ctx)
|
||||
{
|
||||
stats_ctx = ctx;
|
||||
}
|
||||
|
||||
struct stats_reporter *stats_reporter_find(enum stats_reporter_type type,
|
||||
const char *name)
|
||||
{
|
||||
struct stats_reporter *srep;
|
||||
llist_for_each_entry(srep, &stats_reporter_list, list) {
|
||||
if (srep->type != type)
|
||||
continue;
|
||||
if (srep->name != name) {
|
||||
if (name == NULL || srep->name == NULL ||
|
||||
strcmp(name, srep->name) != 0)
|
||||
continue;
|
||||
}
|
||||
return srep;
|
||||
}
|
||||
return NULL;
|
||||
}
|
||||
|
||||
int stats_reporter_set_remote_addr(struct stats_reporter *srep, const char *addr)
|
||||
{
|
||||
int rc;
|
||||
struct sockaddr_in *sock_addr = (struct sockaddr_in *)&srep->dest_addr;
|
||||
struct in_addr inaddr;
|
||||
|
||||
OSMO_ASSERT(addr != NULL);
|
||||
|
||||
rc = inet_pton(AF_INET, addr, &inaddr);
|
||||
if (rc <= 0)
|
||||
return -EINVAL;
|
||||
|
||||
sock_addr->sin_addr = inaddr;
|
||||
sock_addr->sin_family = AF_INET;
|
||||
srep->dest_addr_len = sizeof(*sock_addr);
|
||||
|
||||
talloc_free(srep->dest_addr_str);
|
||||
srep->dest_addr_str = talloc_strdup(srep, addr);
|
||||
|
||||
return update_srep_config(srep);
|
||||
}
|
||||
|
||||
int stats_reporter_set_remote_port(struct stats_reporter *srep, int port)
|
||||
{
|
||||
struct sockaddr_in *sock_addr = (struct sockaddr_in *)&srep->dest_addr;
|
||||
|
||||
srep->dest_port = port;
|
||||
sock_addr->sin_port = htons(port);
|
||||
|
||||
return update_srep_config(srep);
|
||||
}
|
||||
|
||||
int stats_reporter_set_local_addr(struct stats_reporter *srep, const char *addr)
|
||||
{
|
||||
int rc;
|
||||
struct sockaddr_in *sock_addr = (struct sockaddr_in *)&srep->bind_addr;
|
||||
struct in_addr inaddr;
|
||||
|
||||
if (addr) {
|
||||
rc = inet_pton(AF_INET, addr, &inaddr);
|
||||
if (rc <= 0)
|
||||
return -EINVAL;
|
||||
} else {
|
||||
addr = INADDR_ANY;
|
||||
}
|
||||
|
||||
sock_addr->sin_addr = inaddr;
|
||||
sock_addr->sin_family = AF_INET;
|
||||
srep->bind_addr_len = addr ? sizeof(*sock_addr) : 0;
|
||||
|
||||
talloc_free(srep->bind_addr_str);
|
||||
srep->bind_addr_str = addr ? talloc_strdup(srep, addr) : NULL;
|
||||
|
||||
return update_srep_config(srep);
|
||||
}
|
||||
|
||||
int stats_reporter_set_interval(struct stats_reporter *srep, int interval)
|
||||
{
|
||||
srep->interval = interval;
|
||||
|
||||
return update_srep_config(srep);
|
||||
}
|
||||
|
||||
int stats_reporter_set_name_prefix(struct stats_reporter *srep, const char *prefix)
|
||||
{
|
||||
talloc_free(srep->name_prefix);
|
||||
srep->name_prefix = prefix ? talloc_strdup(srep, prefix) : NULL;
|
||||
|
||||
return update_srep_config(srep);
|
||||
}
|
||||
|
||||
int stats_reporter_enable(struct stats_reporter *srep)
|
||||
{
|
||||
srep->enabled = 1;
|
||||
|
||||
return update_srep_config(srep);
|
||||
}
|
||||
|
||||
int stats_reporter_disable(struct stats_reporter *srep)
|
||||
{
|
||||
srep->enabled = 0;
|
||||
|
||||
return update_srep_config(srep);
|
||||
}
|
||||
|
||||
static int stats_reporter_send(struct stats_reporter *srep, const char *data,
|
||||
int data_len)
|
||||
{
|
||||
int rc;
|
||||
|
||||
rc = sendto(srep->fd, data, data_len, MSG_NOSIGNAL | MSG_DONTWAIT,
|
||||
&srep->dest_addr, srep->dest_addr_len);
|
||||
|
||||
if (rc == -1)
|
||||
rc = -errno;
|
||||
|
||||
return rc;
|
||||
}
|
||||
|
||||
/*** statsd reporter ***/
|
||||
|
||||
struct stats_reporter *stats_reporter_create_statsd(const char *name)
|
||||
{
|
||||
struct stats_reporter *srep;
|
||||
srep = stats_reporter_alloc(STATS_REPORTER_STATSD, name);
|
||||
|
||||
return srep;
|
||||
}
|
||||
|
||||
static int stats_reporter_statsd_open(struct stats_reporter *srep)
|
||||
{
|
||||
int sock;
|
||||
int rc;
|
||||
|
||||
if (srep->fd != -1)
|
||||
stats_reporter_statsd_close(srep);
|
||||
|
||||
sock = socket(AF_INET, SOCK_DGRAM, 0);
|
||||
if (sock == -1)
|
||||
return -errno;
|
||||
|
||||
if (srep->bind_addr_len > 0) {
|
||||
rc = bind(sock, &srep->bind_addr, srep->bind_addr_len);
|
||||
if (rc == -1)
|
||||
goto failed;
|
||||
}
|
||||
|
||||
srep->fd = sock;
|
||||
|
||||
return 0;
|
||||
|
||||
failed:
|
||||
rc = -errno;
|
||||
close(sock);
|
||||
|
||||
return rc;
|
||||
}
|
||||
|
||||
static int stats_reporter_statsd_close(struct stats_reporter *srep)
|
||||
{
|
||||
int rc;
|
||||
if (srep->fd == -1)
|
||||
return -EBADF;
|
||||
|
||||
rc = close(srep->fd);
|
||||
srep->fd = -1;
|
||||
return rc == -1 ? -errno : 0;
|
||||
}
|
||||
|
||||
static int stats_reporter_statsd_send(struct stats_reporter *srep,
|
||||
const char *name1, int index1, const char *name2, int value,
|
||||
const char *unit)
|
||||
{
|
||||
char buf[256];
|
||||
int nchars, rc;
|
||||
char *fmt = NULL;
|
||||
|
||||
if (name1) {
|
||||
if (index1 > 0)
|
||||
fmt = "%1$s.%2$s.%3$d.%4$s:%5$d|%6$s";
|
||||
else
|
||||
fmt = "%1$s.%2$s.%4$s:%5$d|%6$s";
|
||||
} else {
|
||||
fmt = "%1$s.%4$s:%5$d|%6$s";
|
||||
}
|
||||
if (!srep->name_prefix)
|
||||
fmt += 5; /* skip prefix part */
|
||||
|
||||
nchars = snprintf(buf, sizeof(buf), fmt,
|
||||
srep->name_prefix, name1, index1, name2,
|
||||
value, unit);
|
||||
|
||||
if (nchars >= sizeof(buf))
|
||||
/* Truncated */
|
||||
return -EMSGSIZE;
|
||||
|
||||
rc = stats_reporter_send(srep, buf, nchars);
|
||||
|
||||
return rc;
|
||||
}
|
||||
|
||||
static int stats_reporter_statsd_send_counter(struct stats_reporter *srep,
|
||||
const struct rate_ctr_group *ctrg,
|
||||
const struct rate_ctr_desc *desc,
|
||||
int64_t value, int64_t delta)
|
||||
{
|
||||
if (ctrg)
|
||||
return stats_reporter_statsd_send(srep,
|
||||
ctrg->desc->group_name_prefix,
|
||||
ctrg->idx,
|
||||
desc->name, delta, "c");
|
||||
else
|
||||
return stats_reporter_statsd_send(srep,
|
||||
NULL, -1,
|
||||
desc->name, delta, "c");
|
||||
}
|
||||
|
||||
static int stats_reporter_statsd_send_item(struct stats_reporter *srep,
|
||||
const struct stat_item_group *statg,
|
||||
const struct stat_item_desc *desc, int value)
|
||||
{
|
||||
return stats_reporter_statsd_send(srep,
|
||||
statg->desc->group_name_prefix, statg->idx,
|
||||
desc->name, value, desc->unit);
|
||||
}
|
||||
|
||||
/*** generic rate counter support ***/
|
||||
|
||||
static int stats_reporter_send_counter(struct stats_reporter *srep,
|
||||
const struct rate_ctr_group *ctrg,
|
||||
const struct rate_ctr_desc *desc,
|
||||
int64_t value, int64_t delta)
|
||||
{
|
||||
int rc;
|
||||
|
||||
switch (srep->type) {
|
||||
case STATS_REPORTER_STATSD:
|
||||
rc = stats_reporter_statsd_send_counter(srep, ctrg, desc,
|
||||
value, delta);
|
||||
break;
|
||||
}
|
||||
|
||||
return rc;
|
||||
}
|
||||
|
||||
static int rate_ctr_handler(
|
||||
struct rate_ctr_group *ctrg, struct rate_ctr *ctr,
|
||||
const struct rate_ctr_desc *desc, void *sctx_)
|
||||
{
|
||||
struct stats_reporter *srep;
|
||||
int rc;
|
||||
int64_t delta = rate_ctr_difference(ctr);
|
||||
|
||||
if (delta == 0)
|
||||
return 0;
|
||||
|
||||
llist_for_each_entry(srep, &stats_reporter_list, list) {
|
||||
if (!srep->running)
|
||||
continue;
|
||||
|
||||
rc = stats_reporter_send_counter(srep, ctrg, desc,
|
||||
ctr->current, delta);
|
||||
|
||||
/* TODO: handle rc (log?, inc counter(!)?) or remove it */
|
||||
}
|
||||
|
||||
return 0;
|
||||
}
|
||||
|
||||
static int rate_ctr_group_handler(struct rate_ctr_group *ctrg, void *sctx_)
|
||||
{
|
||||
rate_ctr_for_each_counter(ctrg, rate_ctr_handler, sctx_);
|
||||
|
||||
return 0;
|
||||
}
|
||||
|
||||
|
||||
/*** main reporting function ***/
|
||||
|
||||
int stats_report()
|
||||
{
|
||||
rate_ctr_for_each_group(rate_ctr_group_handler, NULL);
|
||||
|
||||
return 0;
|
||||
}
|
||||
Loading…
Reference in New Issue