Skip to content

Latest commit

 

History

History
173 lines (140 loc) · 6.77 KB

README.md

File metadata and controls

173 lines (140 loc) · 6.77 KB
Raw

disthene: cassandra backed metric storage writer

This project is inspired by cyanite and is intended to replace it in write mode only (thus transiently replacing Graphite). It must be fully compatible with cyanite and cyanite can still be used for reading. I've started another project which will do the reads: disthene-reader. And, yes, I'm convinced that in a large scale setup (and that's why I started disthene project) it's best to separate these two roles.

Motivation

There are a couple of things which seem to be an absolute must and which were missing in cyanite:

  • aggregation: ability to sum similar metrics from several servers
  • blacklisting: ability to omit storing metrics which match a certain pattern. Makes not much sense by itself but is quite handy when you have previous item
  • caching incoming paths: this may really reduce the load on Elasticsearch cluster
  • some minimal set of own metrics (received count, write count, etc.)
  • true multitenancy

The other thing is performance. Disthene is being developed with one major requirement in mind - performance. Essentially, in most cases the only bottleneck will be C*. There is no ultimate benchmark here (mostly because of the C* bottleneck in test lab) but it looks like something like 1M data points/core/minute should not be a problem

(Here is a quick performance comparison)

Compiling

This is a standard Java Maven project.

mvn package

will most probably do the trick.

Running

Disthene is intended to be compiled and run with Java 11.

There are a couple of things you will need in runtime, just the same set as for cyanite

  • Cassandra (tested with 4.0)
  • Elasticsearch (tested with 7.13.4)

Disthene will automatically create C* tables for each tenant and rollup. Keyspace is configured in disthene.yaml. Also, table options can be modified using tableCreateTemplate configuration option.

Your mileage may vary but generally (as graphite like systems are closer to write only/read never type) one would benefit from changing

  compression={'sstable_compression': 'LZ4Compressor'};

to

  compression={'sstable_compression': 'DeflateCompressor'};

or to

  compression={'sstable_compression': 'ZstdCompressor'};

This will probably save ~25% on disk storage and quite some IO on reads at the cost of slightly increased CPU.

Configuration

There several configuration files involved

  • /etc/disthene/disthene.yaml (location can be changed with -c command line option if needed)
  • /etc/disthene/disthene-log4j.xml (location can be changed with -l command line option if needed)
  • /etc/disthene/blacklist.yaml (location can be changed with -b command line option if needed)
  • /etc/disthene/whitelist.yaml (location can be changed with -w command line option if needed)
  • /etc/disthene/aggregator.yaml (location can be changed with -a command line option if needed)
Main configuration in disthene.yaml
carbon:
# bind address and port
  bind: "127.0.0.0"
  port: 2003
# rollups - currently only "s" units supported  
  rollups:
    - 60s:5356800s
    - 900s:62208000s
# seconds to wait before flushing aggregated metrics   
  aggregatorDelay: 90
store:
# C* contact points, port, keyspace and table
  cluster:
    - "cassandra-1"
    - "cassandra-2"
  port: 9042
  keyspace: 'metric'
# maximum connections per host , timeouts in seconds, max requests per host - these are literally used in C* java driver settings
  maxConnections: 2048
  readTimeout: 10
  connectTimeout: 10
  maxRequests: 128
# use C* batch statetments - the trade off is: using batch puts load on C*, not using it may cause congestion on disthene side
  batch: true
# batch size if above is true
  batchSize: 500
# number of threads submitting requests to C*  
  pool: 2
index:
# ES contact points, native port, index name & type
  cluster:
    - "es-1"
    - "es-2"
  port: 9300
  index: "disthene"
# cache paths on disthene side?
  cache: true
# if cached is used, expire it after seconds below. That is, if we haven't seen metric name on 'expire' seconds - remove it from cache
  expire: 3600
# when to flush bulk - either when incoming queue reaches 'actions' size or every 'interval' seconds
  bulk:
    actions: 10000
    interval: 5
stats:
# flush self metrics every 'interval' seconds
  interval: 60
# tenant to use for stats
  tenant: "test"
# (optional) hostname to use if not specified system's hostname will be used
  hostname: "disthene-1a"
# (optional) path prefix for stats metrics, default to ""
  pathPrefix: ""
# output stats to log as well
  log: true
Logging configuration in disthene-log4j.xml

Configuration is straight forward as per log4j

Blacklist configuration in blacklist.yaml

This is a list of regular expressions per tenant. Matching metrics will NOT be store, but they still WILL be aggregated (see below)

Whitelist configuration in whitelist.yaml

This is a list of regular expressions per tenant. Matching metrics will override blacklist rules.

Aggregation configuration in aggregator.yaml

List of aggregation rules per tenant. By exmaple:

"xxx_test_server*.<data>": "xxx_sum.<data>"

means that disthene will sum all the values matching 'xxx_test_server*.' (where is a placeholder for deeper path) and put the value into 'xxx_sum.'

Thanks

Thanks go to Pierre-Yves Ritschard https://github.com/pyr, Bruno Renié (https://github.com/brutasse) - this project is useless without their work on cyanite, graphite-api, graphite-cyanite

License

The MIT License (MIT)

Copyright (C) 2021 Andrei Ivanov

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.