2 * collectd - src/utils_match.h
3 * Copyright (C) 2008-2014 Florian octo Forster
5 * Permission is hereby granted, free of charge, to any person obtaining a
6 * copy of this software and associated documentation files (the "Software"),
7 * to deal in the Software without restriction, including without limitation
8 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
9 * and/or sell copies of the Software, and to permit persons to whom the
10 * Software is furnished to do so, subject to the following conditions:
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
21 * DEALINGS IN THE SOFTWARE.
24 * Florian octo Forster <octo at collectd.org>
28 #define UTILS_MATCH_H 1
31 #include "utils_latency.h"
32 #include "utils_latency_config.h"
35 * Each type may have 12 sub-types
36 * 0x1000 = 1000000000000
38 * ^^^^^^^^^^^^ <- Subtype bits
40 #define UTILS_MATCH_DS_TYPE_GAUGE 0x1000
41 #define UTILS_MATCH_DS_TYPE_COUNTER 0x2000
42 #define UTILS_MATCH_DS_TYPE_DERIVE 0x4000
43 #define UTILS_MATCH_DS_TYPE_ABSOLUTE 0x8000
45 #define UTILS_MATCH_CF_GAUGE_AVERAGE 0x01
46 #define UTILS_MATCH_CF_GAUGE_MIN 0x02
47 #define UTILS_MATCH_CF_GAUGE_MAX 0x04
48 #define UTILS_MATCH_CF_GAUGE_LAST 0x08
49 #define UTILS_MATCH_CF_GAUGE_INC 0x10
50 #define UTILS_MATCH_CF_GAUGE_ADD 0x20
51 #define UTILS_MATCH_CF_GAUGE_PERSIST 0x40
52 #define UTILS_MATCH_CF_GAUGE_LATENCY 0x80
54 #define UTILS_MATCH_CF_COUNTER_SET 0x01
55 #define UTILS_MATCH_CF_COUNTER_ADD 0x02
56 #define UTILS_MATCH_CF_COUNTER_INC 0x04
58 #define UTILS_MATCH_CF_DERIVE_SET 0x01
59 #define UTILS_MATCH_CF_DERIVE_ADD 0x02
60 #define UTILS_MATCH_CF_DERIVE_INC 0x04
62 #define UTILS_MATCH_CF_ABSOLUTE_SET 0x01
63 #define UTILS_MATCH_CF_ABSOLUTE_ADD 0x02
64 #define UTILS_MATCH_CF_ABSOLUTE_INC 0x04
70 typedef struct cu_match_s cu_match_t;
72 struct cu_match_value_s
76 unsigned int values_num;
77 latency_counter_t *latency;
79 typedef struct cu_match_value_s cu_match_value_t;
86 * match_create_callback
89 * Creates a new `cu_match_t' object which will use the regular expression
90 * `regex' to match lines, see the `match_apply' method below. If the line
91 * matches, the callback passed in `callback' will be called along with the
92 * pointer `user_pointer'.
93 * The string that's passed to the callback depends on the regular expression:
94 * If the regular expression includes a sub-match, i. e. something like
95 * "value=([0-9][0-9]*)"
96 * then only the submatch (the part in the parenthesis) will be passed to the
97 * callback. If there is no submatch, then the entire string is passed to the
99 * The optional `excluderegex' allows to exclude the line from the match, if
100 * the excluderegex matches.
101 * When `match_destroy' is called the `user_data' pointer is freed using
102 * the `free_user_data' callback - if it is not NULL.
104 cu_match_t *match_create_callback (const char *regex, const char *excluderegex,
105 int (*callback) (const char *str,
106 char * const *matches, size_t matches_num, void *user_data),
107 void *user_data, void (*free_user_data) (void *user_data));
111 * match_create_simple
114 * Creates a new `cu_match_t' with a default callback. The user data for that
115 * default callback will be a `cu_match_value_t' structure, with
116 * `ds_type' copied to the structure. The default callback will handle the
117 * string as containing a number (see strtoll(3) and strtod(3)) and store that
118 * number in the `value' member. How that is done depends on `ds_type':
120 * UTILS_MATCH_DS_TYPE_GAUGE
121 * The function will search for a floating point number in the string and
122 * store it in value.gauge.
123 * UTILS_MATCH_DS_TYPE_COUNTER_SET
124 * The function will search for an integer in the string and store it in
126 * UTILS_MATCH_DS_TYPE_COUNTER_ADD
127 * The function will search for an integer in the string and add it to the
128 * value in value.counter.
129 * UTILS_MATCH_DS_TYPE_COUNTER_INC
130 * The function will not search for anything in the string and increase
131 * value.counter by one.
133 cu_match_t *match_create_simple (const char *regex,
134 const char *excluderegex, int ds_type);
141 * Resets the internal state, if applicable. This function must be called
142 * after each iteration for "simple" matches, usually after dispatching the
145 void match_value_reset (cu_match_value_t *mv);
152 * Destroys the object and frees all internal resources.
154 void match_destroy (cu_match_t *obj);
161 * Tries to match the string `str' with the regular expression of `obj'. If
162 * the string matches, calls the callback in `obj' with the (sub-)match.
164 * The user_data pointer passed to `match_create_callback' is NOT freed
165 * automatically. The `cu_match_value_t' structure allocated by
166 * `match_create_callback' is freed automatically.
168 int match_apply (cu_match_t *obj, const char *str);
172 * match_get_user_data
175 * Returns the pointer passed to `match_create_callback' or a pointer to the
176 * `cu_match_value_t' structure allocated by `match_create_simple'.
178 void *match_get_user_data (cu_match_t *obj);
180 #endif /* UTILS_MATCH_H */
182 /* vim: set sw=2 sts=2 ts=8 : */