Split caching out from the stasis_caching_topic.
[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 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
38
39 #include "asterisk/module.h"
40 #include "asterisk/stasis_channels.h"
41 #include "asterisk/stasis_message_router.h"
42 #include "asterisk/statsd.h"
43 #include "asterisk/time.h"
44
45 /*! Regular Stasis subscription */
46 static struct stasis_subscription *sub;
47 /*! Stasis message router */
48 static struct stasis_message_router *router;
49
50 /*!
51  * \brief Subscription callback for all channel messages.
52  * \param data Data pointer given when creating the subscription.
53  * \param sub This subscription.
54  * \param topic The topic the message was posted to. This is not necessarily the
55  *              topic you subscribed to, since messages may be forwarded between
56  *              topics.
57  * \param message The message itself.
58  */
59 static void statsmaker(void *data, struct stasis_subscription *sub,
60         struct stasis_topic *topic, struct stasis_message *message)
61 {
62         RAII_VAR(struct ast_str *, metric, NULL, ast_free);
63
64         if (stasis_subscription_final_message(sub, message)) {
65                 /* Normally, data points to an object that must be cleaned up.
66                  * The final message is an unsubscribe notification that's
67                  * guaranteed to be the last message this subscription receives.
68                  * This would be a safe place to kick off any needed cleanup.
69                  */
70                 return;
71         }
72
73         /* For no good reason, count message types */
74         metric = ast_str_create(80);
75         if (metric) {
76                 ast_str_set(&metric, 0, "stasis.message.%s",
77                         stasis_message_type_name(stasis_message_type(message)));
78                 ast_statsd_log(ast_str_buffer(metric), AST_STATSD_METER, 1);
79         }
80 }
81
82 /*!
83  * \brief Router callback for \ref stasis_cache_update messages.
84  * \param data Data pointer given when added to router.
85  * \param sub This subscription.
86  * \param topic The topic the message was posted to. This is not necessarily the
87  *              topic you subscribed to, since messages may be forwarded between
88  *              topics.
89  * \param message The message itself.
90  */
91 static void updates(void *data, struct stasis_subscription *sub,
92         struct stasis_topic *topic, struct stasis_message *message)
93 {
94         /* Since this came from a message router, we know the type of the
95          * message. We can cast the data without checking its type.
96          */
97         struct stasis_cache_update *update = stasis_message_data(message);
98
99         /* We're only interested in channel snapshots, so check the type
100          * of the underlying message.
101          */
102         if (ast_channel_snapshot_type() != update->type) {
103                 return;
104         }
105
106         /* There are three types of cache updates.
107          * !old && new -> Initial cache entry
108          * old && new -> Updated cache entry
109          * old && !new -> Cache entry removed.
110          */
111
112         if (!update->old_snapshot && update->new_snapshot) {
113                 /* Initial cache entry; count a channel creation */
114                 ast_statsd_log("channels.count", AST_STATSD_COUNTER, 1);
115         } else if (update->old_snapshot && !update->new_snapshot) {
116                 /* Cache entry removed. Compute the age of the channel and post
117                  * that, as well as decrementing the channel count.
118                  */
119                 struct ast_channel_snapshot *last;
120                 int64_t age;
121
122                 last = stasis_message_data(update->old_snapshot);
123                 age = ast_tvdiff_ms(*stasis_message_timestamp(message),
124                         last->creationtime);
125                 ast_statsd_log("channels.calltime", AST_STATSD_TIMER, age);
126
127                 /* And decrement the channel count */
128                 ast_statsd_log("channels.count", AST_STATSD_COUNTER, -1);
129         }
130 }
131
132 /*!
133  * \brief Router callback for any message that doesn't otherwise have a route.
134  * \param data Data pointer given when added to router.
135  * \param sub This subscription.
136  * \param topic The topic the message was posted to. This is not necessarily the
137  *              topic you subscribed to, since messages may be forwarded between
138  *              topics.
139  * \param message The message itself.
140  */
141 static void default_route(void *data, struct stasis_subscription *sub,
142         struct stasis_topic *topic, struct stasis_message *message)
143 {
144         if (stasis_subscription_final_message(sub, message)) {
145                 /* Much like with the regular subscription, you may need to
146                  * perform some cleanup when done with a message router. You
147                  * can look for the final message in the default route.
148                  */
149                 return;
150         }
151 }
152
153 static int load_module(void)
154 {
155         /* You can create a message router to route messages by type */
156         router = stasis_message_router_create(
157                 ast_channel_topic_all_cached());
158         if (!router) {
159                 return AST_MODULE_LOAD_FAILURE;
160         }
161         stasis_message_router_add(router, stasis_cache_update_type(),
162                 updates, NULL);
163         stasis_message_router_set_default(router, default_route, NULL);
164
165         /* Or a subscription to receive all of the messages from a topic */
166         sub = stasis_subscribe(ast_channel_topic_all(), statsmaker, NULL);
167         if (!sub) {
168                 return AST_MODULE_LOAD_FAILURE;
169         }
170         return AST_MODULE_LOAD_SUCCESS;
171 }
172
173 static int unload_module(void)
174 {
175         stasis_unsubscribe_and_join(sub);
176         sub = NULL;
177         stasis_message_router_unsubscribe_and_join(router);
178         router = NULL;
179         return 0;
180 }
181
182 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_DEFAULT, "Example of how to use Stasis",
183         .load = load_module,
184         .unload = unload_module,
185         .nonoptreq = "res_statsd"
186         );