2 * collectd - src/utils_tail_match.h
3 * Copyright (C) 2007-2008 C-Ware, Inc.
4 * Copyright (C) 2008 Florian Forster
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:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
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.
25 * Luke Heberling <lukeh at c-ware.com>
26 * Florian Forster <octo at collectd.org>
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.
36 #include "utils_match.h"
38 struct cu_tail_match_s;
39 typedef struct cu_tail_match_s cu_tail_match_t;
46 * Allocates, initializes and returns a new `cu_tail_match_t' object.
49 * `filename' The name to read data from.
52 * Returns NULL upon failure, non-NULL otherwise.
54 cu_tail_match_t *tail_match_create (const char *filename);
61 * Releases resources used by the `cu_tail_match_t' object.
64 * The object to destroy.
66 void tail_match_destroy (cu_tail_match_t *obj);
70 * tail_match_add_match
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
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 values
82 * itself - all that has to happen in either the match-callbacks or the
83 * submit_match callback.
86 * Zero upon success, non-zero otherwise.
88 int tail_match_add_match (cu_tail_match_t *obj, cu_match_t *match,
89 int (*submit_match) (cu_match_t *match, void *user_data),
91 void (*free_user_data) (void *user_data));
95 * tail_match_add_match_simple
98 * A simplified version of `tail_match_add_match'. The regular expressen `regex'
99 * must match a number, which is then dispatched according to `ds_type'. See
100 * the `match_create_simple' function in utils_match.h for a description how
101 * this flag effects calculation of a new value.
102 * The values gathered are dispatched by the tail_match module in this case. The
103 * passed `plugin', `plugin_instance', `type', and `type_instance' are
104 * directly used when submitting these values.
105 * With excluderegex it is possible to exlude lines from the match.
108 * Zero upon success, non-zero otherwise.
110 int tail_match_add_match_simple (cu_tail_match_t *obj,
111 const char *regex, const char *excluderegex, int ds_type,
112 const char *plugin, const char *plugin_instance,
113 const char *type, const char *type_instance, const cdtime_t interval);
120 * This function should be called periodically by plugins. It reads new lines
121 * from the logfile using `utils_tail' and tries to match them using all
122 * added `utils_match' objects.
123 * After all lines have been read and processed, the submit_match callback is
124 * called or, in case of tail_match_add_match_simple, the data is dispatched to
125 * the daemon directly.
128 * Zero on success, nonzero on failure.
130 int tail_match_read (cu_tail_match_t *obj);
132 /* vim: set sw=2 sts=2 ts=8 : */