Elasticsearch integration configuration fields

  • Rversion finale: Australia
  • Mis à jour 12 mars 2026
  • 7 minutes de lecture

    • Description of the fields on the Elasticsearch integration configuration forms for Health Log Analytics.

    For the Elasticsearch integration setup procedure, see Set up an Elasticsearch integration for Health Log Analytics.

    Tableau 1. Provide details
    Field Description
    Integration Name Unique name of this integration. For example: My Elasticsearch integration. This field is required.
    Remarque :
    When you fill in this field, the generic name displayed on the form adjusts automatically to match the name you entered.
    Execute on Option to determine whether to use a specific MID Server or a specific MID Server cluster.
    MID server name

    (Only when Execute on is set to Specific MID Server)

    The MID Server to which log data from Elasticsearch indices is pulled. This field is required.
    MID Server Cluster

    (Only when Execute on is set to Specific MID Server Cluster)

    The MID Server cluster to which the log data is pulled. This field is required.

    When you select a cluster, the MID Servers in the selected cluster and their status are displayed.

    The integration runs on a single MID Server in the cluster until that MID Server fails. The system then moves all the integration tasks to the next available MID Server in the cluster according to the configured order.

    Remarque :
    • Health Log Analytics supports only failover MID Server clusters. In these clusters, multiple MID Servers are grouped together for failover protection. When selecting a cluster from the integration form, the MID Server Clusters list displays only failover clusters.
    • The MID Server cluster must include only MID Servers that support basic authentication. mTLS is not supported for log ingestion.
    • Log ingestion must be enabled for each MID Server in the cluster. If log ingestion is not enabled for the active MID Server, Health Log Analytics enables it automatically.
    • If Elasticsearch uses client certificate or CA certificate authentication, all MID Servers in the cluster must have the appropriate certificates.
    • The default maximum number of integrations streaming logs to a single MID Server is 10. A cluster passes capacity validation if it contains at least one MID Server with fewer than 10 integrations running on it, even when that MID Server is down.
    Service instance The service instance to which to bind the log data. This field is required.
    Remarque :
    If no relevant service instance exists, Create an service instance and add CIs to it. Set the status of the new service instance to Operational.
    Data source The source of the log data that the integration pulls to your ServiceNow instance: Elastic. This field is read-only.
    Description Option to add a brief description of the integration to help identify it.
    Tableau 2. Data retrieval method
    Field Description
    Server URL The URL used to access the cluster. This field is required.
    Authentication method The authentication method used to authenticate the integration to Elasticsearch. Default is none.
    When you select the authentication method, the corresponding credentials fields display on the form.
    Remarque :
    As an admin, you can create an authentication method by navigating to All > Health Log Analytics > Authentication Methods and selecting New.
    Index prefix Prefix prepended to the names of the Elasticsearch indices from which you want to read data. The integration only reads data from indices that match the configured prefix. For example: network-logs-* matches indices such as network-logs-2024.01.01. This field is required.

    This setting ensures that HLA only ingests data from the relevant indices.

    For example: only-read-these-indices-*
    Document timestamp field Timestamp field in documents stored in the read indices. This field is required.
    Timestamp field format Format of the timestamp field in the documents.

    If no format is specified, the default Unix epoch time format is used, in milliseconds. For example: 1684168407 (May 15, 2023 4:33:27 PM)
    Term filters JSON map of the terms to filter.
    Remarque :
    Avoid using the term query for text fields. If the target field is mapped as both text and keyword, reference the keyword by using fieldname.keyword.

    For example: {"severity": ["error", "warning"]}
    Tableau 3. Advanced settings
    Field Description
    Max connections per route The maximum number of connections to be opened per node.
    Max scroll slices The number of shards configured for the relevant index in Elasticsearch.

    This number tells Elastic how many parallel queries to execute in each polling request.
    Proxy host Host name of the HTTP proxy through which requests are sent.
    Proxy port Port of the HTTP proxy through which requests are sent.
    Use MID certificate policy check Option to enable the MID certificate policy check.

    Select this option if you want to ship your logs encrypted using SSL TLS. Then navigate to All > MID Server > MID Security Policy and add the MID certificate policy check to the table. For more information, see MID Server certificate check policies.
    Use cross-cluster search Option to search for data across Elasticsearch clusters.

    When this check box is selected, the Clusters to search field displays.

    Remarque :
    Your settings in the Use minimal privileges check box and the Delay in reading current timestamp (seconds) field on the Advanced configuration form affect how data is collected across multiple clusters.
    Clusters to search The Elasticsearch clusters to search.This field displays only when the Use cross-cluster search check box is selected.
    Do one of the following:
    • Leave this field empty or enter “*” to search all the remote clusters defined in Elasticsearch.
    • Specify the clusters to search in a comma-separated list.
      Remarque :
      To also search the local cluster, add a comma at the beginning or end, or add two commas in succession to the list. For example: “east,,west” or “,east,west” or “*,”
    Use minimal privileges Option to read log data directly from the Elasticsearch indices with the configured prefix.
    • When selected, the integration reads the log data directly from the Elasticsearch indices with the configured prefix. To perform this task, it needs only read privileges.
      Remarque :
      When this check box is selected and you're using cross-cluster search, data is collected from all the clusters simultaneously.
    • When clear, the integration fetches all indices with the prefix, filters them, and reads the log data from the filtered indices. Performing this task requires additional privileges.
      Remarque :
      Leaving this check box clear when using cross-cluster search affects how data is collected from the clusters. For more information, see the Enabling and Using Cross-Cluster Search for Elasticsearch Data Inputs in Health Log Analytics [KB1556079] article in the Now Support Knowledge Base.

    For additional information about streaming logs using the Elasticsearch integration, see the Stream logs using Elasticsearch data input - Advanced guide [KB1080162] article in the Now Support Knowledge Base.
    Max documents per query Maximum number of documents fetched in a single query.
    Sliced-scrolling tie breaker Value used to slice the data. Each slice is scrolled in parallel. Default: _id
    Search-after tie breaker Unique value per document to use as tiebreaker when sorting log entries by timestamp.
    Use search-after API Option to toggle between using sliced-scrolling and search-after APIs.
    Remarque :
    Sliced-scrolling APIs are preferable when reading historical data, while search-after APIs are better for reading real-time data.
    Index time-suffix format Format of the time suffix when using time-based index names, such as [logstash-]YYYY.MM.DD.

    When using aliases, leave this field empty.

    For example: uuuu.MM.dd
    Data reading timeout (milliseconds) The duration of time, in milliseconds, before a request to the Elasticsearch cluster times out.
    Index discovery interval (seconds) The number of seconds between intermittent MID Server requests to the Elasticsearch cluster for new indices from which to read data.
    Scroll context time (milliseconds) The lifetime of the created scroll when using the scroll API to read data from Elasticsearch. For more information, see the Elasticsearch scroll API documentation.
    Event processor workers The maximum number of CPU cores used in parallel to process events fetched from Elasticsearch. A higher setting increases the data input throughput at the cost of higher CPU usage.
    Worker queue size The maximum number of batches to queue for processing. A higher setting increases throughput, at the cost of higher RAM usage.
    Default timezone The time zone of events that the system will use if a log does not specify the time zone.

    By default, the system uses GMT in such cases, but you can specify a different time zone.
    Sub sample drop ratio The number of events to batch together, out of which one will be discarded. This setting is used to reduce the number of fetched events.
    Sub sample receive ratio The number of events to batch together, out of which all but one will be discarded. This setting is used to decrease the number of received events.
    Character encoding The character encoding for this data input.
    Sleep interval (seconds) The interval, in seconds, to wait before querying again after a query has returned no data.
    Max length in bytes The maximum length, in bytes, of log messages.
    Delay in reading current timestamp (seconds) The number of seconds before current time to query to include delayed data.The configured number of seconds is subtracted from the current time for reading the last timestamp.
    Remarque :
    If this value is 0 and data is collected from multiple clusters simultaneously, the query may not include data that was sent with a delay on one of the clusters,
    Polling interval How frequently the system polls for new log data.