disthene: cassandra backed metric storage writer

This repository is a fork of disthene with support of AWS Opensearch instead of Elasticsearch.

Compiling

This is a standard Java Maven project.

mvn package

will most probably do the trick.

Running

First of all, it's strongly recommended to run it with Java 8. Even though this software is fully compatible with Java 7. The main reason for that is a bug in Java (JDK-7032154) prior to version 8 Moreover, it's strongly recommended to have some GC tuning. For a start here is a set of some universal options:

• -XX:+UseConcMarkSweepGC
• -XX:+CMSParallelRemarkEnabled
• -XX:+UseCMSInitiatingOccupancyOnly
• -XX:CMSInitiatingOccupancyFraction=75
• -XX:+ScavengeBeforeFullGC
• -XX:+CMSScavengeBeforeRemark
• -XX:+UseParallelGC

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

• Cassandra (4.x)
• Opensearch (2.x) (maybe Elasticsearch)

Cassandra schema:

CREATE TABLE metric (
  period int,
  rollup int,
  tenant text,
  path text,
  time bigint,
  data list<double>,
  PRIMARY KEY ((tenant, period, rollup, path), time)
) WITH
  bloom_filter_fp_chance=0.010000 AND
  caching='KEYS_ONLY' AND
  comment='' AND
  dclocal_read_repair_chance=0.000000 AND
  gc_grace_seconds=864000 AND
  index_interval=128 AND
  read_repair_chance=0.100000 AND
  replicate_on_write='true' AND
  populate_io_cache_on_flush='false' AND
  default_time_to_live=0 AND
  speculative_retry='NONE' AND
  memtable_flush_period_in_ms=0 AND
  compaction={'class': 'SizeTieredCompactionStrategy'} AND
  compression={'sstable_compression': 'LZ4Compressor'};

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'};

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/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
# also aggregate the first rollup
  aggregateBaseRollup: false
store:
# C* contact points, port, keyspace and table
  cluster:
    - "cassandra-1"
    - "cassandra-2"
  port: 9042
  keyspace: 'metric'
  columnFamily: '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 cluster name, contact points, native port, index name & type
  name: "disthene"
  cluster:
    - "es-1"
    - "es-2"
  port: 9300
  index: "disthene"
  type: "path"
# 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"
# hostname to use
  hostname: "disthene-1a"
# 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)

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) 2015 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.