2 * collectd - src/collectdctl.c
3 * Copyright (C) 2010 Håkon J Dugstad Johnsen
4 * Copyright (C) 2010 Sebastian Harl
6 * This program is free software; you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License as published by the
8 * Free Software Foundation; only version 2 of the License is applicable.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
20 * Håkon J Dugstad Johnsen <hakon-dugstad.johnsen at telenor.com>
21 * Sebastian "tokkee" Harl <sh@tokkee.org>
28 #include "libcollectdclient/client.h"
42 #define DEFAULT_SOCK LOCALSTATEDIR"/run/"PACKAGE_NAME"-unixsock"
47 static void exit_usage (const char *name, int status) {
48 fprintf ((status == 0) ? stdout : stderr,
49 "Usage: %s [options] <command> [cmd options]\n\n"
51 "Available options:\n"
52 " -s Path to collectd's UNIX socket.\n"
53 " Default: "DEFAULT_SOCK"\n"
55 "\n -h Display this help and exit.\n"
57 "\nAvailable commands:\n\n"
59 " * getval <identifier>\n"
60 " * flush [timeout=<seconds>] [plugin=<name>] [identifier=<id>]\n"
65 "An identifier has the following format:\n\n"
67 " [<hostname>/]<plugin>[-<plugin_instance>]/<type>[-<type_instance>]\n\n"
69 "Hostname defaults to the local hostname if omitted (e.g., uptime/uptime).\n"
70 "No error is returned if the specified identifier does not exist.\n"
74 " collectdctl flush plugin=rrdtool identifie=somehost/cpu-0/cpu-wait\n\n"
76 "Flushes all CPU wait RRD values of the first CPU of the local host.\n"
77 "I.e., writes all pending RRD updates of that data-source to disk.\n"
79 "\n"PACKAGE" "VERSION", http://collectd.org/\n"
80 "by Florian octo Forster <octo@verplant.org>\n"
81 "for contributions see `AUTHORS'\n"
86 /* Count the number of occurrences of the character 'chr'
87 * in the specified string. */
88 static int count_chars (const char *str, char chr) {
91 while (*str != '\0') {
101 static int parse_identifier (lcc_connection_t *c,
102 const char *value, lcc_identifier_t *ident)
105 char ident_str[1024] = "";
110 n_slashes = count_chars (value, '/');
111 if (n_slashes == 1) {
112 /* The user has omitted the hostname part of the identifier
113 * (there is only one '/' in the identifier)
114 * Let's add the local hostname */
115 if (gethostname (hostname, sizeof (hostname)) != 0) {
116 fprintf (stderr, "ERROR: Failed to get local hostname: %s",
120 hostname[sizeof (hostname) - 1] = '\0';
122 snprintf (ident_str, sizeof (ident_str), "%s/%s", hostname, value);
123 ident_str[sizeof(ident_str) - 1] = '\0';
126 strncpy (ident_str, value, sizeof (ident_str));
127 ident_str[sizeof (ident_str) - 1] = '\0';
130 status = lcc_string_to_identifier (c, ident, ident_str);
132 fprintf (stderr, "ERROR: Failed to parse identifier ``%s'': %s.\n",
133 ident_str, lcc_strerror(c));
137 } /* parse_identifier */
139 static int getval (lcc_connection_t *c, int argc, char **argv)
141 lcc_identifier_t ident;
143 size_t ret_values_num = 0;
144 gauge_t *ret_values = NULL;
145 char **ret_values_names = NULL;
150 assert (strcasecmp (argv[0], "getval") == 0);
153 fprintf (stderr, "ERROR: getval: Missing identifier.\n");
157 memset (&ident, 0, sizeof (ident));
158 status = parse_identifier (c, argv[1], &ident);
162 #define BAIL_OUT(s) \
164 if (ret_values != NULL) \
166 if (ret_values_names != NULL) { \
167 for (i = 0; i < ret_values_num; ++i) \
168 free (ret_values_names[i]); \
169 free (ret_values_names); \
171 ret_values_num = 0; \
175 status = lcc_getval (c, &ident,
176 &ret_values_num, &ret_values, &ret_values_names);
178 fprintf (stderr, "ERROR: %s\n", lcc_strerror (c));
182 for (i = 0; i < ret_values_num; ++i)
183 printf ("%s=%e\n", ret_values_names[i], ret_values[i]);
187 static int flush (lcc_connection_t *c, int argc, char **argv)
189 lcc_identifier_t ident;
190 lcc_identifier_t *identp = NULL;
198 assert (strcasecmp (argv[0], "flush") == 0);
200 for (i = 1; i < argc; ++i) {
204 value = strchr (argv[i], (int)'=');
207 fprintf (stderr, "ERROR: flush: Invalid option ``%s''.\n", argv[i]);
214 if (strcasecmp (key, "timeout") == 0) {
217 timeout = strtol (value, &endptr, 0);
219 if (endptr == value) {
220 fprintf (stderr, "ERROR: Failed to parse timeout as number: %s.\n",
224 else if ((endptr != NULL) && (*endptr != '\0')) {
225 fprintf (stderr, "WARNING: Ignoring trailing garbage after timeout: "
229 else if (strcasecmp (key, "plugin") == 0) {
232 else if (strcasecmp (key, "identifier") == 0) {
235 memset (&ident, 0, sizeof (ident));
236 status = parse_identifier (c, value, &ident);
243 status = lcc_flush (c, plugin, identp, timeout);
245 fprintf (stderr, "ERROR: Flushing failed: %s.\n",
254 static int listval (lcc_connection_t *c, int argc, char **argv)
256 lcc_identifier_t *ret_ident = NULL;
257 size_t ret_ident_num = 0;
262 assert (strcasecmp (argv[0], "listval") == 0);
265 fprintf (stderr, "ERROR: listval: Does not accept any arguments.\n");
269 #define BAIL_OUT(s) \
271 if (ret_ident != NULL) \
277 status = lcc_listval (c, &ret_ident, &ret_ident_num);
279 fprintf (stderr, "ERROR: %s\n", lcc_strerror (c));
283 for (i = 0; i < ret_ident_num; ++i) {
286 status = lcc_identifier_to_string (c, id, sizeof (id), ret_ident + i);
288 fprintf (stderr, "ERROR: listval: Failed to convert returned "
289 "identifier to a string: %s\n", lcc_strerror (c));
299 int main (int argc, char **argv) {
300 char address[1024] = "unix:"DEFAULT_SOCK;
309 c = getopt (argc, argv, "s:h");
316 snprintf (address, sizeof (address), "unix:%s", optarg);
317 address[sizeof (address) - 1] = '\0';
320 exit_usage (argv[0], 0);
323 exit_usage (argv[0], 1);
327 if (optind >= argc) {
328 fprintf (stderr, "%s: missing command\n", argv[0]);
329 exit_usage (argv[0], 1);
333 status = lcc_connect (address, &c);
335 fprintf (stderr, "ERROR: Failed to connect to daemon at %s: %s.\n",
336 address, strerror (errno));
340 if (strcasecmp (argv[optind], "getval") == 0)
341 status = getval (c, argc - optind, argv + optind);
342 else if (strcasecmp (argv[optind], "flush") == 0)
343 status = flush (c, argc - optind, argv + optind);
344 else if (strcasecmp (argv[optind], "listval") == 0)
345 status = listval (c, argc - optind, argv + optind);
347 fprintf (stderr, "%s: invalid command: %s\n", argv[0], argv[optind]);
358 /* vim: set sw=2 ts=2 tw=78 expandtab : */