One of the joys with my day job at WebDevStudios is the chance to work with and support Algolia Search. I’ve even posted about it a few times in the past here on the site. You can check those with the “algolia” tag.
Not only did I get to work with it for clients, but I also get to be a primary developer of the WP Search with Algolia plugin, and the Pro extension that is bringing in some extra functionality so that you don’t need to do some of the coding. Both plugins keep me on the front lines of working with Algolia and helping site owners power their own site’s search experiences.
However, there have been times where I’ve found it a little difficult to accurately troubleshoot things, or wished that I had a quick way to check on the current status of content inside any given Algolia index and it’s configuration. This got me thinking, and I remembered how I created my own plugin that extended the Query Monitor plugin for the GiveWP donation platform.
Thus, with #5FTF time, I came up with Query Monitor Algolia. You can download it at the link below.
https://github.com/tw2113/query-monitor-algolia
However, before you go do that, let’s go over what it gathers and shows you all in a couple places.
Constants
You will be able to see the value of these available constants:
- ALGOLIA_HIDE_HELP_NOTICES
- ALGOLIA_SPLIT_POSTS
- ALGOLIA_CONTENT_MAX_SIZE
- ALGOLIA_INDEX_NAME_PREFIX
Index settings
You will also be able to see the currently configured settings for:
- Settings for each index associated with the site, or for the current site, if you have a multisite.
Statuses
Lastly you will see a panel that provides all the information below.
- Used template path
- Currently viewed content post type
- Currently viewed content’s index-able status. Can it be indexed?
- Currently viewed content’s indexed status. Is it indexed already?
- Searchable post index enabled
- All of your Index-able post types
- Current indices, including last updated time.
- If the API is reachable
- Autocomplete configuration(s)
- Search style. Is it backend, is it Instantsearch?
- The prefix set for your indices.
- Is “Powered by” enabled.
In terms of client work, I haven’t had a chance to really give it a try, but in terms of just testing things out locally, it seems to be working pretty well.
I know we have another #5FTF coming up on the 29th, so hopefully I can start focusing on getting some integrations added around WP Search with Algolia Pro.