Skip to content

Backgrounds

How-to Guides

Technical References

VIP Search /

Identify VIP Search configuration issues

⚠️ VIP Search is in limited beta

This documentation is subject to change. Features described here may not be available, may not be fully functional, or may change without notice, prior to general availability.

If you are experiencing issues with setting up VIP Search, more information for debugging can be found by looking at:

Debug Bar / Query Monitor

  • Perform a search
  • Open Debug Bar or Query Monitor
  • An ElasticPress panel will be present if VIP Search is active
  • If the current page has invoked Elasticsearch (ES) queries, they will be displayed in the ElasticPress panel

New Relic

  • Open New Relic to the External Services tab
  • Under “Servers” at the left, look for an entry such as “es-ha-bur.vipv2.net” for example. The string “bur” is an abbreviation for a data center, and other values such as “dfw“, “dca“, “ams“, etc. may appear instead.
  • The graph here is a representation of the frequency of use of the search endpoint for the containers actively monitored by New Relic. The actual stats can be derived by multiplying by the total number of containers and dividing by the containers monitored in New Relic. For example, if 2 of a total 12 containers are reporting 10k/hour, this is 10,000 / 2  x 12.
  • You can also see which request endpoints are most frequently using ES.
  • Transaction summaries will have the ES host listed in the breakdown.
  • Traces that include ES requests will show the remote request nested under ElasticPress\Elasticsearch::remote_request which may itself be nested under WP_Query::get_posts.
  • Review New Relic’s error logs for search-related warnings and notices from the plugin that need to be addressed.
  • Throughout the VIP Search code, you’ll find _doing_it_wrong() calls are used to throw configuration warnings. If you see these warnings in logs, they should provide the information needed to resolve the issue. If the cause is still not clear, look for the strings in the source code for context, or open a support ticket.

Last updated: April 09, 2021