1 /**
2 * collectd - src/utils_format_graphite.c
3 * Copyright (C) 2012 Thomas Meson
4 * Copyright (C) 2012 Florian octo Forster
5 *
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.
9 *
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.
14 *
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
18 *
19 * Authors:
20 * Thomas Meson <zllak at hycik.org>
21 * Florian octo Forster <octo at collectd.org>
22 **/
24 #include "collectd.h"
25 #include "plugin.h"
26 #include "common.h"
28 #include "utils_format_graphite.h"
29 #include "utils_cache.h"
30 #include "utils_parse_option.h"
32 /* Utils functions to format data sets in graphite format.
33 * Largely taken from write_graphite.c as it remains the same formatting */
35 static int gr_format_values (char *ret, size_t ret_len,
36 int ds_num, const data_set_t *ds, const value_list_t *vl,
37 gauge_t const *rates)
38 {
39 size_t offset = 0;
40 int status;
42 assert (0 == strcmp (ds->type, vl->type));
44 memset (ret, 0, ret_len);
46 #define BUFFER_ADD(...) do { \
47 status = ssnprintf (ret + offset, ret_len - offset, \
48 __VA_ARGS__); \
49 if (status < 1) \
50 { \
51 return (-1); \
52 } \
53 else if (((size_t) status) >= (ret_len - offset)) \
54 { \
55 return (-1); \
56 } \
57 else \
58 offset += ((size_t) status); \
59 } while (0)
61 if (ds->ds[ds_num].type == DS_TYPE_GAUGE)
62 BUFFER_ADD ("%f", vl->values[ds_num].gauge);
63 else if (rates != NULL)
64 BUFFER_ADD ("%f", rates[ds_num]);
65 else if (ds->ds[ds_num].type == DS_TYPE_COUNTER)
66 BUFFER_ADD ("%llu", vl->values[ds_num].counter);
67 else if (ds->ds[ds_num].type == DS_TYPE_DERIVE)
68 BUFFER_ADD ("%"PRIi64, vl->values[ds_num].derive);
69 else if (ds->ds[ds_num].type == DS_TYPE_ABSOLUTE)
70 BUFFER_ADD ("%"PRIu64, vl->values[ds_num].absolute);
71 else
72 {
73 ERROR ("gr_format_values plugin: Unknown data source type: %i",
74 ds->ds[ds_num].type);
75 return (-1);
76 }
78 #undef BUFFER_ADD
80 return (0);
81 }
83 static void gr_copy_escape_part (char *dst, const char *src, size_t dst_len,
84 char escape_char)
85 {
86 size_t i;
88 memset (dst, 0, dst_len);
90 if (src == NULL)
91 return;
93 for (i = 0; i < dst_len; i++)
94 {
95 if (src[i] == 0)
96 {
97 dst[i] = 0;
98 break;
99 }
101 if ((src[i] == '.')
102 || isspace ((int) src[i])
103 || iscntrl ((int) src[i]))
104 dst[i] = escape_char;
105 else
106 dst[i] = src[i];
107 }
108 }
110 static int gr_format_name (char *ret, int ret_len,
111 value_list_t const *vl,
112 char const *ds_name,
113 char const *prefix,
114 char const *postfix,
115 char const escape_char,
116 unsigned int flags)
117 {
118 char n_host[DATA_MAX_NAME_LEN];
119 char n_plugin[DATA_MAX_NAME_LEN];
120 char n_plugin_instance[DATA_MAX_NAME_LEN];
121 char n_type[DATA_MAX_NAME_LEN];
122 char n_type_instance[DATA_MAX_NAME_LEN];
124 char tmp_plugin[2 * DATA_MAX_NAME_LEN + 1];
125 char tmp_type[2 * DATA_MAX_NAME_LEN + 1];
127 if (prefix == NULL)
128 prefix = "";
130 if (postfix == NULL)
131 postfix = "";
133 gr_copy_escape_part (n_host, vl->host,
134 sizeof (n_host), escape_char);
135 gr_copy_escape_part (n_plugin, vl->plugin,
136 sizeof (n_plugin), escape_char);
137 gr_copy_escape_part (n_plugin_instance, vl->plugin_instance,
138 sizeof (n_plugin_instance), escape_char);
139 gr_copy_escape_part (n_type, vl->type,
140 sizeof (n_type), escape_char);
141 gr_copy_escape_part (n_type_instance, vl->type_instance,
142 sizeof (n_type_instance), escape_char);
144 if (n_plugin_instance[0] != '\0')
145 ssnprintf (tmp_plugin, sizeof (tmp_plugin), "%s%c%s",
146 n_plugin,
147 (flags & GRAPHITE_SEPARATE_INSTANCES) ? '.' : '-',
148 n_plugin_instance);
149 else
150 sstrncpy (tmp_plugin, n_plugin, sizeof (tmp_plugin));
152 if (n_type_instance[0] != '\0')
153 ssnprintf (tmp_type, sizeof (tmp_type), "%s%c%s",
154 n_type,
155 (flags & GRAPHITE_SEPARATE_INSTANCES) ? '.' : '-',
156 n_type_instance);
157 else
158 sstrncpy (tmp_type, n_type, sizeof (tmp_type));
160 /* Assert always_append_ds -> ds_name */
161 assert (!(flags & GRAPHITE_ALWAYS_APPEND_DS) || (ds_name != NULL));
162 if (ds_name != NULL)
163 ssnprintf (ret, ret_len, "%s%s%s.%s.%s.%s",
164 prefix, n_host, postfix, tmp_plugin, tmp_type, ds_name);
165 else
166 ssnprintf (ret, ret_len, "%s%s%s.%s.%s",
167 prefix, n_host, postfix, tmp_plugin, tmp_type);
169 return (0);
170 }
172 int format_graphite (char *buffer, size_t buffer_size,
173 data_set_t const *ds, value_list_t const *vl,
174 char const *prefix, char const *postfix, char const escape_char,
175 unsigned int flags)
176 {
177 int status = 0;
178 int i;
179 int buffer_pos = 0;
181 gauge_t *rates = NULL;
182 if (flags & GRAPHITE_STORE_RATES)
183 rates = uc_get_rate (ds, vl);
185 for (i = 0; i < ds->ds_num; i++)
186 {
187 char const *ds_name = NULL;
188 char key[10*DATA_MAX_NAME_LEN];
189 char values[512];
190 size_t message_len;
191 char message[1024];
193 if ((flags & GRAPHITE_ALWAYS_APPEND_DS)
194 || (ds->ds_num > 1))
195 ds_name = ds->ds[i].name;
197 /* Copy the identifier to `key' and escape it. */
198 status = gr_format_name (key, sizeof (key), vl, ds_name,
199 prefix, postfix, escape_char, flags);
200 if (status != 0)
201 {
202 ERROR ("format_graphite: error with gr_format_name");
203 sfree (rates);
204 return (status);
205 }
207 escape_string (key, sizeof (key));
208 /* Convert the values to an ASCII representation and put that into
209 * `values'. */
210 status = gr_format_values (values, sizeof (values), i, ds, vl, rates);
211 if (status != 0)
212 {
213 ERROR ("format_graphite: error with gr_format_values");
214 sfree (rates);
215 return (status);
216 }
218 /* Compute the graphite command */
219 message_len = (size_t) ssnprintf (message, sizeof (message),
220 "%s %s %u\r\n",
221 key,
222 values,
223 (unsigned int) CDTIME_T_TO_TIME_T (vl->time));
224 if (message_len >= sizeof (message)) {
225 ERROR ("format_graphite: message buffer too small: "
226 "Need %zu bytes.", message_len + 1);
227 sfree (rates);
228 return (-ENOMEM);
229 }
231 /* Append it in case we got multiple data set */
232 if ((buffer_pos + message_len) >= buffer_size)
233 {
234 ERROR ("format_graphite: target buffer too small");
235 sfree (rates);
236 return (-ENOMEM);
237 }
238 memcpy((void *) (buffer + buffer_pos), message, message_len);
239 buffer_pos += message_len;
240 }
241 sfree (rates);
242 return (status);
243 } /* int format_graphite */
245 /* vim: set sw=2 sts=2 et fdm=marker : */