Skip to main content

We've Moved!

Product Documentation has moved to docs.hitachivantara.com
Hitachi Vantara Knowledge

Overview tab

The Overview tab gives general information about an index collection, including statistics, shards, and configuration settings.

You can also use the Overview tab to edit some setting for external index collections. For information, see Configuring external indexes.

Viewing index collections and statistics

To view your index collections and statistics:

Procedure

  1. Click the Index Collections window.

    The Index Collections shows this information for each index collection:

    • Its name.
    • The name and version of the indexing plugin that it uses.
    • Its type:
      • Internal: The index is stored within one or more Hitachi Content Intelligence instances and maintained by Hitachi Content Intelligence.
      • External: The index is either an HDDS or Apache Solr index stored outside of Hitachi Content Intelligence.
  2. To view more information about an Apache Solr or Hitachi Content Intelligence index, select an index collection.

    On the page for the individual index:

    The Statistics tab shows information about the underlying search index that the index collection represents.

HCI Index statistics

  • Deleted Segments: The number of index segments replaced due to removal or reindexing of a document.
  • Deletions Exist: Whether documents have been deleted from the index.
  • Document Count: The number of documents indexed, including redundant copies.
  • Heap Usage (bytes): Java heap usage for the index.
  • Index Generation: Used by the Solr search engine for managing how the index is replicated.
  • Index Size: The amount of disk space occupied by the index, in bytes.
  • Index Protection Level: For all shards in the index, the number of redundant copies of each shard. For more information, see Index protection level for HCI Indexes.
  • Shard Count: Number of subsets into which the index is divided.
  • Type: The search engine used to build and maintain the index (for example, Solr).

Apache Solr statistics

  • Deleted Segments: The number of index segments replaced due to removal or reindexing of a document.
  • Deletions Exist: Whether documents have been deleted from the index.
  • Document Count: The number of documents indexed, including redundant copies.
  • Heap Usage (bytes): Java heap usage for the index.
  • Index Protection Level: For all shards in the index, the number of redundant copies of each shard.
  • Index Size: The amount of disk space occupied by the index, in bytes.
  • Shard Count: Number of subsets into which the index is divided.
  • Solr Collection: Name of the external Solr index managed by this index collection.
  • Type: The search engine used to build and maintain the index (for example, Solr).

Elasticsearch statistics

  • Deleted Segments: The number of index segments replaced due to removal or reindexing of a document.
  • Deletions Exist: Whether documents have been deleted from the index.
  • Document Count: The number of documents indexed, including redundant copies.
  • Elastic Index: Name of the external Elasticsearch index managed by this index collection.
  • Index Protection Level: For all shards in the index, the number of redundant copies of each shard.
  • Index Size: The amount of disk space occupied by the index, in bytes.
  • Shard Count: Number of subsets into which the index is divided.
  • Type: The search engine used to build and maintain the index (for example, Solr).

HDDS statistics

  • Type: The search engine used to build and maintain the index (for example, Solr).
  • The Shards tab shows this information for each index shard:
    • Name: The name of the shard.
    • Type:
      • Primary: The shard can process indexing requests from Hitachi Content Intelligence.
      • Replica: The shard replicates another shard.

      Index shards have replicas only when the protection level for the index is greater than 1. For information on the index protection level setting, see your system administrator Service list.

    • State:
      • Unknown: The shard is not available.
      • Active: The shard is functioning normally.
      • Recovering: The shard was lost and is currently being rebuilt.
      • Down: The shard is currently offline.
      • Recovery failed: The shard was lost and failed to be rebuilt.
      • Gone: The shard cannot be found.
    • URL: The location of the shard.

Index shards

An index shard is a unique subset of an index.

Splitting an index into multiple shards allows the index to grow to a very large size and still be able to service requests in reasonable amounts of time.

Index shards are distributed amongst the instances that run the Index service. Index requests, such as user queries, are sent concurrently to multiple index shards.

Specifying the shard count for an index

You specify the number of shards for an index when you create it. If you expect your index to get very large, specify a large shard count for it. Minimally, you should specify a shard count equal to the number of instances in the system.

ImportantAfter you create an index collection, you cannot reconfigure the number of shards it has.

For guidance on index sharding, see the applicable Apache Solr or Elasticsearch documentation.

Multiple shards on a single-instance system

Creating an index with multiple shards on a single-instance system might reduce the performance of the index. However, if you plan to add additional instances to the system, you have the ability to distribute the index shards across the new instances.

Balancing shards across instances

For best index performance, index shards should be balanced evenly across the instances in the system. For internally-managed HCI Indexes, youyour administrator can do this through the Hitachi Content Intelligence Admin App. For externally managed indexes, you do this on your external Solr or Elasticsearch indexes.

For internally-managed HCI Indexes, you can do this through Hitachi Content Intelligence. For externally managed indexes, you do this on your external Solr or Elasticsearch indexes.

To balance shards across instances:

Procedure

  1. Click the Services window.

  2. Click Manage Services.

  3. Click the Index service. Then click Next.

  4. Click the Configure window.

  5. Enable the Rebalance Shards setting for one or more indexes.

  6. Click Update Service.

 

  • Was this article helpful?