Elasticsearch

improve this page | report issue

Overview

IBM MobileFirst Foundation Operational Analytics uses Elasticsearch 1.7.5 for storing data and running search queries.

Elasticsearch is a real-time distributed search and analytics engine that increases the speed and scale rates for data storage and exploration. Elasticsearch is used for full-text search, structured search.

Elasticsearch is used for storing all mobile and server data in JSON format in the Elasticsearch instances on the MobileFirst Analytics Server.

The Elasticsearch instances are queried in real-time to populate the IBM MobileFirst Analytics Console.

MobileFirst Analytics exposes all Elasticsearch functionality. The user is able to take full advantage of Elasticsearch queries, debugging, and optimization.

For more information about Elasticsearch functionality, beyond the functionality described here, see the Elasticsearch documentation.

Managing Elasticsearch on the MobileFirst Analytics Server

Elasticsearch is embedded in the MobileFirst Analytics Server and participates in the node and cluster behavior.

For more information on configuring Elasticsearch on the Analytics Server, see Cluster management and Elasticsearch in the MobileFirst Analytics Server Configuration Guide topic.

Elasticsearch properties

Elasticsearch properties are available through JNDI variables or environment entries.
One of the more useful JNDI properties to get started with viewing the Elasticsearch data is:

<jndiEntry jndiName="analytics/http.enabled" value="true"/>

This JNDI property allows you to view your Analytics raw data in JSON format and to access your Elasticsearch instance through the port that is defined by Elasticsearch. The default port is 9500.

Note: This setting is not secure and should not be enabled on a production environment.

Elasticsearch REST API

Being able to access an Elasticsearch instance provides the ability to run custom queries, and view more detailed information about the Elasticsearch cluster.

Search and view data
You can view all your data by visiting the tenant’s _search REST endpoint.

http://localhost:9500/*/_search

View cluster health

http://localhost:9500/_cluster/health

View information on current nodes

http://localhost:9500/_nodes

View the current mappings

http://localhost:9500/*/_mapping

Elasticsearch exposes many more REST endpoints. To learn more, visit the Elasticsearch documentation.

Inclusive terminology note: The Mobile First Platform team is making changes to support the IBM® initiative to replace racially biased and other discriminatory language in our code and content with more inclusive language. While IBM values the use of inclusive language, terms that are outside of IBM's direct influence are sometimes required for the sake of maintaining user understanding. As other industry leaders join IBM in embracing the use of inclusive language, IBM will continue to update the documentation to reflect those changes.
Last modified on August 08, 2018