Manage Collections in The Managed Search UI

Add a collection

Note
This topic describes how to create a collection in Managed Search using the UI. For instructions using the API, see Create a Collection.

To begin, navigate to the cluster details page:

  1. In the Cluster Manager screen, hover your cursor over the name of the cluster.

  2. Click the Details button that appears: Details

Add a collection to the cluster:

  1. In the Collections section, click the New: New Collection Button

    A menu appears:

    New Collection Menu

    Field Description Example value

    Collection Name

    Unique name for the collection.

    example-collection

    Refresh Interval

    A time interval for refreshing the collection.

    20000

    Number of Shards

    Number of shards in the collection.

    1

    Number of NRT Replicas per Shard

    Number of NearRealTime (NRT) replicas per shard. An NRT replica writes new documents to its indexes locally. Any replica of this type is eligible to become a leader.

    1

    Pull Replicas per Shard

    Number of pull replicas per shard. A pull replica does not index document changes locally. It only replicates the index from the shard leader. It is not eligible to become a shard leader.

    1

    TLog Replicas per Shard

    Number of TLog replicas per shard. A TLog replica does not index document changes locally. This type helps speed up indexing, since no commits need to occur in the replicas. This type of replica is also eligible to become a shard leader.

    1

  2. Fill out the form and select options for your collection.

    Tip
    Click Show Advanced Options for additional options.
  3. Click Create Collection.

Your collection appears on the Cluster Details screen. When its Status is listed as Operational, the collection is ready.

Edit a collection

Note
This topic describes how to edit a collection in Managed Search using the UI. For instructions using the API, see the topics on modifying attributes of a collection using PUT and PATCH.
  1. Hover your cursor over the name of the collection you want to edit.

  2. Click the Edit button that appears: Edit

  3. Make changes in the menu that appears.

  4. Click Update Collection to save your changes: Update Collection

View metrics for a collection

  1. Hover your cursor over the name of the collection you want to view the metrics for.

  2. Click the Metrics button that appears: Edit

  3. View the metrics for the collection:

    Collection Metrics

  4. To specify a timeframe for the metrics, use the date picker tool:

    Collection Metrics Date Picker

Delete a collection

Note
This topic describes how to delete a collection in Managed Search using the UI. For instructions using the API, see Delete a Collection.
Warning
Deleting a collection is hard to undo and eventually results in data loss. Backups are deleted on a rolling basis.
  1. Hover your cursor over the name of the collection you want to delete.

  2. Click the Delete button that appears: Edit

    A confirmation menu appears:

    Delete Collection Confirmation

  3. Type the name of the collection in the empty field, as listed in the instructions.

  4. Click the I understand, delete the collection button to permanently delete your collection: Confirm Collection Delete Button

  5. A dialog box appears where you can choose which associated objects to delete or retain. Only objects not associated with other objects are displayed. Deleting all objects is the default.

    Click Confirm to complete the process:

    Delete Collection Dialog

Your collection is deleted.