kapacitor-multi-indicator-batch-udf 0.1.0

A multi-indicator batch UDF for Kapacitor
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115

# Kapacitor Multi-Indicator Batch UDF

## Overview

This project implements a User-Defined Function (UDF) for Kapacitor, providing batch processing capabilities for multiple financial indicators. Currently, it supports Exponential Moving Average (EMA) and Simple Moving Average (SMA) calculations and can be easily extended for other indicators.

## Features

- Batch processing of time series data
- Support for multiple indicators (EMA and SMA)
- Unix socket communication with Kapacitor
- Asynchronous processing using async-std
- Configurable options for each indicator

## Requirements

- Rust 1.70 or later
- Kapacitor 1.6 or later

## Installation

1. Clone the repository:

   ```bash
   git clone https://github.com/suitable-name/kapacitor-udf-indicator-batch-rs
   cd kapacitor-multi-indicator-udf
   ```

2. Build / Install the project:

   ```bash
   cargo build --release
   ```

   or

   ```bash
   sudo cargo install --path . --root /usr/local
   ```

## Usage

1. Start the UDF server:

   ```bash
   ./target/release/kapacitor-multi-indicator-udf
   ```

   By default, the server listens on `/tmp/indicator-batch.sock`. You can specify a different socket path using the `-s` or `--socket` option:

   ```bash
   ./target/release/kapacitor-multi-indicator-udf -s /path/to/custom/socket.sock
   ```

2. Configure Kapacitor to use this UDF. Add the following to your Kapacitor configuration file:

   ```toml
   [udfs]
     [udfs.functions]
       [udfs.functions.indicator]
         socket = "/tmp/kapacitor-multi-indicator-udf"
         timeout = "10s"
   ```

3. Use the UDF in your TICKscripts:

   ```bash
    batch
        |query('''
            SELECT "EUR"
            FROM "stocks"."autogen"."ticker_data"
        ''')
            .period(1d)
            // Process one day's worth of data
            .every(1d)
            // Run the batch every day
            .offset(0s)
            // Start from the earliest data available
            .groupBy('ticker')
        @indicators()
            .type('EMA')
            .field('last_price')
            .as('last_price_ema')
            .period(14)
            .ticker_field('ticker')
        |influxDBOut()
            .database('stocks')
            .retentionPolicy('autogen')
            .measurement('Stocks_EMA_batch')
            .tag('kapacitor', 'true')
   ```

## Configuration Options

- `type`: The type of indicator to calculate (`EMA` or `SMA`)
- `period`: The period for the indicator calculation
- `field`: The field name in the incoming data to use for calculations
- `as`: The field name to use for the calculated indicator value in the output
- `ticker_field`: The field name containing the ticker or symbol for the data point

## Development

To run with debug logging:

```bash
RUST_LOG=debug ./target/release/kapacitor-multi-indicator-udf
```

## Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.