1 /**
2 * collectd - src/utils_latency.h
3 * Copyright (C) 2013 Florian 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 Forster <ff at octo.it>
25 **/
27 #include "collectd.h"
29 #include "utils_time.h"
31 #ifndef HISTOGRAM_NUM_BINS
32 # define HISTOGRAM_NUM_BINS 1000
33 #endif
35 struct latency_counter_s;
36 typedef struct latency_counter_s latency_counter_t;
38 latency_counter_t *latency_counter_create (void);
39 void latency_counter_destroy (latency_counter_t *lc);
41 void latency_counter_add (latency_counter_t *lc, cdtime_t latency);
42 void latency_counter_reset (latency_counter_t *lc);
44 cdtime_t latency_counter_get_min (latency_counter_t *lc);
45 cdtime_t latency_counter_get_max (latency_counter_t *lc);
46 cdtime_t latency_counter_get_sum (latency_counter_t *lc);
47 size_t latency_counter_get_num (latency_counter_t *lc);
48 cdtime_t latency_counter_get_average (latency_counter_t *lc);
49 cdtime_t latency_counter_get_percentile (latency_counter_t *lc,
50 double percent);
52 /*
53 * NAME
54 * latency_counter_get_rate(counter,lower,upper,now)
55 *
56 * DESCRIPTION
57 * Calculates rate of latency values fall within requested interval.
58 * Interval specified as (lower,upper], i.e. the lower boundary is exclusive,
59 * the upper boundary is inclusive.
60 * When lower is zero, then the interval is (0, upper].
61 * When upper is zero, then the interval is (lower, infinity).
62 */
63 double latency_counter_get_rate (const latency_counter_t *lc,
64 cdtime_t lower, cdtime_t upper, const cdtime_t now);
66 /* vim: set sw=2 sts=2 et : */