/norconex-committer-elasticsearch-rest

:warning: DEPRECATED in favor of https://www.norconex.com/collectors/committer-elasticsearch/releases#a4.0.0-SNAPSHOT. (WAS: An elasticsearch committer for http://www.norconex.com/collectors/collector-http that uses elasticsearches REST interface [via Jest].)

Primary LanguageJava

ElasticSearch Committer (REST interface)

⚠️ Deprecation notice

Starting with version 4.0, the upstream Norconex/committer-elasticsearch has switched to using the Elasticsearch REST interface as well; rendering this committer obsolete. I continue accepting bug fixes but would suggest users eventually migrate to https://www.norconex.com/collectors/committer-elasticsearch which is already more feature-complete and which I expect to continue being better maintained. (This repository will remain online indefinitely as an archive.)

Introduction

Elasticsearch implementation of Norconex Committer using the Elasticsearch REST interface.

This is an alternative implementation of Norconex/committer-elasticsearch (http://www.norconex.com/collectors/committer-elasticsearch) which uses the Elasticsearch Node client instead.

The benefits of the REST interface are i.a. native support of drop-in HTTP proxies and caches, as well as the option to use HTTPS encryptio and/or HTTP authentication.

This committer uses the Jest library as the Elasticsearch client.

Status

Though we are using this library in production, it is not currently tested by an automated test suite. Proceed with caution!

This project is not currently deployed to any central repository. You must build it manually. Nor does a hosted documentation exist (other than this README).

Usage / Configuration

The configuration is analogous to http://www.norconex.com/collectors/committer-elasticsearch/configuration except that instead of the optional <clusterName>, you must provide a required <serverUrl>.

This URL must point to an elasticsearch REST interface and may either use the http or https schema and may optionally include HTTP authentication information. E.g., the following configuration would initiate an encrypted connection to an ES instance at search.example.com authenticating as user user with password password:

<committer
  class="com.norconex.committer.elasticsearch_rest.ElasticsearchCommitter"
>
  <indexName>crawler_index</indexName>
  <serverUrl>https://user:password@search.example.com:9200</serverUrl>
  <typeName>crawler_type</typeName>
</committer>