Skip to content
Branch: master
Find file History
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
..
Failed to load latest commit information.
examples/watcher
lib/elasticsearch
spec
test
.gitignore
Gemfile
LICENSE.txt
README.md
Rakefile
elasticsearch-xpack.gemspec

README.md

Elasticsearch::XPack

A Ruby integration for the X-Pack extension for Elasticsearch.

Installation

Install the package from Rubygems:

gem install elasticsearch-xpack

To use an unreleased version, either add it to your Gemfile for Bundler:

gem 'elasticsearch-xpack', git: 'https://github.com/elastic/elasticsearch-ruby.git'

Usage

If you use the official Ruby client for Elasticsearch, require the library in your code, and all the methods will be automatically available in the xpack namespace:

require 'elasticsearch'
require 'elasticsearch/xpack'

client = Elasticsearch::Client.new url: 'http://elastic:changeme@localhost:9200'

client.xpack.info
# => {"build"=> ..., "features"=> ...}

The integration is designed as a standalone Elasticsearch::XPack::API module, so it's easy to mix it into a different client, and the methods will be available in the top namespace.

For documentation, look into the RDoc annotations in the source files, which contain links to the official X-Pack for the Elastic Stack documentation.

For examples, look into the examples folder in this repository.

You can use the provided test:elasticsearch Rake task to launch a Docker-based Elasticsearch node with the full X-Pack license preinstalled.

License

This software is licensed under the Apache 2 license.

You can’t perform that action at this time.