proto/collectd.proto: Improve documentation.
[collectd.git] / src / utils_rrdcreate.h
1 /**
2  * collectd - src/utils_rrdcreate.h
3  * Copyright (C) 2008-2013  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_RRDCREATE_H
28 #define UTILS_RRDCREATE_H 1
29
30 #include "plugin.h"
31
32 #include <stddef.h>
33
34 struct rrdcreate_config_s
35 {
36   unsigned long stepsize;
37   int    heartbeat;
38   int    rrarows;
39   double xff;
40
41   int *timespans;
42   size_t timespans_num;
43
44   char **consolidation_functions;
45   size_t consolidation_functions_num;
46
47   _Bool async;
48 };
49 typedef struct rrdcreate_config_s rrdcreate_config_t;
50
51 int cu_rrd_create_file (const char *filename,
52     const data_set_t *ds, const value_list_t *vl,
53     const rrdcreate_config_t *cfg);
54
55 #endif /* UTILS_RRDCREATE_H */
56
57 /* vim: set sw=2 sts=2 et : */