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_latency_config.h"
37 #include "utils_match.h"
39 struct cu_tail_match_s;
40 typedef struct cu_tail_match_s cu_tail_match_t;
42 /*
43 * NAME
44 * tail_match_create
45 *
46 * DESCRIPTION
47 * Allocates, initializes and returns a new `cu_tail_match_t' object.
48 *
49 * PARAMETERS
50 * `filename' The name to read data from.
51 *
52 * RETURN VALUE
53 * Returns NULL upon failure, non-NULL otherwise.
54 */
55 cu_tail_match_t *tail_match_create(const char *filename);
57 /*
58 * NAME
59 * tail_match_destroy
60 *
61 * DESCRIPTION
62 * Releases resources used by the `cu_tail_match_t' object.
63 *
64 * PARAMETERS
65 * The object to destroy.
66 */
67 void tail_match_destroy(cu_tail_match_t *obj);
69 /*
70 * NAME
71 * tail_match_add_match
72 *
73 * DESCRIPTION
74 * Adds a match, in form of a `cu_match_t' object, to the object.
75 * After data has been read from the logfile (using utils_tail) the callback
76 * function `submit_match' is called with the match object and the user
77 * supplied data.
78 * Please note that his function is called regardless whether this match
79 * matched any lines recently or not.
80 * When `tail_match_destroy' is called the `user_data' pointer is freed using
81 * the `free_user_data' callback - if it is not NULL.
82 * When using this interface the `tail_match' module doesn't dispatch any
83 * values
84 * itself - all that has to happen in either the match-callbacks or the
85 * submit_match callback.
86 *
87 * RETURN VALUE
88 * Zero upon success, non-zero otherwise.
89 */
90 int tail_match_add_match(cu_tail_match_t *obj, cu_match_t *match,
91 int (*submit_match)(cu_match_t *match,
92 void *user_data),
93 void *user_data,
94 void (*free_user_data)(void *user_data));
96 /*
97 * NAME
98 * tail_match_add_match_simple
99 *
100 * DESCRIPTION
101 * A simplified version of `tail_match_add_match'. The regular expressen
102 * `regex'
103 * must match a number, which is then dispatched according to `ds_type'. See
104 * the `match_create_simple' function in utils_match.h for a description how
105 * this flag effects calculation of a new value.
106 * The values gathered are dispatched by the tail_match module in this case.
107 * The
108 * passed `plugin', `plugin_instance', `type', and `type_instance' are
109 * directly used when submitting these values.
110 * With excluderegex it is possible to exlude lines from the match.
111 * The `latency_cfg' specifies configuration for submitting latency.
112 *
113 * RETURN VALUE
114 * Zero upon success, non-zero otherwise.
115 */
116 int tail_match_add_match_simple(cu_tail_match_t *obj, const char *regex,
117 const char *excluderegex, int ds_type,
118 const char *plugin, const char *plugin_instance,
119 const char *type, const char *type_instance,
120 const latency_config_t latency_cfg,
121 const cdtime_t interval);
123 /*
124 * NAME
125 * tail_match_read
126 *
127 * DESCRIPTION
128 * This function should be called periodically by plugins. It reads new lines
129 * from the logfile using `utils_tail' and tries to match them using all
130 * added `utils_match' objects.
131 * After all lines have been read and processed, the submit_match callback is
132 * called or, in case of tail_match_add_match_simple, the data is dispatched
133 * to
134 * the daemon directly.
135 *
136 * RETURN VALUE
137 * Zero on success, nonzero on failure.
138 */
139 int tail_match_read(cu_tail_match_t *obj);