libosmocore  1.5.1
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  * You should have received a copy of the GNU General Public License along
17  * with this program; if not, write to the Free Software Foundation, Inc.,
18  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
19  *
20  */
21 #pragma once
22 
27 /* a bit of a crude way to disable building/using this on (bare iron)
28  * embedded systems. We cannot use the autoconf-defined HAVE_... macros
29  * here, as that only works at library compile time, not at application
30  * compile time */
31 #if defined(unix) || defined(__APPLE__)
32 
33 #include <sys/socket.h>
34 #include <arpa/inet.h>
35 
36 #include <osmocom/core/linuxlist.h>
37 
38 #include <stdint.h>
39 
40 struct msgb;
42 struct osmo_stat_item_desc;
43 struct rate_ctr_group;
44 struct rate_ctr_desc;
45 
52 };
53 
58 };
59 
65  char *name;
66 
67  unsigned int have_net_config : 1;
68 
69  /* config */
70  int enabled;
71  char *name_prefix;
72  char *dest_addr_str;
73  char *bind_addr_str;
74  int dest_port;
75  int mtu;
76  unsigned int flush_period;
80 
81  /* state */
82 
83  int running;
84  struct sockaddr dest_addr;
86  struct sockaddr bind_addr;
88  int fd;
89  struct msgb *buffer;
92  unsigned int flush_period_counter;
94  struct llist_head list;
95  int (*open)(struct osmo_stats_reporter *srep);
96  int (*close)(struct osmo_stats_reporter *srep);
97  int (*send_counter)(struct osmo_stats_reporter *srep,
98  const struct rate_ctr_group *ctrg,
99  const struct rate_ctr_desc *desc,
100  int64_t value, int64_t delta);
101  int (*send_item)(struct osmo_stats_reporter *srep,
102  const struct osmo_stat_item_group *statg,
103  const struct osmo_stat_item_desc *desc,
104  int64_t value);
105 };
106 
108  int interval;
109 };
110 
111 extern struct osmo_stats_config *osmo_stats_config;
112 
113 void osmo_stats_init(void *ctx);
114 int osmo_stats_report();
115 
117 
119  const char *name);
121 
123  const char *name);
124 
125 int osmo_stats_reporter_set_remote_addr(struct osmo_stats_reporter *srep, const char *addr);
127 int osmo_stats_reporter_set_local_addr(struct osmo_stats_reporter *srep, const char *addr);
130  enum osmo_stats_class class_id);
131 int osmo_stats_reporter_set_name_prefix(struct osmo_stats_reporter *srep, const char *prefix);
134 int osmo_stats_reporter_set_flush_period(struct osmo_stats_reporter *srep, unsigned int period);
135 
136 /* reporter creation */
139 
140 /* helper functions for reporter implementations */
141 int osmo_stats_reporter_send(struct osmo_stats_reporter *srep, const char *data,
142  int data_len);
146 
147 #endif /* unix || __APPLE__ */
148 
osmo_stats_reporter::have_net_config
unsigned int have_net_config
Definition: stats.h:67
osmo_stats_reporter_disable
int osmo_stats_reporter_disable(struct osmo_stats_reporter *srep)
Disable the given stats_reporter.
Definition: stats.c:440
OSMO_STATS_CLASS_GLOBAL
@ OSMO_STATS_CLASS_GLOBAL
global counter/stat_item
Definition: stats.h:49
osmo_stats_reporter::dest_port
int dest_port
destination (UDP) port
Definition: stats.h:74
osmo_stats_reporter_free
void osmo_stats_reporter_free(struct osmo_stats_reporter *srep)
Destroy a given stats_reporter.
Definition: stats.c:232
rate_ctr_desc
rate counter description
Definition: rate_ctr.h:37
osmo_stats_reporter_alloc
struct osmo_stats_reporter * osmo_stats_reporter_alloc(enum osmo_stats_reporter_type type, const char *name)
Definition: stats.c:214
osmo_stats_reporter::running
int running
is this reporter running
Definition: stats.h:83
osmo_stats_reporter::flush_period
unsigned int flush_period
period between regular flushes
Definition: stats.h:76
osmo_stats_reporter::bind_addr_len
int bind_addr_len
length of bind_addr in bytes
Definition: stats.h:87
osmo_stats_reporter::dest_addr
struct sockaddr dest_addr
destination address of socket
Definition: stats.h:84
OSMO_STATS_REPORTER_LOG
@ OSMO_STATS_REPORTER_LOG
libosmocore logging
Definition: stats.h:56
osmo_stats_class
osmo_stats_class
Statistics Class definitions.
Definition: stats.h:47
osmo_stat_item_group
One instance of a counter group class.
Definition: stat_item.h:58
osmo_stats_reporter_send_buffer
int osmo_stats_reporter_send_buffer(struct osmo_stats_reporter *srep)
osmo_stats_reporter_set_local_addr
int osmo_stats_reporter_set_local_addr(struct osmo_stats_reporter *srep, const char *addr)
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:101
osmo_stats_reporter::fd
int fd
file descriptor of socket
Definition: stats.h:88
name
const char * name
osmo_stats_reporter::type
enum osmo_stats_reporter_type type
Type of the reporter (log, statsd)
Definition: stats.h:63
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:57
osmo_stats_reporter::flush_period_counter
unsigned int flush_period_counter
count sends between forced flushes
Definition: stats.h:92
OSMO_STATS_REPORTER_STATSD
@ OSMO_STATS_REPORTER_STATSD
statsd backend
Definition: stats.h:57
osmo_stats_reporter
One statistics reporter instance.
Definition: stats.h:61
osmo_stats_reporter::close
int(* close)(struct osmo_stats_reporter *srep)
Definition: stats.h:96
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:254
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:91
data
uint8_t data[0]
osmo_stats_config
Definition: stats.h:107
msgb
Osmocom message buffer.
Definition: msgb.h:35
osmo_stats_reporter::dest_addr_len
int dest_addr_len
length of dest_addr in bytes
Definition: stats.h:85
osmo_stats_reporter::dest_addr_str
char * dest_addr_str
destination IP address
Definition: stats.h:72
rate_ctr_group
One instance of a counter group class.
Definition: rate_ctr.h:57
osmo_stats_reporter_udp_open
int osmo_stats_reporter_udp_open(struct osmo_stats_reporter *srep)
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:368
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:97
osmo_stats_reporter::open
int(* open)(struct osmo_stats_reporter *srep)
Definition: stats.h:95
osmo_stats_reporter_udp_close
int osmo_stats_reporter_udp_close(struct osmo_stats_reporter *srep)
osmo_stats_config
struct osmo_stats_config * osmo_stats_config
Definition: stats.c:115
osmo_stats_reporter::bind_addr_str
char * bind_addr_str
local bind IP address
Definition: stats.h:73
llist_head
(double) linked list header structure
Definition: linuxlist.h:46
osmo_stats_reporter_set_remote_addr
int osmo_stats_reporter_set_remote_addr(struct osmo_stats_reporter *srep, const char *addr)
osmo_stats_reporter::bind_addr
struct sockaddr bind_addr
local bind address of socket
Definition: stats.h:86
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:402
osmo_stats_reporter::max_class
enum osmo_stats_class max_class
Maximum class/index to report.
Definition: stats.h:79
osmo_stats_reporter::list
struct llist_head list
Definition: stats.h:94
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:417
osmo_stats_reporter_enable
int osmo_stats_reporter_enable(struct osmo_stats_reporter *srep)
Enable the given stats_reporter.
Definition: stats.c:430
osmo_stats_reporter::mtu
int mtu
Maximum Transmission Unit.
Definition: stats.h:75
osmo_stats_reporter::buffer
struct msgb * buffer
message buffer for log output
Definition: stats.h:89
osmo_stats_reporter::agg_enabled
int agg_enabled
is aggregation enabled?
Definition: stats.h:90
desc
osmo_stats_reporter_type
osmo_stats_reporter_type
Statistics Reporter Type.
Definition: stats.h:55
osmo_stats_report
int osmo_stats_report()
Definition: stats.c:792
type
enum osmo_sub_auth_type type
OSMO_STATS_CLASS_UNKNOWN
@ OSMO_STATS_CLASS_UNKNOWN
unknown class
Definition: stats.h:48
osmo_stats_reporter::name
char * name
Human-readable name of this reporter.
Definition: stats.h:65
osmo_stats_reporter_set_mtu
int osmo_stats_reporter_set_mtu(struct osmo_stats_reporter *srep, int mtu)
OSMO_STATS_CLASS_PEER
@ OSMO_STATS_CLASS_PEER
peer in a communications link
Definition: stats.h:50
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:568
osmo_stats_reporter::enabled
int enabled
is this reporter enabled
Definition: stats.h:70
osmo_stats_reporter_set_remote_port
int osmo_stats_reporter_set_remote_port(struct osmo_stats_reporter *srep, int port)
OSMO_STATS_CLASS_SUBSCRIBER
@ OSMO_STATS_CLASS_SUBSCRIBER
subscriber
Definition: stats.h:51
osmo_stats_config::interval
int interval
Definition: stats.h:108
osmo_stat_item_desc
Statistics item description.
Definition: stat_item.h:35
linuxlist.h
osmo_stats_reporter::name_prefix
char * name_prefix
prefix for counter names
Definition: stats.h:71
osmo_stats_init
void osmo_stats_init(void *ctx)
Initilize the stats reporting module; call this once in your program.
Definition: stats.c:241
osmo_stats_set_interval
int osmo_stats_set_interval(int interval)
Set the reporting interval (common for all reporters)
Definition: stats.c:382
osmo_stats_reporter_send
int osmo_stats_reporter_send(struct osmo_stats_reporter *srep, const char *data, int data_len)