Elasticsearch plugin

Monitor any metrics from your Elasticsearch environment using custom QueryDSL, Lucene queries and API calls.

For more information about what this plugin does and the data streams it retrieves, see:

Elasticsearch

To add a data source click on the + next to Data Sources on the left-hand menu in SquaredUp. Search for the data source and click on it to open the Configure data source page.

You can also add a data source by clicking Add data source on the Settings > Data Sources page, but pre-built dashboards are not added when using this method.

Before you start

The Elasticsearch plugin is a "hybrid" plugin, meaning it is available in SquaredUp as both a cloud and an on-prem plugin.

  • Use the cloud plugin if your Elasticsearch instance is available on the internet. You do not need to configure a relay agent.
  • Use the on-prem plugin to access a Elasticsearch instance on a server on-prem. You will need to configure a relay agent before you configure the Elasticsearch on-prem plugin.

Configuring and deploying an agent

For an on-prem plugin you will need a relay agent that can access the server hosting your on-prem data source. You do not need a relay agent for cloud plugins.

If you have already created a relay agent in SquaredUp that can access this data source, then you can skip this step and choose the agent group you want to use while Configuring the data source.

You can install an agent on either Windows or Linux:

Configuring the data source

  1. Display name:
    Enter a name for your data source. This helps you to identify this data source in the list of your data sources.

  2. Agent group:
    Select the Agent Group that contains the agent(s) you want to use.

  3. Instance URL:
    Enter the URL for your Elasticsearch environment.
    Where to find the Instance URL:

    The URL depends on your Elasticsearch environment:

    1. If you are using the Elastic cloud service, you need to enter the endpoint URL, which has the following format:
      https://CLUSTER_ID.REGION.CLOUD_PLATFORM.DOMAIN:PORT
    2. If you are running Elasticsearch in a different environment, ask your Elastic administrator for the instance URL and port number.
  4. Enter the username and password for your Elasticsearch environment.

  5. Ignore certificate errors:
    If you activate this checkbox the data source will ignore certificate errors when accessing the server. This is useful if you have self-signed certificates.

  6. Optional: Restrict access to this data source:
    You can enable this option if you only want certain users or groups to have access to the data source, or the permission to link it to new workspaces. See data source access control for more information.

  7. Click Add.

Next steps

Data streams

You can use these data streams to create new tiles to show data, or if there are preconfigured dashboards installed you can copy or edit those.

The following data streams are installed with this plugin.

Data stream
Description
Indices
Retrieve a list of your Elasticsearch indexes.

Configurable data streams

The following data streams have configurable Parameters.

Data stream
Description
Parameters
Query DSL
Use a query Domain Specific Language based on JSON to define queries
  1. Query Body:Optionally, enter a JSON query. For example: 
    {
    "query": {
        "query_string": {
            "query": "managedEntityDisplayName:\"Microsoft Windows Server 2016 Datacenter\""
        }
    }
}
  2. Query Parameters:
    Optionally, specify a set of JSON parameters for your Query Body. for example: 
    {
    "q": "managedEntityDisplayName:\"Microsoft Windows Server 2016 Datacenter\""
}
Lucene Query
Use a Lucene query to fetch data.
  1. Lucene Query:
    Enter a Lucene Query, for example: 
    managedEntityDisplayName:"Microsoft Windows Server 2016 Datacenter"
Custom API Call
Build a custom API call to fetch data.
  1. HTTP Method
    Select the method to use for the API call.

    The next three fields, Elasticsearch API Endpoint, JSON Headers and JSON Parameters, are all optional, but you must enter details for at least one.

  2. Elasticsearch API Endpoint:
    Specify an Elasticsearch API Endpoint to send the call to, for example:
    {{name}}/_search
  3. JSON Headers:
    Optionally, enter a set of JSON Headers for the API call.
  4. JSON Parameters:
    Optionally, enter a set of JSON Parameters for the API call.

Was this article helpful?

Have more questions or facing an issue?
Submit a ticket