Finished segment upgrade – How to solve this OpenSearch error

Opster Team

Aug-23, Version: 1-2.9

Before you dig into reading this guide, have you tried asking OpsGPT what this log means? You’ll receive a customized analysis of your log.

Try OpsGPT now for step-by-step guidance and tailored insights into your OpenSearch operation.

Briefly, this error occurs when OpenSearch has completed the process of upgrading an index segment. It’s not necessarily an error, but more of an informational message indicating that a segment upgrade operation has been successfully completed. If you’re seeing performance issues, it could be due to the resource-intensive nature of segment upgrades. To resolve this, you can schedule segment upgrades during off-peak hours, ensure your system has adequate resources, or consider optimizing your indices to reduce the number of segments and thus the impact of segment upgrades.

For a complete solution to your to your search operation, try for free AutoOps for Elasticsearch & OpenSearch . With AutoOps and Opster’s proactive support, you don’t have to worry about your search operation – we take charge of it. Get improved performance & stability with less hardware.

This guide will help you check for common problems that cause the log ” finished segment upgrade ” to appear. To understand the issues related to this log, read the explanation below about the following OpenSearch concepts: index, upgrade.

 
 

index

Quick links

Overview

In OpenSearch, an index (plural: indices) contains a schema and can have one or more shards and replicas. An OpenSearch index is divided into shards and each shard is an instance of a Lucene index.

Indices are used to store the documents in dedicated data structures corresponding to the data type of fields. For example, text fields are stored inside an inverted index whereas numeric and geo fields are stored inside BKD trees.

Examples

Create index

The following example is based on OpenSearch version 5.x onwards. An index with two shards, each having one replica will be created with the name test_index1

PUT /test_index1?pretty
{
    "settings" : {
        "number_of_shards" : 2,
        "number_of_replicas" : 1
    },
    "mappings" : {
        "properties" : {
            "tags" : { "type" : "keyword" },
            "updated_at" : { "type" : "date" }
        }
    }
}

List indices

All the index names and their basic information can be retrieved using the following command:

GET _cat/indices?v

Index a document

Let’s add a document in the index with the command below:

PUT test_index1/_doc/1
{
  "tags": [
    "opster",
    "OpenSearch"
  ],
  "date": "01-01-2020"
}

Query an index

GET test_index1/_search
{
  "query": {
    "match_all": {}
  }
}

Query multiple indices

It is possible to search multiple indices with a single request. If it is a raw HTTP request, index names should be sent in comma-separated format, as shown in the example below, and in the case of a query via a programming language client such as python or Java, index names are to be sent in a list format.

GET test_index1,test_index2/_search

Delete indices

DELETE test_index1

Common problems

  • It is good practice to define the settings and mapping of an Index wherever possible because if this is not done, OpenSearch tries to automatically guess the data type of fields at the time of indexing. This automatic process may have disadvantages, such as mapping conflicts, duplicate data and incorrect data types being set in the index. If the fields are not known in advance, it’s better to use dynamic index templates.
  • OpenSearch supports wildcard patterns in Index names, which sometimes aids with querying multiple indices, but can also be very destructive too. For example, It is possible to delete all the indices in a single command using the following commands:
DELETE /*

To disable this, you can add the following lines in the OpenSearch.yml:

action.destructive_requires_name: true
 
 

upgrade

Quick links

Overview

Upgrade refers to migrating your OpenSearch version to a newer version. The process of updating distributed systems like OpenSearch can be intricate, given the extensive data quantities, the involvement of numerous nodes, and the diverse configurations that may exist within your cluster.

An upgrade of an existing cluster can be done in two ways: through a rolling upgrade and through a full cluster restart. The benefit of a rolling upgrade is having zero downtime.

Bear in mind that any changes to your system could lead to data loss if the instructions are not adhered to accurately. Thoroughly test and strategize your upgrade, and ensure you create a backup of your data prior to executing any updates.

For Elasticsearch to OpenSearch migration, check out these guides:

What should I check before upgrading versions?

OpenSearch nodes cannot be downgraded after upgrading. Before starting the upgrade process you should: 

  • Check the deprecation log and resolve any issues.
  • Review the breaking changes to make sure you know of any functionalities which may changes or disappear. This would mainly affect node configuration, index mappings and templates, and cluster settings.
  • Check the ES plugin compatibility to ensure they are compatible with the new version.
  • Set up a test environment to test the upgrade process in a testing or staging environment first before upgrading your production cluster to avoid any issues.
  • Take a backup and snapshots from your data, as the only way to “reverse” a failed upgrade is to create a new cluster with the old version and restore the data from snapshots.

How to perform offline upgrades – full cluster restart upgrades

A complete cluster restart upgrade involves simultaneously stopping all OpenSearch nodes, updating them, and subsequently restarting each one. Inevitably, this upgrade approach will necessitate the downtime of your OpenSearch cluster throughout the entire process.

Generally, offline upgrades are simpler than online ones because there’s no need to handle a cluster with varying node versions concurrently.

The steps are:

  1. Disable shard allocation 
  2. Stop all OpenSearch nodes and upgrade them 
  3. Upgrade any plugins
  4. Start the OpenSearch cluster
  5. Re-enable shard allocation 
  6. Upgrade client libraries to new version
  7. Restart master eligible nodes
  8. Restart non-master eligible nodes

Keep in mind that during a full cluster restart, the master nodes need to be initiated prior to the non-master nodes. This is essential for allowing the master nodes to establish the cluster so that other nodes can join, which is in contrast to a rolling upstart where non-master nodes should be upgraded before the master nodes.

How to perform online upgrades – rolling restart upgrades

A rolling restart upgrade allows for updating a cluster without incurring any downtime. In this scenario, every node is sequentially upgraded and rebooted, without ever halting the entire OpenSearch cluster.

Rolling restart upgrades cannot be performed when there is a change in MAJOR versions. For this reason, when performing a rolling restart upgrade between major versions, it is imperative to ALWAYS utilize the most recent minor version as an intermediary step for upgrading to the subsequent major version.

How to upgrade nodes in a rolling upgrade

The process for upgrading your nodes is as follows, upgrading all NON master-eligible nodes first.

  1. Make sure your cluster status is green and stable

    Ensure that all replicas are available so that shutting down the node will not cause data loss.

  2. Disable unnecessary indexing

    Wherever possible, you should stop all indexing processes to increase the cluster’s stability.

  3. Disable shard allocation

    It is important to disable shard allocation so that when you stop a node for upgrade the cluster does not reallocate shards to another node. (See command below).

  4. Stop OpenSearch

    Stop OpenSearch before moving on to the next step.

  5. Upgrade OpenSearch

    The method used to upgrade will depend upon your installation method.

  6. Upgrade plugins

    OpenSearch will not start if the plugin is not the same version as OpenSearch.

  7. Start OpenSearch

    Start OpenSearch before moving on to the next step.

  8. Re-enable shard allocation

    Using the command given below.

  9. Check that the upgraded node has rejoined the cluster

    Using the command below, you can check how many nodes are in the cluster.

  10. Wait for cluster status to turn green

    The command provided below will also show you the progress of the shard recovery process on the upgraded node, until the cluster reaches a green state.

  11. Repeat

    Repeat the full process above for each node.

To disable shard allocation, run:

PUT _cluster/settings
{
  "persistent": {
    "cluster.routing.allocation.enable": "primaries"
  }
}

To re-enable shard allocation, run:

PUT _cluster/settings
{
  "persistent": {
    "cluster.routing.allocation.enable": null
  }
}

Get cluster status and see how many nodes are in the cluster using:

GET _cluster/health

Common problems and important points

  • The major problem with upgrades is version incompatibility. OpenSearch supports rolling upgrades only between minor versions. You need to make sure to go through the official documentation to see if your cluster can support a rolling upgrade, otherwise a complete reindexing is required.
  • Once you upgrade an OpenSearch node, a rollback cannot be done. You need to make sure to backup your data before an upgrade.
  • OpenSearch continuously removes or deprecates some of its features with every release, so keep an eye on the change logs of each version before planning an upgrade. 
  • While doing a rolling upgrade, it is important to disable shard allocation before stopping a node and enable the shard allocation when node is upgraded and restarted. This process helps in avoiding unnecessary IO load in the cluster.

Easily upgrade versions with OMC

To upgrade OpenSearch versions without risking data loss, you can use the free Opster Management Console. The OMC enables version upgrades with no downtime and upgrading from significantly older versions to new ones at the click of a button, completely for free.

 
 

Log Context

Log “finished segment upgrade” classname is InternalEngine.java.
We extracted the following from OpenSearch source code for those seeking an in-depth context :

                }
                if (flush) {
                    flush(false; true);
                }
                if (upgrade) {
                    logger.info("finished segment upgrade");
                }
            } finally {
                store.decRef();
            }
        } catch (AlreadyClosedException ex) {

 

How helpful was this guide?

We are sorry that this post was not useful for you!

Let us improve this post!

Tell us how we can improve this post?

Get expert answers on Elasticsearch/OpenSearch

Try OpsGPT Now

Related Articles

Back to all articles