Asterisk - The Open Source Telephony Project GIT-master-b023714
Loading...
Searching...
No Matches
Functions | Variables
res_endpoint_stats.c File Reference
#include "asterisk.h"
#include "asterisk/module.h"
#include "asterisk/stasis_endpoints.h"
#include "asterisk/stasis_message_router.h"
#include "asterisk/statsd.h"
Include dependency graph for res_endpoint_stats.c:

Go to the source code of this file.

Functions

static void __reg_module (void)
 
static void __unreg_module (void)
 
struct ast_module * AST_MODULE_SELF_SYM (void)
 
static void cache_update_cb (void *data, struct stasis_subscription *sub, struct stasis_message *message)
 
static int dump_cache_load (void *obj, void *arg, int flags)
 
static int dump_cache_unload (void *obj, void *arg, int flags)
 
static void handle_endpoint_update (struct ast_endpoint_snapshot *old_snapshot, struct ast_endpoint_snapshot *new_snapshot)
 
static int load_module (void)
 
static int unload_module (void)
 
static void update_endpoint_state (struct ast_endpoint_snapshot *snapshot, const char *delta)
 

Variables

static struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_DEFAULT , .description = "Endpoint statistics" , .key = ASTERISK_GPL_KEY , .buildopt_sum = AST_BUILDOPT_SUM, .support_level = AST_MODULE_SUPPORT_EXTENDED, .load = load_module, .unload = unload_module, .requires = "res_statsd" }
 
static const struct ast_module_info * ast_module_info = &__mod_info
 
static struct stasis_message_router * router
 Statsd Endpoint stats.
 

Function Documentation

◆ __reg_module()

static void __reg_module ( void  )
static

Definition at line 155 of file res_endpoint_stats.c.

◆ __unreg_module()

static void __unreg_module ( void  )
static

Definition at line 155 of file res_endpoint_stats.c.

◆ AST_MODULE_SELF_SYM()

struct ast_module * AST_MODULE_SELF_SYM ( void  )

Definition at line 155 of file res_endpoint_stats.c.

◆ cache_update_cb()

static void cache_update_cb ( void *  data,
struct stasis_subscription *  sub,
struct stasis_message *  message 
)
static

Definition at line 78 of file res_endpoint_stats.c.

80{
81 struct stasis_cache_update *update = stasis_message_data(message);
82 struct ast_endpoint_snapshot *old_snapshot;
83 struct ast_endpoint_snapshot *new_snapshot;
84
85 if (ast_endpoint_snapshot_type() != update->type) {
86 return;
87 }
88
89 old_snapshot = stasis_message_data(update->old_snapshot);
90 new_snapshot = stasis_message_data(update->new_snapshot);
91
92 handle_endpoint_update(old_snapshot, new_snapshot);
93}
update
static void update(int code_size, int y, int wi, int fi, int dq, int sr, int dqsez, struct g726_state *state_ptr)
Definition codec_g726.c:367
ast_endpoint_snapshot_type
struct stasis_message_type * ast_endpoint_snapshot_type(void)
Message type for ast_endpoint_snapshot.
handle_endpoint_update
static void handle_endpoint_update(struct ast_endpoint_snapshot *old_snapshot, struct ast_endpoint_snapshot *new_snapshot)
Definition res_endpoint_stats.c:60
stasis_message_data
void * stasis_message_data(const struct stasis_message *msg)
Get the data contained in a message.
Definition stasis_message.c:195
ast_endpoint_snapshot
A snapshot of an endpoint's state.
Definition stasis_endpoints.h:48
stasis_cache_update
Cache update message.
Definition stasis.h:965

References ast_endpoint_snapshot_type(), handle_endpoint_update(), stasis_message_data(), and update().

Referenced by load_module().

◆ dump_cache_load()

static int dump_cache_load ( void *  obj,
void *  arg,
int  flags 
)
static

Definition at line 95 of file res_endpoint_stats.c.

96{
97 struct stasis_message *msg = obj;
98 struct ast_endpoint_snapshot *snapshot = stasis_message_data(msg);
99
100 handle_endpoint_update(NULL, snapshot);
101
102 return 0;
103}
NULL
#define NULL
Definition resample.c:96
stasis_message
Definition stasis_message.c:121

References handle_endpoint_update(), NULL, and stasis_message_data().

Referenced by load_module().

◆ dump_cache_unload()

static int dump_cache_unload ( void *  obj,
void *  arg,
int  flags 
)
static

Definition at line 105 of file res_endpoint_stats.c.

106{
107 struct stasis_message *msg = obj;
108 struct ast_endpoint_snapshot *snapshot = stasis_message_data(msg);
109
110 handle_endpoint_update(snapshot, NULL);
111
112 return 0;
113}

References handle_endpoint_update(), NULL, and stasis_message_data().

Referenced by unload_module().

◆ handle_endpoint_update()

static void handle_endpoint_update ( struct ast_endpoint_snapshot *  old_snapshot,
struct ast_endpoint_snapshot *  new_snapshot 
)
static

Definition at line 60 of file res_endpoint_stats.c.

61{
62 if (!old_snapshot && new_snapshot) {
63 ast_statsd_log_string("endpoints.count", AST_STATSD_GAUGE, "+1", 1.0);
64 update_endpoint_state(new_snapshot, "+1");
65 } else if (old_snapshot && !new_snapshot) {
66 ast_statsd_log_string("endpoints.count", AST_STATSD_GAUGE, "-1", 1.0);
67 update_endpoint_state(old_snapshot, "-1");
68 } else {
69 if (old_snapshot->state != new_snapshot->state) {
70 update_endpoint_state(old_snapshot, "-1");
71 update_endpoint_state(new_snapshot, "+1");
72 }
73 ast_statsd_log_full_va("endpoints.%s.%s.channels", AST_STATSD_GAUGE, new_snapshot->num_channels, 1.0,
74 new_snapshot->tech, new_snapshot->resource);
75 }
76}
update_endpoint_state
static void update_endpoint_state(struct ast_endpoint_snapshot *snapshot, const char *delta)
Definition res_endpoint_stats.c:45
AST_STATSD_GAUGE
#define AST_STATSD_GAUGE
Support for publishing to a statsd server.
Definition statsd.h:32
ast_statsd_log_string
void AST_OPTIONAL_API_NAME() ast_statsd_log_string(const char *metric_name, const char *metric_type, const char *value, double sample_rate)
Send a stat to the configured statsd server.
Definition res_statsd.c:136
ast_statsd_log_full_va
void AST_OPTIONAL_API_NAME() ast_statsd_log_full_va(const char *metric_name, const char *metric_type, intmax_t value, double sample_rate,...)
Send a stat to the configured statsd server.
Definition res_statsd.c:228
ast_endpoint_snapshot::num_channels
int num_channels
Definition stasis_endpoints.h:63
ast_endpoint_snapshot::tech
const ast_string_field tech
Definition stasis_endpoints.h:53
ast_endpoint_snapshot::state
enum ast_endpoint_state state
Definition stasis_endpoints.h:56
ast_endpoint_snapshot::resource
const ast_string_field resource
Definition stasis_endpoints.h:53

References AST_STATSD_GAUGE, ast_statsd_log_full_va(), ast_statsd_log_string(), ast_endpoint_snapshot::num_channels, ast_endpoint_snapshot::resource, ast_endpoint_snapshot::state, ast_endpoint_snapshot::tech, and update_endpoint_state().

Referenced by cache_update_cb(), dump_cache_load(), and dump_cache_unload().

◆ load_module()

static int load_module ( void  )
static

Definition at line 115 of file res_endpoint_stats.c.

116{
117 struct ao2_container *endpoints;
118
119 router = stasis_message_router_create(ast_endpoint_topic_all_cached());
120 if (!router) {
121 return AST_MODULE_LOAD_DECLINE;
122 }
123 stasis_message_router_add(router, stasis_cache_update_type(), cache_update_cb, NULL);
124
125 endpoints = stasis_cache_dump(ast_endpoint_cache(), ast_endpoint_snapshot_type());
126 if (endpoints) {
127 ao2_callback(endpoints, OBJ_MULTIPLE | OBJ_NODATA | OBJ_NOLOCK, dump_cache_load, NULL);
128 ao2_ref(endpoints, -1);
129 }
130
131 return AST_MODULE_LOAD_SUCCESS;
132}
ao2_callback
#define ao2_callback(c, flags, cb_fn, arg)
ao2_callback() is a generic function that applies cb_fn() to all objects in a container,...
Definition astobj2.h:1693
ao2_ref
#define ao2_ref(o, delta)
Reference/unreference an object and return the old refcount.
Definition astobj2.h:459
OBJ_NOLOCK
@ OBJ_NOLOCK
Assume that the ao2_container is already locked.
Definition astobj2.h:1063
OBJ_NODATA
@ OBJ_NODATA
Definition astobj2.h:1044
OBJ_MULTIPLE
@ OBJ_MULTIPLE
Definition astobj2.h:1049
ast_endpoint_topic_all_cached
struct stasis_topic * ast_endpoint_topic_all_cached(void)
Cached topic for all endpoint related messages.
Definition stasis_endpoints.c:127
stasis_cache_update_type
struct stasis_message_type * stasis_cache_update_type(void)
Message type for cache update messages.
ast_endpoint_cache
struct stasis_cache * ast_endpoint_cache(void)
Backend cache for ast_endpoint_topic_all_cached().
Definition stasis_endpoints.c:117
endpoints
static struct ao2_container * endpoints
Definition main/endpoints.c:49
AST_MODULE_LOAD_SUCCESS
@ AST_MODULE_LOAD_SUCCESS
Definition module.h:70
AST_MODULE_LOAD_DECLINE
@ AST_MODULE_LOAD_DECLINE
Module has failed to load, may be in an inconsistent state.
Definition module.h:78
dump_cache_load
static int dump_cache_load(void *obj, void *arg, int flags)
Definition res_endpoint_stats.c:95
router
static struct stasis_message_router * router
Statsd Endpoint stats.
Definition res_endpoint_stats.c:43
cache_update_cb
static void cache_update_cb(void *data, struct stasis_subscription *sub, struct stasis_message *message)
Definition res_endpoint_stats.c:78
stasis_cache_dump
struct ao2_container * stasis_cache_dump(struct stasis_cache *cache, struct stasis_message_type *type)
Dump cached items to a subscription for the ast_eid_default entity.
Definition stasis_cache.c:736
stasis_message_router_create
#define stasis_message_router_create(topic)
Create a new message router object.
Definition stasis_message_router.h:58
stasis_message_router_add
int stasis_message_router_add(struct stasis_message_router *router, struct stasis_message_type *message_type, stasis_subscription_cb callback, void *data)
Add a route to a message router.
Definition stasis_message_router.c:308
ao2_container
Generic container type.
Definition astobj2_container_private.h:270

References ao2_callback, ao2_ref, ast_endpoint_cache(), ast_endpoint_snapshot_type(), ast_endpoint_topic_all_cached(), AST_MODULE_LOAD_DECLINE, AST_MODULE_LOAD_SUCCESS, cache_update_cb(), dump_cache_load(), endpoints, NULL, OBJ_MULTIPLE, OBJ_NODATA, OBJ_NOLOCK, router, stasis_cache_dump(), stasis_cache_update_type(), stasis_message_router_add(), and stasis_message_router_create.

◆ unload_module()

static int unload_module ( void  )
static

Definition at line 134 of file res_endpoint_stats.c.

135{
136 struct ao2_container *endpoints;
137
138 endpoints = stasis_cache_dump(ast_endpoint_cache(), ast_endpoint_snapshot_type());
139 if (endpoints) {
140 ao2_callback(endpoints, OBJ_MULTIPLE | OBJ_NODATA | OBJ_NOLOCK, dump_cache_unload, NULL);
141 ao2_ref(endpoints, -1);
142 }
143
144 stasis_message_router_unsubscribe_and_join(router);
145 router = NULL;
146
147 return 0;
148}
dump_cache_unload
static int dump_cache_unload(void *obj, void *arg, int flags)
Definition res_endpoint_stats.c:105
stasis_message_router_unsubscribe_and_join
void stasis_message_router_unsubscribe_and_join(struct stasis_message_router *router)
Unsubscribe the router from the upstream topic, blocking until the final message has been processed.
Definition stasis_message_router.c:267

References ao2_callback, ao2_ref, ast_endpoint_cache(), ast_endpoint_snapshot_type(), dump_cache_unload(), endpoints, NULL, OBJ_MULTIPLE, OBJ_NODATA, OBJ_NOLOCK, router, stasis_cache_dump(), and stasis_message_router_unsubscribe_and_join().

◆ update_endpoint_state()

static void update_endpoint_state ( struct ast_endpoint_snapshot *  snapshot,
const char *  delta 
)
static

Definition at line 45 of file res_endpoint_stats.c.

46{
47 switch (snapshot->state) {
48 case AST_ENDPOINT_UNKNOWN:
49 ast_statsd_log_string("endpoints.state.unknown", AST_STATSD_GAUGE, delta, 1.0);
50 break;
51 case AST_ENDPOINT_OFFLINE:
52 ast_statsd_log_string("endpoints.state.offline", AST_STATSD_GAUGE, delta, 1.0);
53 break;
54 case AST_ENDPOINT_ONLINE:
55 ast_statsd_log_string("endpoints.state.online", AST_STATSD_GAUGE, delta, 1.0);
56 break;
57 }
58}
AST_ENDPOINT_OFFLINE
@ AST_ENDPOINT_OFFLINE
Definition endpoints.h:55
AST_ENDPOINT_ONLINE
@ AST_ENDPOINT_ONLINE
Definition endpoints.h:57
AST_ENDPOINT_UNKNOWN
@ AST_ENDPOINT_UNKNOWN
Definition endpoints.h:53

References AST_ENDPOINT_OFFLINE, AST_ENDPOINT_ONLINE, AST_ENDPOINT_UNKNOWN, AST_STATSD_GAUGE, ast_statsd_log_string(), and ast_endpoint_snapshot::state.

Referenced by handle_endpoint_update().

Variable Documentation

◆ __mod_info

struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_DEFAULT , .description = "Endpoint statistics" , .key = ASTERISK_GPL_KEY , .buildopt_sum = AST_BUILDOPT_SUM, .support_level = AST_MODULE_SUPPORT_EXTENDED, .load = load_module, .unload = unload_module, .requires = "res_statsd" }
static

Definition at line 155 of file res_endpoint_stats.c.

◆ ast_module_info

const struct ast_module_info* ast_module_info = &__mod_info
static

Definition at line 155 of file res_endpoint_stats.c.

◆ router

struct stasis_message_router* router
static

Statsd Endpoint stats.

This module subscribes to Stasis endpoints and send statistics based on their state.

Author
Matthew Jordan mjord.nosp@m.an@d.nosp@m.igium.nosp@m..com
Since
13.7.0

Stasis message router

Definition at line 43 of file res_endpoint_stats.c.

Referenced by load_module(), and unload_module().

Generated on Wed Oct 15 2025 20:04:34 for Asterisk - The Open Source Telephony Project by doxygen 1.9.8