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