Skip to content
Go to file

Latest commit


Git stats


Failed to load latest commit information.
Latest commit message
Commit time

Gem Version Build Status Codacy Badge


DruidConfig is a gem to access the information about Druid cluster status. You can check a node capacity, number of segments, tiers... It uses zookeeper to get coordinator and overlord URIs.

To use in your application, add this line to your Gemfile:

gem 'druid_config'

Query Druid data

The purpose of this gem is to query Druid cluster status. If you want to query Druid data, I recommend you to use ruby-druid gem.


Cluster is the base class to perform queries. To initialize it send the Zookeeper URI and options as arguments:

cluster =, options)

Available options:

  • discovery_path: string with the discovery path of druid inside Zookeeper directory structure.


Call methods defined in DruidConfig::Cluster to access to the data. To get more information about data returned in methods, check Druid documentation.

  • leader: leader
  • load_status: load status
  • load_status: load queue
  • metadata_datasources: Hash with metadata of datasources
  • metadata_datasources_segments: Hash with metadata of segments
  • datasources: all data sources
  • datasource: a concrete data source
  • rules: all rules defined in the cluster
  • tiers: tiers
  • servers or nodes: all nodes of the cluster
  • physical_servers or physical_nodes: array of URIs of nodes
  • historicals: historical nodes
  • realtimes: realtime nodes
  • workers: worker nodes
  • physical_workers: array of URIs of worker nodes
  • running_tasks, pending_tasks, waiting_tasks, complete_tasks: tasks in the cluster based in their status
  • task: load a task based on an identifier
  • services: Hash with physical nodes and the services they are running


Some methods return an instance of an Entity class. These entities provide multiple methods to access data. Defined entities are inside druid_config/entities folder.



This exception will be raised when you try to perform a query to a Druid Coordinator or Overlord but there aren't any node of that type available.


Sometimes the Gem have available nodes, but it can't access to Druid API. In this case, the gem automatically will reset the Zookeeper connection and retry the query. If second query fails too, a DruidConfig::Exceptions::DruidApiError exception will be raised.


To contribute DruidConfig:

  • Create an issue with the contribution: bug, enhancement or feature
  • Fork the repository and make all changes you need
  • Write test on new changes
  • Create a pull request when you finish


DruidConfig gem is released under the Affero GPL license. Copyright redBorder


A Ruby gem to access the information about Druid cluster status




No packages published


You can’t perform that action at this time.