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