Skip to content
Randgalt edited this page Mar 1, 2013 · 11 revisions

Curator

What is Curator?

Curator n ˈkyoor͝ˌātər: a keeper or custodian of a museum or other collection – A ZooKeeper Keeper.

Curator is a set of Java libraries that make using Apache ZooKeeper much easier. While ZooKeeper comes bundled with a Java client, using the client is non-trivial and error prone.

Getting Started

See the page for quick start: Getting Started.

FAQ

Please see the FAQ page.

Components

Client A replacement for the bundled ZooKeeper class that takes care of some low-level housekeeping and provides some useful utilities.
Framework The Curator Framework is a high-level API that greatly simplifies using ZooKeeper. It adds many features that build on ZooKeeper and handles the complexity of managing connections to the ZooKeeper cluster and retrying operations.
Recipes Implementations of some of the common ZooKeeper “recipes”. The implementations are built on top of the Curator Framework.
Utilities Various utilities that are useful when using ZooKeeper.
Errors How Curator deals with errors, connection issues, recoverable exceptions, etc.
Extensions Optional/extension recipes for vertical uses.

Logging and Tracing

Curator is logging and tracing neutral. The Curator code is instrumented with logging and tracers but uses a driver mechanism that allows easy integration into your preferred logging and tracing frameworks. See details here: Logging and Tracing.

Maven / Artifacts

Curator binaries are published to Maven Central. Curator consists of several artifacts. Which artifacts to use depends on your needs. For most users, the only artifact you need is curator-recipes.

GroupID/Org ArtifactID/Name Description
com.netflix.curator curator-recipes All of the recipes. Note: this artifact has dependencies on client and framework and, so, Maven (or whatever tool you’re using) should pull those in automatically.
com.netflix.curator curator-framework The Curator Framework high level API. This is built on top of the client and should pull it in automatically.
com.netflix.curator curator-client The Curator Client – replacement for the ZooKeeper class in the ZK distribution.
com.netflix.curator curator-test Contains the TestingServer, the TestingCluster and a few other tools useful for testing.
com.netflix.curator curator-x-discovery A Service Discovery implementation built on the Curator Framework.
com.netflix.curator curator-x-discovery-server A RESTful server that can be used with Curator Discovery.
com.netflix.curator curator-x-zkclient-bridge A bridge between Curator and ZKClient.
Clone this wiki locally