First version of the users plugin.
[collectd.git] / src / users.c
1 /* 
2  * users.c
3  *
4  * users plugin for collectd
5  *
6  * This plugin collects the number of users currently logged into the system.
7  *
8  * Written by Sebastian Harl <sh@tokkee.org>
9  *
10  * This program is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation; either version 2 of the License, or
13  * (at your option) any later version.
14  * 
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU General Public License for more details.
19  * 
20  * You should have received a copy of the GNU General Public License
21  * along with this program; if not, write to the Free Software
22  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
23  */
24
25 #include "users.h"
26
27 #if COLLECT_USERS
28 #define MODULE_NAME "users"
29
30 #include "plugin.h"
31 #include "common.h"
32
33 #include <utmp.h>
34
35 static char *rrd_file = "users.rrd";
36
37 static char *ds_def[] = {
38     "DS:users:GAUGE:25:0:65535",
39     NULL
40 };
41 static int ds_num = 1;
42
43 extern time_t curtime;
44
45 void users_init(void)
46 {
47     /* we have nothing to do here :-) */
48     return;
49 }
50
51 void users_read(void)
52 {
53     unsigned int users = 0;
54     unsigned int root  = 0;
55     struct utmp *entry = NULL;
56
57     /* according to the *utent(3) man page none of the functions sets errno in
58      * case of an error, so we cannot do any error-checking here */
59     setutent();
60
61     while (NULL != (entry = getutent()))
62         if (USER_PROCESS == entry->ut_type)
63             ++users;
64     endutent();
65
66     users_submit(users);
67     return;
68 }
69
70 /* I don't like this temporary macro definition - well it's used everywhere
71  * else in the collectd-sources, so I will just stick with it...  */
72 #define BUFSIZE 256
73 void users_submit(users)
74     unsigned int users;
75 {
76     char buf[BUFSIZE] = "";
77
78     if (snprintf(buf, BUFSIZE, "%u:%u", 
79                 (unsigned int)curtime, 
80                 users) >= BUFSIZE)
81         return;
82
83     plugin_submit(MODULE_NAME, NULL, buf);
84     return;
85 }
86 #undef BUFSIZE
87
88 void users_write(host, inst, val)
89     char *host;
90     char *inst;
91     char *val;
92 {
93     rrd_update_file(host, rrd_file, val, ds_def, ds_num);
94     return;
95 }
96
97 void module_register(void)
98 {
99     plugin_register(MODULE_NAME, users_init, users_read, users_write);
100     return;
101 }
102
103 #undef MODULE_NAME
104 #endif /* COLLECT_USERS */
105