Elasticsearch service [elasticsearch-service]

Elasticsearch service provides elasticsearch.client program API to communicate with Elasticsearch server HTTP API.

::::{note} The Elasticsearch service is only available server side. You can use the Data plugin. ::::

elasticsearch.client interacts with Elasticsearch service on behalf of:

• kibana_system user via elasticsearch.client.asInternalUser.* methods.
• a current end-user via elasticsearch.client.asCurrentUser.* methods. In this case Elasticsearch client should be given the current user credentials. See Scoped services and Security.

import { CoreStart, Plugin } from '@kbn/core/public';

export class MyPlugin implements Plugin {
  public start(core: CoreStart) {
    async function asyncTask() {
      const result = await core.elasticsearch.client.asInternalUser.ping(…);
    }
    asyncTask();
  }
}

For advanced use-cases, such as a search for specific objects, use the Global search plugin.

Logging

The Elasticsearch service logs all requests and responses at the debug log level.

By default, it logs them using the logger elasticsearch.query.data, where data is the default client (other custom clients created via core.elasticsearch.create(type, options) are logged as elasticsearch.query.<type>).

However, if you want to group some queries for easier troubleshooting, you can indicate a different logger name for each request by passing the loggingOptions context parameter to the second parameter of each request method.

client.search(searchParams, {
  context: {
    loggingOptions: {
      loggerName: 'myqueries', // <1>
    },
  },
});

1. This request will be logged using the logger elasticsearch.query.myqueries.

Using custom loggers for specific requests or groups of requests can make them easier to troubleshoot.

To see the logs, enable the debug log level for the logger you want to troubleshoot. For example, to see the logs for the elasticsearch.query.myqueries logger, add the following to your kibana.yml:

logging.loggers:
  - name: elasticsearch.query.myqueries
    level: debug