No Description

Adam Rutkowski bedc08af91 Bump version 4 years ago
src bedc08af91 Bump version 4 years ago
test 60a6b6c0b0 Remove extraneous ok 4 years ago
.gitignore 5e9035d25c Add metric order 4 years ago
LICENSE 377de8b621 Initial commit 4 years ago
Makefile c948b1edf1 Make sure tests are run against compiled code 4 years ago
README.md 4eb7a4980a Update README.md 4 years ago
rebar.config 8d85016822 Pin latest dlhttpc 4 years ago

README.md

kai

KairosDB Erlang Client

:warning: WIP. Do not use yet.

Roadmap / planned features:

  1. Inserting metrics:

    • pool of raw tcp clients (aka telnet API)
    • schedules ELB-friendly "ping", prevents corporate firewalls from killing idle connections
  2. Retreiving metrics and aggregations:

  3. pre-aggregation facility

  4. benchmarks / load-testing tools

Detailed implementation status

  • [x] Configuration

    • Telnet port
    • Telnet host
    • Pool size
    • Ping interval
    • REST API port
    • REST API host
  • [x] Pool of telnet clients

    • Insert data points
    • Query version
    • Auto-reconnect
      • Proper back-off on connection errors (currently each connection is delayed to prevent reconnections at the same time)
    • ELB friendly keep-alive for erlang node-cassandra
    • ELB friendly keep-alive for kairos-cassandra
  • [ ] REST API (adding data points is not planned, there is no good reason to do it within the scope of this client)

    • custom response wrappers
    • delete data points
    • delete metric
    • list metric names
    • list tag names
    • list tag values
    • [ ] query metrics

      • query builder api - stable (improvements pending)
      • validate input as much as possible
      • aggregates:
        • avg
        • sum
        • dev
        • div
        • histogram
        • least_squares
        • max
        • min
        • rate
      • tags support
      • group_by support
        • tags
        • time
        • value
      • exclude_tags
      • limit
      • order
    • [ ] Pre-aggregation (TBD)

    • [ ] Load-testing / spammers (TBD)

Credits

Authors

Adam Rutkowski hq@mtod.org

Łukasz Biedrycki lukasz.biedrycki@gmail.com

Special thanks

Thanks to Mahesh Paolini-Subramanya and Ubiquiti Networks for letting us making it an open source project.