Merge "res_odbc: fix missing SQL error diagnostic"
[asterisk/asterisk.git] / res / res_chan_stats.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2013, Digium, Inc.
5  *
6  * David M. Lee, II <dlee@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*!
20  * \brief Statsd channel stats. Exmaple of how to subscribe to Stasis events.
21  *
22  * This module subscribes to the channel caching topic and issues statsd stats
23  * based on the received messages.
24  *
25  * \author David M. Lee, II <dlee@digium.com>
26  * \since 12
27  */
28
29 /*** MODULEINFO
30         <depend>res_statsd</depend>
31         <defaultenabled>no</defaultenabled>
32         <support_level>extended</support_level>
33  ***/
34
35 #include "asterisk.h"
36
37 #include "asterisk/module.h"
38 #include "asterisk/stasis_channels.h"
39 #include "asterisk/stasis_message_router.h"
40 #include "asterisk/statsd.h"
41 #include "asterisk/time.h"
42
43 /*! Regular Stasis subscription */
44 static struct stasis_subscription *sub;
45 /*! Stasis message router */
46 static struct stasis_message_router *router;
47
48 /*!
49  * \brief Subscription callback for all channel messages.
50  * \param data Data pointer given when creating the subscription.
51  * \param sub This subscription.
52  * \param topic The topic the message was posted to. This is not necessarily the
53  *              topic you subscribed to, since messages may be forwarded between
54  *              topics.
55  * \param message The message itself.
56  */
57 static void statsmaker(void *data, struct stasis_subscription *sub,
58         struct stasis_message *message)
59 {
60         RAII_VAR(struct ast_str *, metric, NULL, ast_free);
61
62         if (stasis_subscription_final_message(sub, message)) {
63                 /* Normally, data points to an object that must be cleaned up.
64                  * The final message is an unsubscribe notification that's
65                  * guaranteed to be the last message this subscription receives.
66                  * This would be a safe place to kick off any needed cleanup.
67                  */
68                 return;
69         }
70
71         /* For no good reason, count message types */
72         metric = ast_str_create(80);
73         if (metric) {
74                 ast_str_set(&metric, 0, "stasis.message.%s",
75                         stasis_message_type_name(stasis_message_type(message)));
76                 ast_statsd_log(ast_str_buffer(metric), AST_STATSD_METER, 1);
77         }
78 }
79
80 /*!
81  * \brief Router callback for \ref stasis_cache_update messages.
82  * \param data Data pointer given when added to router.
83  * \param sub This subscription.
84  * \param topic The topic the message was posted to. This is not necessarily the
85  *              topic you subscribed to, since messages may be forwarded between
86  *              topics.
87  * \param message The message itself.
88  */
89 static void updates(void *data, struct stasis_subscription *sub,
90         struct stasis_message *message)
91 {
92         /* Since this came from a message router, we know the type of the
93          * message. We can cast the data without checking its type.
94          */
95         struct stasis_cache_update *update = stasis_message_data(message);
96
97         /* We're only interested in channel snapshots, so check the type
98          * of the underlying message.
99          */
100         if (ast_channel_snapshot_type() != update->type) {
101                 return;
102         }
103
104         /* There are three types of cache updates.
105          * !old && new -> Initial cache entry
106          * old && new -> Updated cache entry
107          * old && !new -> Cache entry removed.
108          */
109
110         if (!update->old_snapshot && update->new_snapshot) {
111                 /* Initial cache entry; count a channel creation */
112                 ast_statsd_log_string("channels.count", AST_STATSD_GAUGE, "+1", 1.0);
113         } else if (update->old_snapshot && !update->new_snapshot) {
114                 /* Cache entry removed. Compute the age of the channel and post
115                  * that, as well as decrementing the channel count.
116                  */
117                 struct ast_channel_snapshot *last;
118                 int64_t age;
119
120                 last = stasis_message_data(update->old_snapshot);
121                 age = ast_tvdiff_ms(*stasis_message_timestamp(message),
122                         last->creationtime);
123                 ast_statsd_log("channels.calltime", AST_STATSD_TIMER, age);
124
125                 /* And decrement the channel count */
126                 ast_statsd_log_string("channels.count", AST_STATSD_GAUGE, "-1", 1.0);
127         }
128 }
129
130 /*!
131  * \brief Router callback for any message that doesn't otherwise have a route.
132  * \param data Data pointer given when added to router.
133  * \param sub This subscription.
134  * \param topic The topic the message was posted to. This is not necessarily the
135  *              topic you subscribed to, since messages may be forwarded between
136  *              topics.
137  * \param message The message itself.
138  */
139 static void default_route(void *data, struct stasis_subscription *sub,
140         struct stasis_message *message)
141 {
142         if (stasis_subscription_final_message(sub, message)) {
143                 /* Much like with the regular subscription, you may need to
144                  * perform some cleanup when done with a message router. You
145                  * can look for the final message in the default route.
146                  */
147                 return;
148         }
149 }
150
151 static int unload_module(void)
152 {
153         stasis_unsubscribe_and_join(sub);
154         sub = NULL;
155         stasis_message_router_unsubscribe_and_join(router);
156         router = NULL;
157         return 0;
158 }
159
160 static int load_module(void)
161 {
162         /* You can create a message router to route messages by type */
163         router = stasis_message_router_create(
164                 ast_channel_topic_all_cached());
165         if (!router) {
166                 return AST_MODULE_LOAD_DECLINE;
167         }
168         stasis_message_router_add(router, stasis_cache_update_type(),
169                 updates, NULL);
170         stasis_message_router_set_default(router, default_route, NULL);
171
172         /* Or a subscription to receive all of the messages from a topic */
173         sub = stasis_subscribe(ast_channel_topic_all(), statsmaker, NULL);
174         if (!sub) {
175                 unload_module();
176                 return AST_MODULE_LOAD_DECLINE;
177         }
178         return AST_MODULE_LOAD_SUCCESS;
179 }
180
181 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_DEFAULT, "Example of how to use Stasis",
182         .support_level = AST_MODULE_SUPPORT_EXTENDED,
183         .load = load_module,
184         .unload = unload_module,
185         .requires = "res_statsd"
186 );