collectd.conf(5): Improve write_stackdriver documentation.
[collectd.git] / src / users.c
1 /**
2  * collectd - src/users.c
3  * Copyright (C) 2005-2007  Sebastian Harl
4  * Copyright (C) 2005       Niki W. Waibel
5  * Copyright (C) 2005-2007  Florian octo Forster
6  * Copyright (C) 2008       Oleg King
7  *
8  * This program is free software; you can redistribute it and/or modify it
9  * under the terms of the GNU General Public License as published by the
10  * Free Software Foundation; only version 2 of the license is applicable.
11  *
12  * This program is distributed in the hope that it will be useful, but
13  * WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License along
18  * with this program; if not, write to the Free Software Foundation, Inc.,
19  * 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
20  *
21  * Authors:
22  *   Sebastian Harl <sh at tokkee.org>
23  *   Niki W. Waibel <niki.waibel at newlogic.com>
24  *   Florian octo Forster <octo at collectd.org>
25  *   Oleg King <king2 at kaluga.ru>
26  **/
27
28 #include "collectd.h"
29
30 #include "common.h"
31 #include "plugin.h"
32
33 #if HAVE_STATGRAB_H
34 #include <statgrab.h>
35 #endif /* HAVE_STATGRAB_H */
36
37 #if HAVE_UTMPX_H
38 #include <utmpx.h>
39 /* #endif HAVE_UTMPX_H */
40
41 #elif HAVE_UTMP_H
42 #include <utmp.h>
43 /* #endif HAVE_UTMP_H */
44 #endif
45
46 static void users_submit(gauge_t value) {
47   value_list_t vl = VALUE_LIST_INIT;
48
49   vl.values = &(value_t){.gauge = value};
50   vl.values_len = 1;
51   sstrncpy(vl.plugin, "users", sizeof(vl.plugin));
52   sstrncpy(vl.type, "users", sizeof(vl.plugin));
53
54   plugin_dispatch_values(&vl);
55 } /* void users_submit */
56
57 static int users_read(void) {
58 #if HAVE_GETUTXENT
59   unsigned int users = 0;
60   struct utmpx *entry = NULL;
61
62   /* according to the *utent(3) man page none of the functions sets errno
63      in case of an error, so we cannot do any error-checking here */
64   setutxent();
65
66   while (NULL != (entry = getutxent())) {
67     if (USER_PROCESS == entry->ut_type) {
68       ++users;
69     }
70   }
71   endutxent();
72
73   users_submit(users);
74 /* #endif HAVE_GETUTXENT */
75
76 #elif HAVE_GETUTENT
77   unsigned int users = 0;
78   struct utmp *entry = NULL;
79
80   /* according to the *utent(3) man page none of the functions sets errno
81      in case of an error, so we cannot do any error-checking here */
82   setutent();
83
84   while (NULL != (entry = getutent())) {
85     if (USER_PROCESS == entry->ut_type) {
86       ++users;
87     }
88   }
89   endutent();
90
91   users_submit(users);
92 /* #endif HAVE_GETUTENT */
93
94 #elif HAVE_LIBSTATGRAB
95   sg_user_stats *us;
96
97 #if HAVE_LIBSTATGRAB_0_90
98   size_t num_entries;
99   us = sg_get_user_stats(&num_entries);
100 #else
101   us = sg_get_user_stats();
102 #endif
103   if (us == NULL)
104     return -1;
105
106   users_submit((gauge_t)
107 #if HAVE_LIBSTATGRAB_0_90
108                    num_entries);
109 #else
110                    us->num_entries);
111 #endif
112 /* #endif HAVE_LIBSTATGRAB */
113
114 #else
115 #error "No applicable input method."
116 #endif
117
118   return 0;
119 } /* int users_read */
120
121 void module_register(void) {
122   plugin_register_read("users", users_read);
123 } /* void module_register(void) */