1 /*
2 * collectd - src/utils_tail_match.c
3 * Copyright (C) 2007-2008 C-Ware, Inc.
4 * Copyright (C) 2008 Florian Forster
5 *
6 * Permission is hereby granted, free of charge, to any person obtaining a
7 * copy of this software and associated documentation files (the "Software"),
8 * to deal in the Software without restriction, including without limitation
9 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
10 * and/or sell copies of the Software, and to permit persons to whom the
11 * Software is furnished to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22 * DEALINGS IN THE SOFTWARE.
23 *
24 * Author:
25 * Luke Heberling <lukeh at c-ware.com>
26 * Florian Forster <octo at collectd.org>
27 *
28 * Description:
29 * Encapsulates useful code to plugins which must parse a log file.
30 */
32 #include "collectd.h"
33 #include "common.h"
34 #include "plugin.h"
35 #include "utils_match.h"
36 #include "utils_tail.h"
37 #include "utils_tail_match.h"
39 struct cu_tail_match_simple_s
40 {
41 char plugin[DATA_MAX_NAME_LEN];
42 char plugin_instance[DATA_MAX_NAME_LEN];
43 char type[DATA_MAX_NAME_LEN];
44 char type_instance[DATA_MAX_NAME_LEN];
45 cdtime_t interval;
46 };
47 typedef struct cu_tail_match_simple_s cu_tail_match_simple_t;
49 struct cu_tail_match_match_s
50 {
51 cu_match_t *match;
52 void *user_data;
53 int (*submit) (cu_match_t *match, void *user_data);
54 void (*free) (void *user_data);
55 };
56 typedef struct cu_tail_match_match_s cu_tail_match_match_t;
58 struct cu_tail_match_s
59 {
60 int flags;
61 cu_tail_t *tail;
63 cdtime_t interval;
64 cu_tail_match_match_t *matches;
65 size_t matches_num;
66 };
68 /*
69 * Private functions
70 */
71 static int simple_submit_match (cu_match_t *match, void *user_data)
72 {
73 cu_tail_match_simple_t *data = (cu_tail_match_simple_t *) user_data;
74 cu_match_value_t *match_value;
75 value_list_t vl = VALUE_LIST_INIT;
76 value_t values[1];
78 match_value = (cu_match_value_t *) match_get_user_data (match);
79 if (match_value == NULL)
80 return (-1);
82 if ((match_value->ds_type & UTILS_MATCH_DS_TYPE_GAUGE)
83 && (match_value->values_num == 0))
84 values[0].gauge = NAN;
85 else
86 values[0] = match_value->value;
88 vl.values = values;
89 vl.values_len = 1;
90 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
91 sstrncpy (vl.plugin, data->plugin, sizeof (vl.plugin));
92 sstrncpy (vl.plugin_instance, data->plugin_instance,
93 sizeof (vl.plugin_instance));
94 sstrncpy (vl.type, data->type, sizeof (vl.type));
95 sstrncpy (vl.type_instance, data->type_instance,
96 sizeof (vl.type_instance));
98 vl.interval = data->interval;
99 plugin_dispatch_values (&vl);
101 if (match_value->ds_type & UTILS_MATCH_DS_TYPE_GAUGE)
102 {
103 match_value->value.gauge = NAN;
104 match_value->values_num = 0;
105 }
107 return (0);
108 } /* int simple_submit_match */
110 static int tail_callback (void *data, char *buf,
111 int __attribute__((unused)) buflen)
112 {
113 cu_tail_match_t *obj = (cu_tail_match_t *) data;
114 size_t i;
116 for (i = 0; i < obj->matches_num; i++)
117 match_apply (obj->matches[i].match, buf);
119 return (0);
120 } /* int tail_callback */
122 /*
123 * Public functions
124 */
125 cu_tail_match_t *tail_match_create (const char *filename)
126 {
127 cu_tail_match_t *obj;
129 obj = calloc (1, sizeof (*obj));
130 if (obj == NULL)
131 return (NULL);
133 obj->tail = cu_tail_create (filename);
134 if (obj->tail == NULL)
135 {
136 sfree (obj);
137 return (NULL);
138 }
140 return (obj);
141 } /* cu_tail_match_t *tail_match_create */
143 void tail_match_destroy (cu_tail_match_t *obj)
144 {
145 size_t i;
147 if (obj == NULL)
148 return;
150 if (obj->tail != NULL)
151 {
152 cu_tail_destroy (obj->tail);
153 obj->tail = NULL;
154 }
156 for (i = 0; i < obj->matches_num; i++)
157 {
158 cu_tail_match_match_t *match = obj->matches + i;
159 if (match->match != NULL)
160 {
161 match_destroy (match->match);
162 match->match = NULL;
163 }
165 if ((match->user_data != NULL)
166 && (match->free != NULL))
167 (*match->free) (match->user_data);
168 match->user_data = NULL;
169 }
171 sfree (obj->matches);
172 sfree (obj);
173 } /* void tail_match_destroy */
175 int tail_match_add_match (cu_tail_match_t *obj, cu_match_t *match,
176 int (*submit_match) (cu_match_t *match, void *user_data),
177 void *user_data,
178 void (*free_user_data) (void *user_data))
179 {
180 cu_tail_match_match_t *temp;
182 temp = (cu_tail_match_match_t *) realloc (obj->matches,
183 sizeof (cu_tail_match_match_t) * (obj->matches_num + 1));
184 if (temp == NULL)
185 return (-1);
187 obj->matches = temp;
188 obj->matches_num++;
190 DEBUG ("tail_match_add_match interval %lf", CDTIME_T_TO_DOUBLE(((cu_tail_match_simple_t *)user_data)->interval));
191 temp = obj->matches + (obj->matches_num - 1);
193 temp->match = match;
194 temp->user_data = user_data;
195 temp->submit = submit_match;
196 temp->free = free_user_data;
198 return (0);
199 } /* int tail_match_add_match */
201 int tail_match_add_match_simple (cu_tail_match_t *obj,
202 const char *regex, const char *excluderegex, int ds_type,
203 const char *plugin, const char *plugin_instance,
204 const char *type, const char *type_instance, const cdtime_t interval)
205 {
206 cu_match_t *match;
207 cu_tail_match_simple_t *user_data;
208 int status;
210 match = match_create_simple (regex, excluderegex, ds_type);
211 if (match == NULL)
212 return (-1);
214 user_data = calloc (1, sizeof (*user_data));
215 if (user_data == NULL)
216 {
217 match_destroy (match);
218 return (-1);
219 }
221 sstrncpy (user_data->plugin, plugin, sizeof (user_data->plugin));
222 if (plugin_instance != NULL)
223 sstrncpy (user_data->plugin_instance, plugin_instance,
224 sizeof (user_data->plugin_instance));
226 sstrncpy (user_data->type, type, sizeof (user_data->type));
227 if (type_instance != NULL)
228 sstrncpy (user_data->type_instance, type_instance,
229 sizeof (user_data->type_instance));
231 user_data->interval = interval;
233 status = tail_match_add_match (obj, match, simple_submit_match,
234 user_data, free);
236 if (status != 0)
237 {
238 match_destroy (match);
239 sfree (user_data);
240 }
242 return (status);
243 } /* int tail_match_add_match_simple */
245 int tail_match_read (cu_tail_match_t *obj)
246 {
247 char buffer[4096];
248 int status;
249 size_t i;
251 status = cu_tail_read (obj->tail, buffer, sizeof (buffer), tail_callback,
252 (void *) obj);
253 if (status != 0)
254 {
255 ERROR ("tail_match: cu_tail_read failed.");
256 return (status);
257 }
259 for (i = 0; i < obj->matches_num; i++)
260 {
261 cu_tail_match_match_t *lt_match = obj->matches + i;
263 if (lt_match->submit == NULL)
264 continue;
266 (*lt_match->submit) (lt_match->match, lt_match->user_data);
267 }
269 return (0);
270 } /* int tail_match_read */
272 /* vim: set sw=2 sts=2 ts=8 : */