# Diagnostics


# Description

You can reach the diagnostics page in 1search by going to the instance landing page.

This page will help you troubleshoot and find issues with your configuration of 1search and problems it may be causing such as slower response times and not returning correct results. There are four main sections to the diagnostics page:

If your configurations are not set up and you don't have any inserted data in the dataset, clicking any of the options here will produce empty results and empty arrays. See Getting Started to learn how to quickly set up a simple search instance.

Once some items are inserted into the dataset and the configurations are set up, these will display what you have setup for your 1search instance.

  • Count:
    • Count will simply show the total number of items you have in your dataset, if there are no items, it will return 0
  • Search Results
    • Search Results will perform a sr request which will return and display all items you have inserted into the dataset and the data corresponding with them
  • iNav

The search section of the diagnostics page can be used to check the most used request types and make sure they are producing the right results. You can also use it to check that items you have recently uploaded have appeared within your dataset.

# Configuration

The configuration section of the diagnostics page provides you with a visual representation of all your configuration files. Upon viewing the page initially it looks like there is only visual representation for the navigations and indexes configurations, however, the Instance configuration link displays the set up for keyword, POI, Display Names, SEO, and SEO metadata.

  • Instance Configuration:
    • Instance configuration displays general data about your 1search instance, including slowest search times, region code, S3 bucket storage for configurations and data, but also a JSON representation of how all your other configuration files are set up excluding indexes and navigations, which allows you to see if your change within the Client Portal has reflected within the actual instance.
  • Data Configuration:
    • This is the section where the set up of your Indexes configuration file is displayed, it will show all set up aspects, ranges, geolocations, and more so that you can view how the XML code you have written within the indexes configuration will be reflected within your dataset and requests.
  • Navigations Configuration:
    • This section will display a simple layout of the iNav that your instance will generate when running an iNav request. Whatever you have set up in your navigations configuration will be visually represented here.

# Status

Lets you view the current status of the system, for example, the processes 1search is running and things such as how many bytes are allocated to each section. This can help you debug your instance if something has gone wrong, and can also explain why something might have gone wrong.

# Miscellaneous

Shows other details that may be useful including slowest searches which is useful for finding out exactly where your system is falling short with its searches.


Below is a list of common issues:

  1. If 1search encounters a lot of unprocessable entities such as incredibly large queries, you may get very high CPU usage meaning that other people will not be able to process their requests until the system is scaled up which is an issue with fair use.