src/daemon/utils_match.h

   1 /**
   2  * collectd - src/utils_match.h
   3  * Copyright (C) 2008-2014  Florian octo Forster
   4  *
   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:
  11  *
  12  * The above copyright notice and this permission notice shall be included in
  13  * all copies or substantial portions of the Software.
  14  *
  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.
  22  *
  23  * Authors:
  24  *   Florian octo Forster <octo at collectd.org>
  25  **/
  26
  27 #ifndef UTILS_MATCH_H
  28 #define UTILS_MATCH_H 1
  29
  30 #include "plugin.h"
  31
  32 /*
  33  * Each type may have 12 sub-types
  34  * 0x1000 = 1000000000000
  35  *          ^             <- Type bit
  36  *           ^^^^^^^^^^^^ <- Subtype bits
  37  */
  38 #define UTILS_MATCH_DS_TYPE_GAUGE 0x1000
  39 #define UTILS_MATCH_DS_TYPE_COUNTER 0x2000
  40 #define UTILS_MATCH_DS_TYPE_DERIVE 0x4000
  41 #define UTILS_MATCH_DS_TYPE_ABSOLUTE 0x8000
  42
  43 #define UTILS_MATCH_CF_GAUGE_AVERAGE 0x01
  44 #define UTILS_MATCH_CF_GAUGE_MIN 0x02
  45 #define UTILS_MATCH_CF_GAUGE_MAX 0x04
  46 #define UTILS_MATCH_CF_GAUGE_LAST 0x08
  47 #define UTILS_MATCH_CF_GAUGE_INC 0x10
  48 #define UTILS_MATCH_CF_GAUGE_ADD 0x20
  49
  50 #define UTILS_MATCH_CF_COUNTER_SET 0x01
  51 #define UTILS_MATCH_CF_COUNTER_ADD 0x02
  52 #define UTILS_MATCH_CF_COUNTER_INC 0x04
  53
  54 #define UTILS_MATCH_CF_DERIVE_SET 0x01
  55 #define UTILS_MATCH_CF_DERIVE_ADD 0x02
  56 #define UTILS_MATCH_CF_DERIVE_INC 0x04
  57
  58 #define UTILS_MATCH_CF_ABSOLUTE_SET 0x01
  59 #define UTILS_MATCH_CF_ABSOLUTE_ADD 0x02
  60 #define UTILS_MATCH_CF_ABSOLUTE_INC 0x04
  61
  62 /*
  63  * Data types
  64  */
  65 struct cu_match_s;
  66 typedef struct cu_match_s cu_match_t;
  67
  68 struct cu_match_value_s {
  69   int ds_type;
  70   value_t value;
  71   unsigned int values_num;
  72 };
  73 typedef struct cu_match_value_s cu_match_value_t;
  74
  75 /*
  76  * Prototypes
  77  */
  78 /*
  79  * NAME
  80  *  match_create_callback
  81  *
  82  * DESCRIPTION
  83  *  Creates a new `cu_match_t' object which will use the regular expression
  84  *  `regex' to match lines, see the `match_apply' method below. If the line
  85  *  matches, the callback passed in `callback' will be called along with the
  86  *  pointer `user_pointer'.
  87  *  The string that's passed to the callback depends on the regular expression:
  88  *  If the regular expression includes a sub-match, i. e. something like
  89  *    "value=([0-9][0-9]*)"
  90  *  then only the submatch (the part in the parenthesis) will be passed to the
  91  *  callback. If there is no submatch, then the entire string is passed to the
  92  *  callback.
  93  *  The optional `excluderegex' allows to exclude the line from the match, if
  94  *  the excluderegex matches.
  95  */
  96 cu_match_t *
  97 match_create_callback(const char *regex, const char *excluderegex,
  98                       int (*callback)(const char *str, char *const *matches,
  99                                       size_t matches_num, void *user_data),
 100                       void *user_data);
 101
 102 /*
 103  * NAME
 104  *  match_create_simple
 105  *
 106  * DESCRIPTION
 107  *  Creates a new `cu_match_t' with a default callback. The user data for that
 108  *  default callback will be a `cu_match_value_t' structure, with
 109  *  `ds_type' copied to the structure. The default callback will handle the
 110  *  string as containing a number (see strtoll(3) and strtod(3)) and store that
 111  *  number in the `value' member. How that is done depends on `ds_type':
 112  *
 113  *  UTILS_MATCH_DS_TYPE_GAUGE
 114  *    The function will search for a floating point number in the string and
 115  *    store it in value.gauge.
 116  *  UTILS_MATCH_DS_TYPE_COUNTER_SET
 117  *    The function will search for an integer in the string and store it in
 118  *    value.counter.
 119  *  UTILS_MATCH_DS_TYPE_COUNTER_ADD
 120  *    The function will search for an integer in the string and add it to the
 121  *    value in value.counter.
 122  *  UTILS_MATCH_DS_TYPE_COUNTER_INC
 123  *    The function will not search for anything in the string and increase
 124  *    value.counter by one.
 125  */
 126 cu_match_t *match_create_simple(const char *regex, const char *excluderegex,
 127                                 int ds_type);
 128
 129 /*
 130  * NAME
 131  *  match_value_reset
 132  *
 133  * DESCRIPTION
 134  *   Resets the internal state, if applicable. This function must be called
 135  *   after each iteration for "simple" matches, usually after dispatching the
 136  *   metrics.
 137  */
 138 void match_value_reset(cu_match_value_t *mv);
 139
 140 /*
 141  * NAME
 142  *  match_destroy
 143  *
 144  * DESCRIPTION
 145  *  Destroys the object and frees all internal resources.
 146  */
 147 void match_destroy(cu_match_t *obj);
 148
 149 /*
 150  * NAME
 151  *  match_apply
 152  *
 153  * DESCRIPTION
 154  *  Tries to match the string `str' with the regular expression of `obj'. If
 155  *  the string matches, calls the callback in `obj' with the (sub-)match.
 156  *
 157  *  The user_data pointer passed to `match_create_callback' is NOT freed
 158  *  automatically. The `cu_match_value_t' structure allocated by
 159  *  `match_create_callback' is freed automatically.
 160  */
 161 int match_apply(cu_match_t *obj, const char *str);
 162
 163 /*
 164  * NAME
 165  *  match_get_user_data
 166  *
 167  * DESCRIPTION
 168  *  Returns the pointer passed to `match_create_callback' or a pointer to the
 169  *  `cu_match_value_t' structure allocated by `match_create_simple'.
 170  */
 171 void *match_get_user_data(cu_match_t *obj);
 172
 173 #endif /* UTILS_MATCH_H */
 174
 175 /* vim: set sw=2 sts=2 ts=8 : */