libosmocore 1.13.1.1-afb4 Osmocom core library

stats.h
Go to the documentation of this file.
1/*
2 * (C) 2015 by sysmocom - s.f.m.c. GmbH
3 *
4 * All Rights Reserved
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 */
17#pragma once
18
23/* a bit of a crude way to disable building/using this on (bare iron)
24 * embedded systems. We cannot use the autoconf-defined HAVE_... macros
25 * here, as that only works at library compile time, not at application
26 * compile time */
27#if defined(unix) || defined(__APPLE__)
28
29#include <sys/socket.h>
30#include <arpa/inet.h>
31
32#include <osmocom/core/linuxlist.h>
33
34#include <stdint.h>
35
36 struct msgb;
37 struct osmo_stat_item_group;
38 struct osmo_stat_item_desc;
39 struct rate_ctr_group;
40 struct rate_ctr_desc;
41
43 enum osmo_stats_class {
44 OSMO_STATS_CLASS_UNKNOWN,
45 OSMO_STATS_CLASS_GLOBAL,
46 OSMO_STATS_CLASS_PEER,
47 OSMO_STATS_CLASS_SUBSCRIBER,
48};
49
51 enum osmo_stats_reporter_type {
52 OSMO_STATS_REPORTER_LOG,
53 OSMO_STATS_REPORTER_STATSD,
54};
55
57 struct osmo_stats_reporter {
59 enum osmo_stats_reporter_type type;
61 char *name;
62
63 unsigned int have_net_config : 1;
64
65 /* config */
66 int enabled;
67 char *name_prefix;
68 char *dest_addr_str;
69 char *bind_addr_str;
70 int dest_port;
71 int mtu;
72 unsigned int flush_period;
75 enum osmo_stats_class max_class;
76
77 /* state */
78
79 int running;
80 struct sockaddr dest_addr;
81 int dest_addr_len;
82 struct sockaddr bind_addr;
83 int bind_addr_len;
84 int fd;
85 struct msgb *buffer;
86 int agg_enabled;
87 int force_single_flush;
88 unsigned int flush_period_counter;
90 struct llist_head list;
91 int (*open)(struct osmo_stats_reporter *srep);
92 int (*close)(struct osmo_stats_reporter *srep);
93 int (*send_counter)(struct osmo_stats_reporter *srep,
94 const struct rate_ctr_group *ctrg,
95 const struct rate_ctr_desc *desc,
96 int64_t value, int64_t delta);
97 int (*send_item)(struct osmo_stats_reporter *srep,
98 const struct osmo_stat_item_group *statg,
99 const struct osmo_stat_item_desc *desc,
100 int64_t value);
101};
102
103 struct osmo_stats_config {
104 int interval;
105};
106
107 extern struct llist_head osmo_stats_reporter_list;
108 extern struct osmo_stats_config *osmo_stats_config;
109
110 void osmo_stats_init(void *ctx);
111 int osmo_stats_report(void);
112
113 int osmo_stats_set_interval(int interval);
114
115 struct osmo_stats_reporter *osmo_stats_reporter_alloc(enum osmo_stats_reporter_type type,
116 const char *name);
117 void osmo_stats_reporter_free(struct osmo_stats_reporter *srep);
118
119 struct osmo_stats_reporter *osmo_stats_reporter_find(enum osmo_stats_reporter_type type,
120 const char *name);
121
122 int osmo_stats_reporter_set_remote_addr(struct osmo_stats_reporter *srep, const char *addr);
123 int osmo_stats_reporter_set_remote_port(struct osmo_stats_reporter *srep, int port);
124 int osmo_stats_reporter_set_local_addr(struct osmo_stats_reporter *srep, const char *addr);
125 int osmo_stats_reporter_set_mtu(struct osmo_stats_reporter *srep, int mtu);
126 int osmo_stats_reporter_set_max_class(struct osmo_stats_reporter *srep,
127 enum osmo_stats_class class_id);
128 int osmo_stats_reporter_set_name_prefix(struct osmo_stats_reporter *srep, const char *prefix);
129 int osmo_stats_reporter_enable(struct osmo_stats_reporter *srep);
130 int osmo_stats_reporter_disable(struct osmo_stats_reporter *srep);
131 int osmo_stats_reporter_set_flush_period(struct osmo_stats_reporter *srep, unsigned int period);
132
133/* reporter creation */
134 struct osmo_stats_reporter *osmo_stats_reporter_create_log(const char *name);
135 struct osmo_stats_reporter *osmo_stats_reporter_create_statsd(const char *name);
136
137/* helper functions for reporter implementations */
138 int osmo_stats_reporter_send(struct osmo_stats_reporter *srep, const char *data,
139 int data_len);
140 int osmo_stats_reporter_send_buffer(struct osmo_stats_reporter *srep);
141 int osmo_stats_reporter_udp_open(struct osmo_stats_reporter *srep);
142 int osmo_stats_reporter_udp_close(struct osmo_stats_reporter *srep);
143
144#endif /* unix || __APPLE__ */
type
enum osmo_sub_auth_type type
name
const char * name
data
uint8_t data[0]
osmo_stats_reporter_alloc
struct osmo_stats_reporter * osmo_stats_reporter_alloc(enum osmo_stats_reporter_type type, const char *name)
Definition: stats.c:212
osmo_stats_reporter_udp_open
int osmo_stats_reporter_udp_open(struct osmo_stats_reporter *srep)
osmo_stats_reporter_free
void osmo_stats_reporter_free(struct osmo_stats_reporter *srep)
Destroy a given stats_reporter.
Definition: stats.c:232
osmo_stats_reporter_set_name_prefix
int osmo_stats_reporter_set_name_prefix(struct osmo_stats_reporter *srep, const char *prefix)
Set the name prefix of a given stats_reporter.
Definition: stats.c:419
osmo_stats_reporter_set_flush_period
int osmo_stats_reporter_set_flush_period(struct osmo_stats_reporter *srep, unsigned int period)
Set the regular flush period for a given stats_reporter.
Definition: stats.c:404
osmo_stats_reporter_set_remote_port
int osmo_stats_reporter_set_remote_port(struct osmo_stats_reporter *srep, int port)
osmo_stats_reporter_disable
int osmo_stats_reporter_disable(struct osmo_stats_reporter *srep)
Disable the given stats_reporter.
Definition: stats.c:442
osmo_stats_reporter_set_max_class
int osmo_stats_reporter_set_max_class(struct osmo_stats_reporter *srep, enum osmo_stats_class class_id)
Definition: stats.c:370
osmo_stats_reporter_set_mtu
int osmo_stats_reporter_set_mtu(struct osmo_stats_reporter *srep, int mtu)
osmo_stats_config
struct osmo_stats_config * osmo_stats_config
Definition: stats.c:113
osmo_stats_set_interval
int osmo_stats_set_interval(int interval)
Set the reporting interval (common for all reporters)
Definition: stats.c:384
osmo_stats_reporter_udp_close
int osmo_stats_reporter_udp_close(struct osmo_stats_reporter *srep)
osmo_stats_reporter_find
struct osmo_stats_reporter * osmo_stats_reporter_find(enum osmo_stats_reporter_type type, const char *name)
Find a stats_reporter of given type and name.
Definition: stats.c:256
osmo_stats_report
int osmo_stats_report(void)
Definition: stats.c:790
osmo_stats_reporter_create_statsd
struct osmo_stats_reporter * osmo_stats_reporter_create_statsd(const char *name)
Create a stats_reporter reporting to statsd.
Definition: stats_statsd.c:53
osmo_stats_reporter_set_remote_addr
int osmo_stats_reporter_set_remote_addr(struct osmo_stats_reporter *srep, const char *addr)
osmo_stats_reporter_type
osmo_stats_reporter_type
Statistics Reporter Type.
Definition: stats.h:51
osmo_stats_reporter_create_log
struct osmo_stats_reporter * osmo_stats_reporter_create_log(const char *name)
Create a stats_reporter that logs via libosmocore logging.
Definition: stats.c:572
osmo_stats_init
void osmo_stats_init(void *ctx)
Initialize the stats reporting module; call this once in your program.
Definition: stats.c:241
osmo_stats_reporter_set_local_addr
int osmo_stats_reporter_set_local_addr(struct osmo_stats_reporter *srep, const char *addr)
osmo_stats_reporter_enable
int osmo_stats_reporter_enable(struct osmo_stats_reporter *srep)
Enable the given stats_reporter.
Definition: stats.c:432
osmo_stats_reporter_send_buffer
int osmo_stats_reporter_send_buffer(struct osmo_stats_reporter *srep)
osmo_stats_reporter_send
int osmo_stats_reporter_send(struct osmo_stats_reporter *srep, const char *data, int data_len)
osmo_stats_reporter_list
struct llist_head osmo_stats_reporter_list
osmo_stats_class
osmo_stats_class
Statistics Class definitions.
Definition: stats.h:43
OSMO_STATS_REPORTER_LOG
@ OSMO_STATS_REPORTER_LOG
libosmocore logging
Definition: stats.h:52
OSMO_STATS_REPORTER_STATSD
@ OSMO_STATS_REPORTER_STATSD
statsd backend
Definition: stats.h:53
OSMO_STATS_CLASS_UNKNOWN
@ OSMO_STATS_CLASS_UNKNOWN
unknown class
Definition: stats.h:44
OSMO_STATS_CLASS_PEER
@ OSMO_STATS_CLASS_PEER
peer in a communications link
Definition: stats.h:46
OSMO_STATS_CLASS_GLOBAL
@ OSMO_STATS_CLASS_GLOBAL
global counter/stat_item
Definition: stats.h:45
OSMO_STATS_CLASS_SUBSCRIBER
@ OSMO_STATS_CLASS_SUBSCRIBER
subscriber
Definition: stats.h:47
linuxlist.h
Simple doubly linked list implementation.
desc
llist_head
(double) linked list header structure
Definition: linuxlist.h:46
msgb
Osmocom message buffer.
Definition: msgb.h:31
osmo_stat_item_desc
Statistics item description.
Definition: stat_item.h:22
osmo_stat_item_group
One instance of a counter group class.
Definition: stat_item.h:45
osmo_stats_config
Definition: stats.h:103
osmo_stats_config::interval
int interval
Definition: stats.h:104
osmo_stats_reporter
One statistics reporter instance.
Definition: stats.h:57
osmo_stats_reporter::flush_period_counter
unsigned int flush_period_counter
count sends between forced flushes
Definition: stats.h:88
osmo_stats_reporter::dest_port
int dest_port
destination (UDP) port
Definition: stats.h:70
osmo_stats_reporter::dest_addr_len
int dest_addr_len
length of dest_addr in bytes
Definition: stats.h:81
osmo_stats_reporter::bind_addr
struct sockaddr bind_addr
local bind address of socket
Definition: stats.h:82
osmo_stats_reporter::force_single_flush
int force_single_flush
set to 1 to force a flush (send even unchanged stats values)
Definition: stats.h:87
osmo_stats_reporter::send_counter
int(* send_counter)(struct osmo_stats_reporter *srep, const struct rate_ctr_group *ctrg, const struct rate_ctr_desc *desc, int64_t value, int64_t delta)
Definition: stats.h:93
osmo_stats_reporter::have_net_config
unsigned int have_net_config
Definition: stats.h:63
osmo_stats_reporter::fd
int fd
file descriptor of socket
Definition: stats.h:84
osmo_stats_reporter::enabled
int enabled
is this reporter enabled
Definition: stats.h:66
osmo_stats_reporter::close
int(* close)(struct osmo_stats_reporter *srep)
Definition: stats.h:92
osmo_stats_reporter::mtu
int mtu
Maximum Transmission Unit.
Definition: stats.h:71
osmo_stats_reporter::bind_addr_len
int bind_addr_len
length of bind_addr in bytes
Definition: stats.h:83
osmo_stats_reporter::type
enum osmo_stats_reporter_type type
Type of the reporter (log, statsd)
Definition: stats.h:59
osmo_stats_reporter::send_item
int(* send_item)(struct osmo_stats_reporter *srep, const struct osmo_stat_item_group *statg, const struct osmo_stat_item_desc *desc, int64_t value)
Definition: stats.h:97
osmo_stats_reporter::max_class
enum osmo_stats_class max_class
Maximum class/index to report.
Definition: stats.h:75
osmo_stats_reporter::agg_enabled
int agg_enabled
is aggregation enabled?
Definition: stats.h:86
osmo_stats_reporter::buffer
struct msgb * buffer
message buffer for log output
Definition: stats.h:85
osmo_stats_reporter::open
int(* open)(struct osmo_stats_reporter *srep)
Definition: stats.h:91
osmo_stats_reporter::running
int running
is this reporter running
Definition: stats.h:79
osmo_stats_reporter::name_prefix
char * name_prefix
prefix for counter names
Definition: stats.h:67
osmo_stats_reporter::dest_addr_str
char * dest_addr_str
destination IP address
Definition: stats.h:68
osmo_stats_reporter::list
struct llist_head list
Definition: stats.h:90
osmo_stats_reporter::name
char * name
Human-readable name of this reporter.
Definition: stats.h:61
osmo_stats_reporter::flush_period
unsigned int flush_period
period between regular flushes
Definition: stats.h:72
osmo_stats_reporter::dest_addr
struct sockaddr dest_addr
destination address of socket
Definition: stats.h:80
osmo_stats_reporter::bind_addr_str
char * bind_addr_str
local bind IP address
Definition: stats.h:69
rate_ctr_desc
rate counter description
Definition: rate_ctr.h:37
rate_ctr_group
One instance of a counter group class.
Definition: rate_ctr.h:57