Asterisk - The Open Source Telephony Project GIT-master-f36a736
Functions | Variables
res_chan_stats.c File Reference
#include "asterisk.h"
#include "asterisk/module.h"
#include "asterisk/stasis_channels.h"
#include "asterisk/stasis_message_router.h"
#include "asterisk/statsd.h"
#include "asterisk/time.h"
Include dependency graph for res_chan_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 default_route (void *data, struct stasis_subscription *sub, struct stasis_message *message)
 Router callback for any message that doesn't otherwise have a route. More...
 
static int load_module (void)
 
static void statsmaker (void *data, struct stasis_subscription *sub, struct stasis_message *message)
 Subscription callback for all channel messages. More...
 
static int unload_module (void)
 
static void updates (void *data, struct stasis_subscription *sub, struct stasis_message *message)
 Router callback for ast_channel_snapshot_update messages. More...
 

Variables

static struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_DEFAULT , .description = "Example of how to use Stasis" , .key = "This paragraph is copyright (c) 2006 by Digium, Inc. \In order for your module to load, it must return this \key via a function called \"key\". Any code which \includes this paragraph must be licensed under the GNU \General Public License version 2 or later (at your \option). In addition to Digium's general reservations \of rights, Digium expressly reserves the right to \allow other parties to license this paragraph under \different terms. Any use of Digium, Inc. trademarks or \logos (including \"Asterisk\" or \"Digium\") without \express written permission of Digium, Inc. is prohibited.\n" , .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
 
static struct stasis_subscription * sub
 Statsd channel stats. Exmaple of how to subscribe to Stasis events. More...
 

Function Documentation

◆ __reg_module()

static void __reg_module ( void  )
static

Definition at line 168 of file res_chan_stats.c.

◆ __unreg_module()

static void __unreg_module ( void  )
static

Definition at line 168 of file res_chan_stats.c.

◆ AST_MODULE_SELF_SYM()

struct ast_module * AST_MODULE_SELF_SYM ( void  )

Definition at line 168 of file res_chan_stats.c.

◆ default_route()

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

Router callback for any message that doesn't otherwise have a route.

Parameters
dataData pointer given when added to router.
subThis subscription.
messageThe message itself.

Definition at line 121 of file res_chan_stats.c.

123{
124 if (stasis_subscription_final_message(sub, message)) {
125 /* Much like with the regular subscription, you may need to
126 * perform some cleanup when done with a message router. You
127 * can look for the final message in the default route.
128 */
129 return;
130 }
131}
sub
static struct stasis_subscription * sub
Statsd channel stats. Exmaple of how to subscribe to Stasis events.
Definition: res_chan_stats.c:44
stasis_subscription_final_message
int stasis_subscription_final_message(struct stasis_subscription *sub, struct stasis_message *msg)
Determine whether a message is the final message to be received on a subscription.
Definition: stasis.c:1175

References stasis_subscription_final_message(), and sub.

Referenced by load_module().

◆ load_module()

static int load_module ( void  )
static

Definition at line 142 of file res_chan_stats.c.

143{
144 /* You can create a message router to route messages by type */
145 router = stasis_message_router_create(
146 ast_channel_topic_all());
147 if (!router) {
148 return AST_MODULE_LOAD_DECLINE;
149 }
150 stasis_message_router_add(router, ast_channel_snapshot_type(),
151 updates, NULL);
152 stasis_message_router_set_default(router, default_route, NULL);
153
154 /* Or a subscription to receive all of the messages from a topic */
155 sub = stasis_subscribe(ast_channel_topic_all(), statsmaker, NULL);
156 if (!sub) {
157 unload_module();
158 return AST_MODULE_LOAD_DECLINE;
159 }
160 return AST_MODULE_LOAD_SUCCESS;
161}
ast_channel_topic_all
struct stasis_topic * ast_channel_topic_all(void)
A topic which publishes the events for all channels.
Definition: stasis_channels.c:129
ast_channel_snapshot_type
struct stasis_message_type * ast_channel_snapshot_type(void)
Message type for ast_channel_snapshot_update.
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
default_route
static void default_route(void *data, struct stasis_subscription *sub, struct stasis_message *message)
Router callback for any message that doesn't otherwise have a route.
Definition: res_chan_stats.c:121
router
static struct stasis_message_router * router
Definition: res_chan_stats.c:46
statsmaker
static void statsmaker(void *data, struct stasis_subscription *sub, struct stasis_message *message)
Subscription callback for all channel messages.
Definition: res_chan_stats.c:54
updates
static void updates(void *data, struct stasis_subscription *sub, struct stasis_message *message)
Router callback for ast_channel_snapshot_update messages.
Definition: res_chan_stats.c:83
unload_module
static int unload_module(void)
Definition: res_chan_stats.c:133
NULL
#define NULL
Definition: resample.c:96
stasis_subscribe
#define stasis_subscribe(topic, callback, data)
Definition: stasis.h:649
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
stasis_message_router_set_default
int stasis_message_router_set_default(struct stasis_message_router *router, stasis_subscription_cb callback, void *data)
Sets the default route of a router.
Definition: stasis_message_router.c:385

References ast_channel_snapshot_type(), ast_channel_topic_all(), AST_MODULE_LOAD_DECLINE, AST_MODULE_LOAD_SUCCESS, default_route(), NULL, router, stasis_message_router_add(), stasis_message_router_create, stasis_message_router_set_default(), stasis_subscribe, statsmaker(), sub, unload_module(), and updates().

◆ statsmaker()

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

Subscription callback for all channel messages.

Parameters
dataData pointer given when creating the subscription.
subThis subscription.
messageThe message itself.

Definition at line 54 of file res_chan_stats.c.

56{
57 RAII_VAR(struct ast_str *, metric, NULL, ast_free);
58
59 if (stasis_subscription_final_message(sub, message)) {
60 /* Normally, data points to an object that must be cleaned up.
61 * The final message is an unsubscribe notification that's
62 * guaranteed to be the last message this subscription receives.
63 * This would be a safe place to kick off any needed cleanup.
64 */
65 return;
66 }
67
68 /* For no good reason, count message types */
69 metric = ast_str_create(80);
70 if (metric) {
71 ast_str_set(&metric, 0, "stasis.message.%s",
72 stasis_message_type_name(stasis_message_type(message)));
73 ast_statsd_log(ast_str_buffer(metric), AST_STATSD_METER, 1);
74 }
75}
ast_free
#define ast_free(a)
Definition: astmm.h:180
stasis_message_type
struct stasis_message_type * stasis_message_type(const struct stasis_message *msg)
Get the message type for a stasis_message.
Definition: stasis_message.c:187
stasis_message_type_name
const char * stasis_message_type_name(const struct stasis_message_type *type)
Gets the name of a given message type.
Definition: stasis_message.c:99
AST_STATSD_METER
#define AST_STATSD_METER
Definition: statsd.h:48
ast_statsd_log
void ast_statsd_log(const char *metric_name, const char *metric_type, intmax_t value)
Send a stat to the configured statsd server.
Definition: res_statsd.c:232
ast_str_buffer
char * ast_str_buffer(const struct ast_str *buf)
Returns the string buffer within the ast_str buf.
Definition: strings.h:761
ast_str_create
#define ast_str_create(init_len)
Create a malloc'ed dynamic length string.
Definition: strings.h:659
ast_str_set
int ast_str_set(struct ast_str **buf, ssize_t max_len, const char *fmt,...)
Set a dynamic string using variable arguments.
Definition: strings.h:1113
ast_str
Support for dynamic strings.
Definition: strings.h:623
RAII_VAR
#define RAII_VAR(vartype, varname, initval, dtor)
Declare a variable that will call a destructor function when it goes out of scope.
Definition: utils.h:941

References ast_free, ast_statsd_log(), AST_STATSD_METER, ast_str_buffer(), ast_str_create, ast_str_set(), NULL, RAII_VAR, stasis_message_type(), stasis_message_type_name(), stasis_subscription_final_message(), and sub.

Referenced by load_module().

◆ unload_module()

static int unload_module ( void  )
static

Definition at line 133 of file res_chan_stats.c.

134{
135 stasis_unsubscribe_and_join(sub);
136 sub = NULL;
137 stasis_message_router_unsubscribe_and_join(router);
138 router = NULL;
139 return 0;
140}
stasis_unsubscribe_and_join
struct stasis_subscription * stasis_unsubscribe_and_join(struct stasis_subscription *subscription)
Cancel a subscription, blocking until the last message is processed.
Definition: stasis.c:1135
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 NULL, router, stasis_message_router_unsubscribe_and_join(), stasis_unsubscribe_and_join(), and sub.

Referenced by load_module().

◆ updates()

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

Router callback for ast_channel_snapshot_update messages.

Parameters
dataData pointer given when added to router.
subThis subscription.
messageThe message itself.

Definition at line 83 of file res_chan_stats.c.

85{
86 /* Since this came from a message router, we know the type of the
87 * message. We can cast the data without checking its type.
88 */
89 struct ast_channel_snapshot_update *update = stasis_message_data(message);
90
91 /* There are three types of channel snapshot updates.
92 * !old && new -> Initial channel creation
93 * old && new -> Updated channel snapshot
94 * old && dead -> Final channel snapshot
95 */
96
97 if (!update->old_snapshot && update->new_snapshot) {
98 /* Initial channel snapshot; count a channel creation */
99 ast_statsd_log_string("channels.count", AST_STATSD_GAUGE, "+1", 1.0);
100 } else if (update->old_snapshot && ast_test_flag(&update->new_snapshot->flags, AST_FLAG_DEAD)) {
101 /* Channel is gone. Compute the age of the channel and post
102 * that, as well as decrementing the channel count.
103 */
104 int64_t age;
105
106 age = ast_tvdiff_ms(*stasis_message_timestamp(message),
107 update->new_snapshot->base->creationtime);
108 ast_statsd_log("channels.calltime", AST_STATSD_TIMER, age);
109
110 /* And decrement the channel count */
111 ast_statsd_log_string("channels.count", AST_STATSD_GAUGE, "-1", 1.0);
112 }
113}
AST_FLAG_DEAD
@ AST_FLAG_DEAD
Definition: channel.h:1065
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
stasis_message_data
void * stasis_message_data(const struct stasis_message *msg)
Get the data contained in a message.
Definition: stasis_message.c:195
stasis_message_timestamp
const struct timeval * stasis_message_timestamp(const struct stasis_message *msg)
Get the time when a message was created.
Definition: stasis_message.c:203
AST_STATSD_TIMER
#define AST_STATSD_TIMER
Definition: statsd.h:41
AST_STATSD_GAUGE
#define AST_STATSD_GAUGE
Support for publishing to a statsd server.
Definition: statsd.h:32
ast_statsd_log_string
void 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:117
ast_channel_snapshot_update
Structure representing a change of snapshot of channel state.
Definition: stasis_channels.h:175
ast_tvdiff_ms
int64_t ast_tvdiff_ms(struct timeval end, struct timeval start)
Computes the difference (in milliseconds) between two struct timeval instances.
Definition: time.h:107
ast_test_flag
#define ast_test_flag(p, flag)
Definition: utils.h:63

References AST_FLAG_DEAD, AST_STATSD_GAUGE, ast_statsd_log(), ast_statsd_log_string(), AST_STATSD_TIMER, ast_test_flag, ast_tvdiff_ms(), stasis_message_data(), stasis_message_timestamp(), and update().

Referenced by load_module().

Variable Documentation

◆ __mod_info

struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_DEFAULT , .description = "Example of how to use Stasis" , .key = "This paragraph is copyright (c) 2006 by Digium, Inc. \In order for your module to load, it must return this \key via a function called \"key\". Any code which \includes this paragraph must be licensed under the GNU \General Public License version 2 or later (at your \option). In addition to Digium's general reservations \of rights, Digium expressly reserves the right to \allow other parties to license this paragraph under \different terms. Any use of Digium, Inc. trademarks or \logos (including \"Asterisk\" or \"Digium\") without \express written permission of Digium, Inc. is prohibited.\n" , .buildopt_sum = AST_BUILDOPT_SUM, .support_level = AST_MODULE_SUPPORT_EXTENDED, .load = load_module, .unload = unload_module, .requires = "res_statsd" }
static

Definition at line 168 of file res_chan_stats.c.

◆ ast_module_info

const struct ast_module_info* ast_module_info = &__mod_info
static

Definition at line 168 of file res_chan_stats.c.

◆ router

struct stasis_message_router* router
static

Stasis message router

Definition at line 46 of file res_chan_stats.c.

Referenced by cdr_prop_write(), cdr_read(), cdr_write(), find_route(), forkcdr_exec(), load_module(), pjsip_outbound_registration_metrics_init(), pjsip_outbound_registration_metrics_unload_cb(), publish_app_cdr_message(), router_dispatch(), router_dtor(), stasis_message_router_accept_formatters(), stasis_message_router_add(), stasis_message_router_add_cache_update(), stasis_message_router_create_internal(), stasis_message_router_is_done(), stasis_message_router_publish_sync(), stasis_message_router_remove(), stasis_message_router_remove_cache_update(), stasis_message_router_set_congestion_limits(), stasis_message_router_set_default(), stasis_message_router_set_formatters_default(), stasis_message_router_unsubscribe(), stasis_message_router_unsubscribe_and_join(), and unload_module().

◆ sub

struct stasis_subscription* sub
static

Statsd channel stats. Exmaple of how to subscribe to Stasis events.

This module subscribes to the channel caching topic and issues statsd stats based on the received messages.

Author
David M. Lee, II dlee@.nosp@m.digi.nosp@m.um.co.nosp@m.m
Since
12

Regular Stasis subscription

Definition at line 44 of file res_chan_stats.c.

Referenced by default_route(), load_module(), statsmaker(), and unload_module().

Generated on Wed Dec 18 2024 20:04:39 for Asterisk - The Open Source Telephony Project by doxygen 1.9.4