[SEARCH-2233] Expose additional parameters for FIX tool in REST API Created: 04-May-20  Updated: 03-Sep-20  Resolved: 16-Jun-20

Status: Done
Project: Search and Discovery
Component/s: None
Affects Version/s: None
Fix Version/s: Search Services 2.0

Type: Story
Reporter: Alex Mukha Assignee: Unassigned
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: 0 minutes
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
is related to by SEARCH-2404 Reimplement SEARCH-2248 and SEARCH-22... Done
Epic Link: FIX Tool Enhancements
Sprint: Team Ninja-King - S&I 31, Team Ninja-King - S&I 32, Team Ninja-King - S&I 33, Team Ninja-King - S&I 34
Release Train: Southall
Delivery Team: Search
Story Points: 13


The current implementation of FIX tool does the following:

  • generates the index health report for metadata and ACL trackers
  • provides the list of transactions and ACL change sets to trackers to reindex based on the report. The actual processing happens during tracking periods. Consecutive calls to fix tool with the same parameters does not result in more work as the list of transactions to reindex will be the same.
  • returns the list of transactions and ACLs to be reindexed as a response

Acceptance criteria:

  • Extend the REST API to provide new parameters (the parameters already exist in MetadataTracker#checkIndex and AclTracker#checkIndex, but not used in AlfrescoCoreAdminHandler#fixOnSpecificCore):
    • From txn commit time
    • To txn commit time
  • Add a "dry run" parameter to REST API. If dry run is triggered the report needs to be generated, but the reindex wok should not be scheduled. Dry run should be the default behaviour if none is specified. The response should contain the parameter used during call and instruction on how to run the repair.
  • Extend the report to contain the following information:
    • The parameters used to generate the report
    • Time elapsed to generate the report
    • Add number of nodes and ACLs in each txn. Use AlfrescoCoreAdminHandler#actionTXREPORT and AlfrescoCoreAdminHandler#actionACLTXREPORT
  • Make sure there are debug logs that indicate different stages of the tool's work
  • Write Documentation and raise a DOCS ticket about:
    • Changes to REST API and how to use it
    • Explanation about the fact that the processing is handled by trackers during normal indexing period.
    • Explanation/links to trackers configuration

Generated at Tue May 18 06:50:23 BST 2021 using Jira 7.13.15#713015-sha1:7c5ddd2c3e1709974ae9c48c17df8edd3919fe2c.