libosmocore  1.9.0.20-4ca0f.202310312026
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;
38 struct osmo_stat_item_desc;
39 struct rate_ctr_group;
40 struct rate_ctr_desc;
41 
48 };
49 
54 };
55 
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;
76 
77  /* state */
78 
79  int running;
80  struct sockaddr dest_addr;
82  struct sockaddr bind_addr;
84  int fd;
85  struct msgb *buffer;
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 
104  int interval;
105 };
106 
108 extern struct osmo_stats_config *osmo_stats_config;
109 
110 void osmo_stats_init(void *ctx);
111 int osmo_stats_report(void);
112 
114 
116  const char *name);
118 
120  const char *name);
121 
122 int osmo_stats_reporter_set_remote_addr(struct osmo_stats_reporter *srep, const char *addr);
124 int osmo_stats_reporter_set_local_addr(struct osmo_stats_reporter *srep, const char *addr);
127  enum osmo_stats_class class_id);
128 int osmo_stats_reporter_set_name_prefix(struct osmo_stats_reporter *srep, const char *prefix);
131 int osmo_stats_reporter_set_flush_period(struct osmo_stats_reporter *srep, unsigned int period);
132 
133 /* reporter creation */
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);
143 
144 #endif /* unix || __APPLE__ */
enum osmo_sub_auth_type type
const char * name
uint8_t data[0]
struct osmo_stats_reporter * osmo_stats_reporter_alloc(enum osmo_stats_reporter_type type, const char *name)
Definition: stats.c:212
int osmo_stats_reporter_udp_open(struct osmo_stats_reporter *srep)
void osmo_stats_reporter_free(struct osmo_stats_reporter *srep)
Destroy a given stats_reporter.
Definition: stats.c:232
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
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
int osmo_stats_reporter_set_remote_port(struct osmo_stats_reporter *srep, int port)
int osmo_stats_reporter_disable(struct osmo_stats_reporter *srep)
Disable the given stats_reporter.
Definition: stats.c:442
int osmo_stats_reporter_set_max_class(struct osmo_stats_reporter *srep, enum osmo_stats_class class_id)
Definition: stats.c:370
int osmo_stats_reporter_set_mtu(struct osmo_stats_reporter *srep, int mtu)
struct osmo_stats_config * osmo_stats_config
Definition: stats.c:113
int osmo_stats_set_interval(int interval)
Set the reporting interval (common for all reporters)
Definition: stats.c:384
int osmo_stats_reporter_udp_close(struct osmo_stats_reporter *srep)
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
int osmo_stats_report(void)
Definition: stats.c:790
struct osmo_stats_reporter * osmo_stats_reporter_create_statsd(const char *name)
Create a stats_reporter reporting to statsd.
Definition: stats_statsd.c:53
int osmo_stats_reporter_set_remote_addr(struct osmo_stats_reporter *srep, const char *addr)
osmo_stats_reporter_type
Statistics Reporter Type.
Definition: stats.h:51
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
void osmo_stats_init(void *ctx)
Initialize the stats reporting module; call this once in your program.
Definition: stats.c:241
int osmo_stats_reporter_set_local_addr(struct osmo_stats_reporter *srep, const char *addr)
int osmo_stats_reporter_enable(struct osmo_stats_reporter *srep)
Enable the given stats_reporter.
Definition: stats.c:432
int osmo_stats_reporter_send_buffer(struct osmo_stats_reporter *srep)
int osmo_stats_reporter_send(struct osmo_stats_reporter *srep, const char *data, int data_len)
struct llist_head osmo_stats_reporter_list
osmo_stats_class
Statistics Class definitions.
Definition: stats.h:43
@ OSMO_STATS_REPORTER_LOG
libosmocore logging
Definition: stats.h:52
@ OSMO_STATS_REPORTER_STATSD
statsd backend
Definition: stats.h:53
@ OSMO_STATS_CLASS_UNKNOWN
unknown class
Definition: stats.h:44
@ OSMO_STATS_CLASS_PEER
peer in a communications link
Definition: stats.h:46
@ OSMO_STATS_CLASS_GLOBAL
global counter/stat_item
Definition: stats.h:45
@ OSMO_STATS_CLASS_SUBSCRIBER
subscriber
Definition: stats.h:47
Simple doubly linked list implementation.
(double) linked list header structure
Definition: linuxlist.h:46
Osmocom message buffer.
Definition: msgb.h:31
Statistics item description.
Definition: stat_item.h:22
One instance of a counter group class.
Definition: stat_item.h:45
Definition: stats.h:103
int interval
Definition: stats.h:104
One statistics reporter instance.
Definition: stats.h:57
unsigned int flush_period_counter
count sends between forced flushes
Definition: stats.h:88
int dest_port
destination (UDP) port
Definition: stats.h:70
int dest_addr_len
length of dest_addr in bytes
Definition: stats.h:81
struct sockaddr bind_addr
local bind address of socket
Definition: stats.h:82
int force_single_flush
set to 1 to force a flush (send even unchanged stats values)
Definition: stats.h:87
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
unsigned int have_net_config
Definition: stats.h:63
int fd
file descriptor of socket
Definition: stats.h:84
int enabled
is this reporter enabled
Definition: stats.h:66
int(* close)(struct osmo_stats_reporter *srep)
Definition: stats.h:92
int mtu
Maximum Transmission Unit.
Definition: stats.h:71
int bind_addr_len
length of bind_addr in bytes
Definition: stats.h:83
enum osmo_stats_reporter_type type
Type of the reporter (log, statsd)
Definition: stats.h:59
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
enum osmo_stats_class max_class
Maximum class/index to report.
Definition: stats.h:75
int agg_enabled
is aggregation enabled?
Definition: stats.h:86
struct msgb * buffer
message buffer for log output
Definition: stats.h:85
int(* open)(struct osmo_stats_reporter *srep)
Definition: stats.h:91
int running
is this reporter running
Definition: stats.h:79
char * name_prefix
prefix for counter names
Definition: stats.h:67
char * dest_addr_str
destination IP address
Definition: stats.h:68
struct llist_head list
Definition: stats.h:90
char * name
Human-readable name of this reporter.
Definition: stats.h:61
unsigned int flush_period
period between regular flushes
Definition: stats.h:72
struct sockaddr dest_addr
destination address of socket
Definition: stats.h:80
char * bind_addr_str
local bind IP address
Definition: stats.h:69
rate counter description
Definition: rate_ctr.h:37
One instance of a counter group class.
Definition: rate_ctr.h:57