Skip to content

Implement Monitoring and Maintenance Processes for Tracery's Supported Search Engines #26

@KadeMorton

Description

@KadeMorton

Is your feature request related to a problem? Please describe.
Tracery relies on multiple search engines to return relevant results, but search engines frequently change their APIs, availability, and response formats.

Describe the solution you'd like
To ensure reliable performance and prevent disruptions, we need to establish ongoing monitoring and maintenance processes for the search engines that Tracery supports.

Describe alternatives you've considered
N/A

Additional context
Inventory Current Supported Search Engines:

  • Document all search engines currently enabled in Tracery.
  • Identify their API endpoints, rate limits, and known limitations.
  1. Implement Automated Health Checks:

    • Develop a system to regularly test search engine functionality by sending test queries.
    • Log failures, timeouts, or significant changes in response structures.
    • Trigger alerts when an engine fails multiple consecutive checks.
  2. Develop a Search Engine Maintenance Workflow:

    • Define a process for reviewing and updating search engine configurations.
    • Establish a schedule for periodic reviews (e.g., monthly checks).
    • Document procedures for adding, removing, or adjusting search engines.
  3. Error Handling Improvements:

    • Ensure Tracery gracefully handles engine failures, falling back to alternatives where possible.
    • Improve logging and error messages for failed searches to aid troubleshooting.
  4. Monitoring and Reporting Dashboard:

    • Create a dashboard displaying search engine status, response times, and failure rates.
    • Allow admins to see which engines are currently active, failing, or underperforming.
  5. Regular Updates and Maintenance:

    • Establish a maintenance schedule to review logs, update configurations, and remove deprecated search engines.
    • Assign responsibilities for reviewing search engine performance and taking corrective actions.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions