2 * collectd - src/utils_format_graphite.c
3 * Copyright (C) 2012 Thomas Meson
4 * Copyright (C) 2012 Florian octo Forster
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 * Thomas Meson <zllak at hycik.org>
21 * Florian octo Forster <octo at collectd.org>
29 #include "utils_format_graphite.h"
30 #include "utils_cache.h"
32 #define GRAPHITE_FORBIDDEN " \t\"\\:!/()\n\r"
34 /* Utils functions to format data sets in graphite format.
35 * Largely taken from write_graphite.c as it remains the same formatting */
37 static int gr_format_values (char *ret, size_t ret_len,
38 int ds_num, const data_set_t *ds, const value_list_t *vl,
44 assert (0 == strcmp (ds->type, vl->type));
46 memset (ret, 0, ret_len);
48 #define BUFFER_ADD(...) do { \
49 status = ssnprintf (ret + offset, ret_len - offset, \
55 else if (((size_t) status) >= (ret_len - offset)) \
60 offset += ((size_t) status); \
63 if (ds->ds[ds_num].type == DS_TYPE_GAUGE)
64 BUFFER_ADD (GAUGE_FORMAT, vl->values[ds_num].gauge);
65 else if (rates != NULL)
66 BUFFER_ADD ("%f", rates[ds_num]);
67 else if (ds->ds[ds_num].type == DS_TYPE_COUNTER)
68 BUFFER_ADD ("%llu", vl->values[ds_num].counter);
69 else if (ds->ds[ds_num].type == DS_TYPE_DERIVE)
70 BUFFER_ADD ("%"PRIi64, vl->values[ds_num].derive);
71 else if (ds->ds[ds_num].type == DS_TYPE_ABSOLUTE)
72 BUFFER_ADD ("%"PRIu64, vl->values[ds_num].absolute);
75 ERROR ("gr_format_values plugin: Unknown data source type: %i",
85 static void gr_copy_escape_part (char *dst, const char *src, size_t dst_len,
88 memset (dst, 0, dst_len);
93 for (size_t i = 0; i < dst_len; i++)
102 || isspace ((int) src[i])
103 || iscntrl ((int) src[i]))
104 dst[i] = escape_char;
110 static int gr_format_name (char *ret, int ret_len,
111 value_list_t const *vl,
115 char const escape_char,
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];
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",
147 (flags & GRAPHITE_SEPARATE_INSTANCES) ? '.' : '-',
150 sstrncpy (tmp_plugin, n_plugin, sizeof (tmp_plugin));
152 if (n_type_instance[0] != '\0')
154 if ((flags & GRAPHITE_DROP_DUPE_FIELDS) && strcmp(n_plugin, n_type) == 0)
155 sstrncpy (tmp_type, n_type_instance, sizeof (tmp_type));
157 ssnprintf (tmp_type, sizeof (tmp_type), "%s%c%s",
159 (flags & GRAPHITE_SEPARATE_INSTANCES) ? '.' : '-',
163 sstrncpy (tmp_type, n_type, sizeof (tmp_type));
165 /* Assert always_append_ds -> ds_name */
166 assert (!(flags & GRAPHITE_ALWAYS_APPEND_DS) || (ds_name != NULL));
169 if ((flags & GRAPHITE_DROP_DUPE_FIELDS) && strcmp(tmp_plugin, tmp_type) == 0)
170 ssnprintf (ret, ret_len, "%s%s%s.%s.%s",
171 prefix, n_host, postfix, tmp_plugin, ds_name);
173 ssnprintf (ret, ret_len, "%s%s%s.%s.%s.%s",
174 prefix, n_host, postfix, tmp_plugin, tmp_type, ds_name);
177 ssnprintf (ret, ret_len, "%s%s%s.%s.%s",
178 prefix, n_host, postfix, tmp_plugin, tmp_type);
183 static void escape_graphite_string (char *buffer, char escape_char)
185 assert (strchr(GRAPHITE_FORBIDDEN, escape_char) == NULL);
187 for (char *head = buffer + strcspn(buffer, GRAPHITE_FORBIDDEN);
189 head += strcspn(head, GRAPHITE_FORBIDDEN))
193 int format_graphite (char *buffer, size_t buffer_size,
194 data_set_t const *ds, value_list_t const *vl,
195 char const *prefix, char const *postfix, char const escape_char,
201 gauge_t *rates = NULL;
202 if (flags & GRAPHITE_STORE_RATES)
203 rates = uc_get_rate (ds, vl);
205 for (size_t i = 0; i < ds->ds_num; i++)
207 char const *ds_name = NULL;
208 char key[10*DATA_MAX_NAME_LEN];
213 if ((flags & GRAPHITE_ALWAYS_APPEND_DS)
215 ds_name = ds->ds[i].name;
217 /* Copy the identifier to `key' and escape it. */
218 status = gr_format_name (key, sizeof (key), vl, ds_name,
219 prefix, postfix, escape_char, flags);
222 ERROR ("format_graphite: error with gr_format_name");
227 escape_graphite_string (key, escape_char);
228 /* Convert the values to an ASCII representation and put that into
230 status = gr_format_values (values, sizeof (values), i, ds, vl, rates);
233 ERROR ("format_graphite: error with gr_format_values");
238 /* Compute the graphite command */
239 message_len = (size_t) ssnprintf (message, sizeof (message),
243 (unsigned int) CDTIME_T_TO_TIME_T (vl->time));
244 if (message_len >= sizeof (message)) {
245 ERROR ("format_graphite: message buffer too small: "
246 "Need %zu bytes.", message_len + 1);
251 /* Append it in case we got multiple data set */
252 if ((buffer_pos + message_len) >= buffer_size)
254 ERROR ("format_graphite: target buffer too small");
258 memcpy((void *) (buffer + buffer_pos), message, message_len);
259 buffer_pos += message_len;
263 } /* int format_graphite */
265 /* vim: set sw=2 sts=2 et fdm=marker : */