1 /*
2 * collectd - src/utils_tail_match.h
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 * Authors:
25 * Luke Heberling <lukeh at c-ware.com>
26 * Florian Forster <octo at collectd.org>
27 *
28 * Description:
29 * `tail_match' uses `utils_tail' and `utils_match' to tail a file and try to
30 * match it using several regular expressions. Matches are then passed to
31 * user-provided callback functions or default handlers. This should keep all
32 * of the parsing logic out of the actual plugin, which only operate with
33 * regular expressions.
34 */
36 #include "utils_match.h"
38 struct cu_tail_match_s;
39 typedef struct cu_tail_match_s cu_tail_match_t;
41 /*
42 * NAME
43 * tail_match_create
44 *
45 * DESCRIPTION
46 * Allocates, initializes and returns a new `cu_tail_match_t' object.
47 *
48 * PARAMETERS
49 * `filename' The name to read data from.
50 *
51 * RETURN VALUE
52 * Returns NULL upon failure, non-NULL otherwise.
53 */
54 cu_tail_match_t *tail_match_create(const char *filename);
56 /*
57 * NAME
58 * tail_match_destroy
59 *
60 * DESCRIPTION
61 * Releases resources used by the `cu_tail_match_t' object.
62 *
63 * PARAMETERS
64 * The object to destroy.
65 */
66 void tail_match_destroy(cu_tail_match_t *obj);
68 /*
69 * NAME
70 * tail_match_add_match
71 *
72 * DESCRIPTION
73 * Adds a match, in form of a `cu_match_t' object, to the object.
74 * After data has been read from the logfile (using utils_tail) the callback
75 * function `submit_match' is called with the match object and the user
76 * supplied data.
77 * Please note that his function is called regardless whether this match
78 * matched any lines recently or not.
79 * When `tail_match_destroy' is called the `user_data' pointer is freed using
80 * the `free_user_data' callback - if it is not NULL.
81 * When using this interface the `tail_match' module doesn't dispatch any
82 * values
83 * itself - all that has to happen in either the match-callbacks or the
84 * submit_match callback.
85 *
86 * RETURN VALUE
87 * Zero upon success, non-zero otherwise.
88 */
89 int tail_match_add_match(cu_tail_match_t *obj, cu_match_t *match,
90 int (*submit_match)(cu_match_t *match,
91 void *user_data),
92 void *user_data,
93 void (*free_user_data)(void *user_data));
95 /*
96 * NAME
97 * tail_match_add_match_simple
98 *
99 * DESCRIPTION
100 * A simplified version of `tail_match_add_match'. The regular expressen
101 * `regex'
102 * must match a number, which is then dispatched according to `ds_type'. See
103 * the `match_create_simple' function in utils_match.h for a description how
104 * this flag effects calculation of a new value.
105 * The values gathered are dispatched by the tail_match module in this case.
106 * The
107 * passed `plugin', `plugin_instance', `type', and `type_instance' are
108 * directly used when submitting these values.
109 * With excluderegex it is possible to exlude lines from the match.
110 *
111 * RETURN VALUE
112 * Zero upon success, non-zero otherwise.
113 */
114 int tail_match_add_match_simple(cu_tail_match_t *obj, const char *regex,
115 const char *excluderegex, int ds_type,
116 const char *plugin, const char *plugin_instance,
117 const char *type, const char *type_instance,
118 const cdtime_t interval);
120 /*
121 * NAME
122 * tail_match_read
123 *
124 * DESCRIPTION
125 * This function should be called periodically by plugins. It reads new lines
126 * from the logfile using `utils_tail' and tries to match them using all
127 * added `utils_match' objects.
128 * After all lines have been read and processed, the submit_match callback is
129 * called or, in case of tail_match_add_match_simple, the data is dispatched
130 * to
131 * the daemon directly.
132 *
133 * RETURN VALUE
134 * Zero on success, nonzero on failure.
135 */
136 int tail_match_read(cu_tail_match_t *obj);
138 /* vim: set sw=2 sts=2 ts=8 : */