https://github.com/dropwizard/dropwizard-elasticsearch

A set of classes for using Elasticsearch in a Dropwizard service.
https://github.com/dropwizard/dropwizard-elasticsearch

dropwizard elasticsearch

Last synced: 3 months ago
JSON representation

A set of classes for using Elasticsearch in a Dropwizard service.

• Host: GitHub
• URL: https://github.com/dropwizard/dropwizard-elasticsearch
• Owner: dropwizard
• License: apache-2.0
• Archived: true
• Created: 2013-08-12T22:46:20.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2022-11-18T12:08:00.000Z (almost 2 years ago)
• Last Synced: 2024-05-09T16:37:45.592Z (6 months ago)
• Topics: dropwizard, elasticsearch
• Language: Java
• Homepage: http://dropwizard.github.io/dropwizard-elasticsearch/
• Size: 1.32 MB
• Stars: 59
• Watchers: 12
• Forks: 43
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-dropwizard - dropwizard-elasticsearch - A set of classes for using Elasticsearch in a Dropwizard service (Open Source / Data Stores)

README

        
Dropwizard Elasticsearch

========================

[![Build Status](https://travis-ci.org/dropwizard/dropwizard-elasticsearch.svg?branch=master)](https://travis-ci.org/dropwizard/dropwizard-elasticsearch)

[![Coverage Status](https://img.shields.io/coveralls/dropwizard/dropwizard-elasticsearch.svg)](https://coveralls.io/r/dropwizard/dropwizard-elasticsearch)

[![Maven Central](https://img.shields.io/maven-central/v/io.dropwizard.modules/dropwizard-elasticsearch.svg)](http://mvnrepository.com/artifact/io.dropwizard.modules/dropwizard-elasticsearch)

A set of classes for using [Elasticsearch][1] (version 2.3.0 and higher) in a [Dropwizard][2] application.

The package provides a [lifecycle-managed][3] client class (`ManagedEsClient`), a configuration class with the most

common options (`EsConfiguration`), and some [health checks][4] which can instantly be used in any Dropwizard application.

[1]: http://www.elasticsearch.org/

[2]: http://dropwizard.io/1.2.0/docs

[3]: http://dropwizard.io/1.2.0/docs/manual/core.html#managed-objects

[4]: http://dropwizard.io/1.2.0/docs/manual/core.html#health-checks

Usage

-----

Just add `EsConfiguration` to your [Configuration](http://dropwizard.io/1.2.0/docs/manual/core.html#configuration) class and

create an `ManagedEsClient` instance in the run method of your service.

You can also add one of the existing health checks to your [Environment](http://dropwizard.io/1.2.0/docs/manual/core.html#environments)

in the same method. At least the usage of `EsClusterHealthCheck` is strongly advised.

```java

public class DemoApplication extends Application {

    // [...]

    @Override

    public void run(DemoConfiguration config, Environment environment) {

        final ManagedEsClient managedClient = new ManagedEsClient(configuration.getEsConfiguration());

        environment.lifecycle().manage(managedClient);

        environment.healthChecks().register("ES cluster health", new EsClusterHealthCheck(managedClient.getClient()));

        // [...]

    }

}

```

Configuration

-------------

The following configuration settings are supported by `EsConfiguration`:

* `nodeClient`: When `true`, `ManagedEsClient` will create a `NodeClient`, otherwise a `TransportClient`; default: `true`

* `servers`: A list of servers for usage with the created TransportClient if `nodeClient` is `false`

* `clusterName`: The name of the Elasticsearch cluster; default: "elasticsearch"

* `settings`: Any additional settings for Elasticsearch, see [Configuration](https://www.elastic.co/guide/en/elasticsearch/reference/2.4/setup-configuration.html)

* `settingsFile`: Any additional settings file for Elasticsearch, see [Configuration](https://www.elastic.co/guide/en/elasticsearch/reference/2.4/setup-configuration.html)

An example configuration file for creating a Node Client could like this:

```yaml

clusterName: MyClusterName

settings:

  node.name: MyCustomNodeName

```

The order of precedence is: `nodeClient`/`servers`/`clusterName` > `settings` > `settingsFile`, meaning that

any setting in `settingsFile` can be overwritten with `settings` which in turn get overwritten by the specific settings

like `clusterName`.

Maven Artifacts

---------------

This project is available on Maven Central. To add it to your project simply add the following dependencies to your

`pom.xml`:

```xml

  io.dropwizard.modules

  dropwizard-elasticsearch

  1.2.0-1

```

Support

-------

Please file bug reports and feature requests in [GitHub issues](https://github.com/dropwizard/dropwizard-elasticsearch/issues).

Acknowledgements

----------------

Thanks to Alexander Reelsen (@spinscale) for his [Dropwizard Blog Sample](https://github.com/spinscale/dropwizard-blog-sample)

which sparked the idea for this project.

License

-------

Copyright (c) 2013-2017 Jochen Schalanda

This library is licensed under the Apache License, Version 2.0.

See http://www.apache.org/licenses/LICENSE-2.0.html or the LICENSE file in this repository for the full license text.